Pular para o conteúdo principal
POST
Create a Pix Schedule

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id
string<uuid>
obrigatório

Account ID owning the schedule (UUID format)

X-Idempotency
string

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

Maximum string length: 255

Corpo

application/json
amount
string
obrigatório
Minimum string length: 1
Exemplo:

"100.50"

initiationId
string
obrigatório
Minimum string length: 1
Exemplo:

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

scheduledFor
string<date-time>
obrigatório
Minimum string length: 1
Exemplo:

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

description
string
Maximum string length: 140
Exemplo:

"Recurring charge installment 03/12"

endToEndId
string
Exemplo:

"E1234567820260815060012345678901"

maxAttempts
integer<int64>
Intervalo obrigatório: x <= 2
Exemplo:

2

recurrenceId
string
Exemplo:

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

Resposta

Created

accountId
string
obrigatório
Exemplo:

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

amount
string
obrigatório
Exemplo:

"100.50"

attemptCount
integer<int64>
obrigatório
Exemplo:

0

attempts
object[]
obrigatório
createdAt
string<date-time>
obrigatório
Exemplo:

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

destination
object
obrigatório
id
string
obrigatório
Exemplo:

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

initiationId
string
obrigatório
Exemplo:

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

initiationType
enum<string>
obrigatório
Opções disponíveis:
MANUAL,
KEY,
QR_CODE
Exemplo:

"MANUAL"

maxAttempts
integer<int64>
obrigatório
Exemplo:

2

scheduledFor
string<date-time>
obrigatório
Exemplo:

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

status
enum<string>
obrigatório
Opções disponíveis:
SCHEDULED,
PROCESSING,
EXECUTED,
FAILED,
CANCELLED
Exemplo:

"SCHEDULED"

updatedAt
string<date-time>
obrigatório
Exemplo:

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

cancelledAt
string<date-time>
Exemplo:

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

description
string
Exemplo:

"Recurring charge installment 03/12"

endToEndId
string
Exemplo:

"E1234567820260815060012345678901"

executedAt
string<date-time>
Exemplo:

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

failedAt
string<date-time>
Exemplo:

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

failureMessage
string
failureReason
enum<string>
Opções disponíveis:
INSUFFICIENT_FUNDS,
BTG_REJECTED,
MIDAZ_REJECTED,
VALIDATION_FAILED,
SCHEDULE_STALE_TIMEOUT,
SCHEDULE_RETRIES_EXHAUSTED
Exemplo:

"INSUFFICIENT_FUNDS"

firedAt
string<date-time>
Exemplo:

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

recurrenceId
string
Exemplo:

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

transferId
string
Exemplo:

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