Obter um agendamento Pix
Recupera um agendamento pelo seu identificador único. Consultas entre contas retornam 404 — a existência nunca é revelada entre contas diferentes.
Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Cabeçalhos
Identificador único da Conta do Ledger Midaz (formato UUID).
Parâmetros de caminho
ID do agendamento (UUID v7)
Resposta
OK
AccountID ecoa o AccountID de entrada para correlação de auditoria/log.
"019cf6ef-e418-7ced-80c0-7b9816faa798"
Amount é o valor em BRL com 2 casas decimais.
"100.50"
AttemptCount é o número de tentativas de disparo feitas até agora.
0
Attempts é a lista cronológica de tentativas de disparo anteriores que falharam. A tentativa bem-sucedida não é incluída aqui; ela é registrada no próprio agendamento via TransferID e EndToEndID. Array vazio quando nenhuma falha foi registrada.
CancelledAt é o momento em que o agendamento chegou a CANCELLED. Ausente para registros que não estão em CANCELLED.
"2026-05-19T09:15:33Z"
CreatedAt é a data/hora de persistência (ISO 8601 UTC).
"2026-05-26T12:30:00Z"
Description é a mensagem legível opcional da transferência.
"Recurring charge installment 03/12"
Destination é o snapshot do destino capturado no agendamento.
EndToEndID é o identificador end-to-end do BACEN da transferência liquidada (resolvido via TransferID). Ausente para estados que não são EXECUTED.
"E1234567820260815060012345678901"
ExecutedAt é o momento em que o agendamento chegou a EXECUTED. Ausente para registros que não estão em EXECUTED.
"2026-08-15T06:00:04Z"
FailedAt é o momento em que o agendamento chegou ao estado terminal FAILED. Ausente para registros que não estão em FAILED. Simétrico a ExecutedAt / CancelledAt.
"2026-08-15T06:00:04Z"
FailureMessage é a descrição de falha legível em texto livre (com PII sanitizada). Ausente para registros que não estão em FAILED.
FailureReason categoriza uma falha terminal. Snapshot do FailureReason da entrada mais recente de Attempts[]. Ausente para registros que não estão em FAILED.
INSUFFICIENT_FUNDS, BTG_REJECTED, MIDAZ_REJECTED, VALIDATION_FAILED, SCHEDULE_STALE_TIMEOUT, SCHEDULE_RETRIES_EXHAUSTED "INSUFFICIENT_FUNDS"
FiredAt é o instante de despacho mais recente. Ausente até que o agendamento inicie o processamento (PROCESSING / EXECUTED / FAILED).
"2026-08-15T06:00:04Z"
ID é o identificador único do agendamento (UUID v7, gerado pela aplicação).
"01989f9e-6508-79f8-9540-835be49fbd0d"
InitiationID é a payment initiation referenciada no momento da criação (âncora de auditoria). Nunca é reutilizada no momento do disparo; cada tentativa de disparo usa sua própria initiation, exposta por tentativa como Attempts[].InitiationID.
"550e8400-e29b-41d4-a716-446655440010"
InitiationType registra como o destino foi capturado (MANUAL, KEY, QR_CODE).
MANUAL, KEY, QR_CODE "MANUAL"
MaxAttempts é o limite de retentativas por registro aceito no momento da criação.
2
RecurrenceID ecoa a âncora da recorrência pai quando o agendamento foi criado a partir de um fluxo recorrente. Vazio para chamadas diretas de POST /v1/schedules.
"01988a7c-1234-7abc-8def-111122223333"
ScheduledFor é o momento de disparo em horário de relógio (ISO 8601 UTC).
"2026-08-15T09:00:00Z"
Status é o status do ciclo de vida do agendamento. Sempre SCHEDULED na criação. Ciclo de vida: SCHEDULED -> PROCESSING -> EXECUTED | FAILED | CANCELLED.
SCHEDULED, PROCESSING, EXECUTED, FAILED, CANCELLED "SCHEDULED"
TransferID é o identificador da transferência liquidada. Preenchido apenas em EXECUTED.
"c8d27e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f"
UpdatedAt é a data/hora da última transição de status (ISO 8601 UTC).
"2026-05-26T12:30:00Z"

