Create a Pix Schedule

Create a single-shot scheduled Pix instruction. The schedule is persisted with status SCHEDULED; the schedule worker dispatches the cashout at the scheduled fire time. The destination snapshot comes from the payment initiation that initiationId references. An endToEndId already held by a Pix or by another schedule returns 409 PIX-0423.

POST /v1/schedules

Create a Pix Schedule

cURL

curl --request POST \
  --url https://api.example.com/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "amount": "100.50",
  "initiationId": "550e8400-e29b-41d4-a716-446655440010",
  "scheduledFor": "2026-08-15T00:00:00Z",
  "description": "Recurring charge installment 03/12",
  "endToEndId": "E1234567820260815060012345678901",
  "maxAttempts": 2,
  "recurrenceId": "01988a7c-1234-7abc-8def-111122223333"
}
'

201

{
  "accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "amount": "100.50",
  "attemptCount": 0,
  "attempts": [
    {
      "attemptedAt": "2026-08-15T06:00:02Z",
      "failureMessage": "Midaz error: balance below required (06:00 BRT attempt)",
      "failureReason": "INSUFFICIENT_FUNDS",
      "endToEndId": "E1234567820260815060011111111111",
      "initiationId": "a1111111-1111-4111-8111-111111111111",
      "transferId": "f1a2b3c4-1111-4d5e-9f6a-7b8c9d0e1f23"
    }
  ],
  "createdAt": "2026-05-26T12:30:00Z",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "CACC"
    },
    "owner": {
      "document": "52998224725",
      "name": "John Doe",
      "tradeName": "John's Business"
    },
    "key": "[e-mail]"
  },
  "id": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "initiationId": "550e8400-e29b-41d4-a716-446655440010",
  "initiationType": "MANUAL",
  "maxAttempts": 2,
  "scheduledFor": "2026-08-15T09:00:00Z",
  "status": "SCHEDULED",
  "updatedAt": "2026-05-26T12:30:00Z",
  "cancelledAt": "2026-05-19T09:15:33Z",
  "description": "Recurring charge installment 03/12",
  "endToEndId": "E1234567820260815060012345678901",
  "executedAt": "2026-08-15T06:00:04Z",
  "failedAt": "2026-08-15T06:00:04Z",
  "failureMessage": "<string>",
  "failureReason": "INSUFFICIENT_FUNDS",
  "firedAt": "2026-08-15T06:00:04Z",
  "recurrenceId": "01988a7c-1234-7abc-8def-111122223333",
  "transferId": "c8d27e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id · string<uuid> · requerido

Account ID owning the schedule (UUID format)

X-Idempotency · string

Idempotency anchor (UUID v4 recommended); replays return the cached 201.

Maximum string length: 255

Cuerpo

application/json

amount · string · requerido

Minimum string length: 1

Ejemplo:

"100.50"

initiationId · string · requerido

Minimum string length: 1

Ejemplo:

"550e8400-e29b-41d4-a716-446655440010"

scheduledFor · string<date-time> · requerido

Minimum string length: 1

Ejemplo:

"2026-08-15T00:00:00Z"

description · string

Maximum string length: 140

Ejemplo:

"Recurring charge installment 03/12"

endToEndId · string

Ejemplo:

"E1234567820260815060012345678901"

maxAttempts · integer<int64>

Rango requerido: x <= 2

Ejemplo:

2

recurrenceId · string

Ejemplo:

"01988a7c-1234-7abc-8def-111122223333"

Respuesta

201

application/json

Created

accountId · string · requerido

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

amount · string · requerido

Ejemplo:

"100.50"

attemptCount · integer<int64> · requerido

Ejemplo:

0

attempts · object[] · requerido

Show child attributes

createdAt · string<date-time> · requerido

Ejemplo:

"2026-05-26T12:30:00Z"

destination · object · requerido

Show child attributes

id · string · requerido

Ejemplo:

"01989f9e-6508-79f8-9540-835be49fbd0d"

initiationId · string · requerido

Ejemplo:

"550e8400-e29b-41d4-a716-446655440010"

initiationType · enum<string> · requerido

Opciones disponibles: MANUAL, KEY, QR_CODE

Ejemplo:

"MANUAL"

maxAttempts · integer<int64> · requerido

Ejemplo:

2

scheduledFor · string<date-time> · requerido

Ejemplo:

"2026-08-15T09:00:00Z"

status · enum<string> · requerido

Opciones disponibles: SCHEDULED, PROCESSING, EXECUTED, FAILED, CANCELLED

Ejemplo:

"SCHEDULED"

updatedAt · string<date-time> · requerido

Ejemplo:

"2026-05-26T12:30:00Z"

cancelledAt · string<date-time>

Ejemplo:

"2026-05-19T09:15:33Z"

description · string

Ejemplo:

"Recurring charge installment 03/12"

endToEndId · string

Ejemplo:

"E1234567820260815060012345678901"

executedAt · string<date-time>

Ejemplo:

"2026-08-15T06:00:04Z"

failedAt · string<date-time>

Ejemplo:

"2026-08-15T06:00:04Z"

failureMessage · string

failureReason · enum<string>

Opciones disponibles: INSUFFICIENT_FUNDS, BTG_REJECTED, MIDAZ_REJECTED, VALIDATION_FAILED, SCHEDULE_STALE_TIMEOUT, SCHEDULE_RETRIES_EXHAUSTED

Ejemplo:

"INSUFFICIENT_FUNDS"

firedAt · string<date-time>

Ejemplo:

"2026-08-15T06:00:04Z"

recurrenceId · string

Ejemplo:

"01988a7c-1234-7abc-8def-111122223333"

transferId · string

Ejemplo:

"c8d27e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f"