> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Obter um agendamento Pix > Recupera um agendamento pelo seu identificador único. Consultas entre contas retornam 404 — a existência nunca é revelada entre contas diferentes. ## OpenAPI ````yaml pt/openapi/v3-current/indirect-pix.yaml GET /v1/schedules/{schedule_id} openapi: 3.0.3 info: title: Plugin BR Pix Indireto - API Completa description: | API completa para o sistema brasileiro de pagamentos instantâneos Pix, incluindo operações de dicionário de chaves Pix, geração/decodificação de QR Code, transações e limites de transações. version: 1.7.6 servers: - url: https://plugin-pix-indirect.api.lerian.net security: - bearerAuth: [] paths: /v1/schedules/{schedule_id}: get: tags: - Schedules API summary: Obter um agendamento Pix description: >- Recupera um agendamento pelo seu identificador único. Consultas entre contas retornam 404 — a existência nunca é revelada entre contas diferentes. parameters: - name: schedule_id in: path description: ID do agendamento (UUID v7) required: true schema: type: string example: 019cf6ef-e418-7ced-80c0-7b9816faa798 - $ref: '#/components/parameters/XAccountId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ScheduleOutput' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' security: - bearerAuth: [] components: parameters: XAccountId: name: X-Account-Id in: header description: Identificador único da Conta do Ledger Midaz (formato UUID). required: true example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string schemas: ScheduleOutput: properties: accountId: description: >- AccountID ecoa o AccountID de entrada para correlação de auditoria/log. example: 019cf6ef-e418-7ced-80c0-7b9816faa798 type: string amount: description: Amount é o valor em BRL com 2 casas decimais. example: '100.50' type: string attemptCount: description: AttemptCount é o número de tentativas de disparo feitas até agora. example: 0 type: integer attempts: description: >- 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. items: $ref: '#/components/schemas/ScheduleAttemptOutput' type: array cancelledAt: description: >- CancelledAt é o momento em que o agendamento chegou a CANCELLED. Ausente para registros que não estão em CANCELLED. example: '2026-05-19T09:15:33Z' format: date-time type: string createdAt: description: CreatedAt é a data/hora de persistência (ISO 8601 UTC). example: '2026-05-26T12:30:00Z' format: date-time type: string description: description: Description é a mensagem legível opcional da transferência. example: Recurring charge installment 03/12 type: string destination: allOf: - $ref: '#/components/schemas/ScheduleDestination' description: Destination é o snapshot do destino capturado no agendamento. endToEndId: description: >- EndToEndID é o identificador end-to-end do BACEN da transferência liquidada (resolvido via TransferID). Ausente para estados que não são EXECUTED. example: E1234567820260815060012345678901 type: string executedAt: description: >- ExecutedAt é o momento em que o agendamento chegou a EXECUTED. Ausente para registros que não estão em EXECUTED. example: '2026-08-15T06:00:04Z' format: date-time type: string failedAt: description: >- 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. example: '2026-08-15T06:00:04Z' format: date-time type: string failureMessage: description: >- FailureMessage é a descrição de falha legível em texto livre (com PII sanitizada). Ausente para registros que não estão em FAILED. type: string failureReason: description: >- FailureReason categoriza uma falha terminal. Snapshot do FailureReason da entrada mais recente de Attempts[]. Ausente para registros que não estão em FAILED. enum: - INSUFFICIENT_FUNDS - BTG_REJECTED - MIDAZ_REJECTED - VALIDATION_FAILED - SCHEDULE_STALE_TIMEOUT - SCHEDULE_RETRIES_EXHAUSTED example: INSUFFICIENT_FUNDS type: string firedAt: description: >- FiredAt é o instante de despacho mais recente. Ausente até que o agendamento inicie o processamento (PROCESSING / EXECUTED / FAILED). example: '2026-08-15T06:00:04Z' format: date-time type: string id: description: >- ID é o identificador único do agendamento (UUID v7, gerado pela aplicação). example: 01989f9e-6508-79f8-9540-835be49fbd0d type: string initiationId: description: >- 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. example: 550e8400-e29b-41d4-a716-446655440010 type: string initiationType: description: >- InitiationType registra como o destino foi capturado (MANUAL, KEY, QR_CODE). enum: - MANUAL - KEY - QR_CODE example: MANUAL type: string maxAttempts: description: >- MaxAttempts é o limite de retentativas por registro aceito no momento da criação. example: 2 type: integer recurrenceId: description: >- 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. example: 01988a7c-1234-7abc-8def-111122223333 type: string scheduledFor: description: >- ScheduledFor é o momento de disparo em horário de relógio (ISO 8601 UTC). example: '2026-08-15T09:00:00Z' format: date-time type: string status: description: >- Status é o status do ciclo de vida do agendamento. Sempre SCHEDULED na criação. Ciclo de vida: SCHEDULED -> PROCESSING -> EXECUTED | FAILED | CANCELLED. enum: - SCHEDULED - PROCESSING - EXECUTED - FAILED - CANCELLED example: SCHEDULED type: string transferId: description: >- TransferID é o identificador da transferência liquidada. Preenchido apenas em EXECUTED. example: c8d27e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f type: string updatedAt: description: >- UpdatedAt é a data/hora da última transição de status (ISO 8601 UTC). example: '2026-05-26T12:30:00Z' format: date-time type: string type: object ErrorFormat: type: object description: A mensagem de erro da resposta. required: - code - title - message properties: code: type: string description: Um identificador único e estável para o erro. title: type: string description: Um breve resumo do problema. message: type: string description: Orientação detalhada para resolver o erro. ScheduleAttemptOutput: properties: attemptedAt: description: AttemptedAt é o instante de despacho desta tentativa (ISO 8601 UTC). example: '2026-08-15T06:00:02Z' format: date-time type: string endToEndId: description: >- EndToEndID é o identificador end-to-end do BACEN da mensagem SPI da tentativa. Presente junto com TransferID. example: E1234567820260815060011111111111 type: string failureMessage: description: FailureMessage é o detalhe legível (com PII sanitizada). example: 'Midaz error: balance below required (06:00 BRT attempt)' type: string failureReason: description: FailureReason categoriza a falha. enum: - INSUFFICIENT_FUNDS - BTG_REJECTED - MIDAZ_REJECTED - VALIDATION_FAILED - SCHEDULE_STALE_TIMEOUT example: INSUFFICIENT_FUNDS type: string initiationId: description: >- InitiationID é a payment initiation usada para esta tentativa (criada no momento do disparo, não a initiation do momento da criação). Ausente quando a tentativa foi rejeitada antes de uma liquidação ser registrada. example: a1111111-1111-4111-8111-111111111111 type: string transferId: description: >- TransferID é o identificador da transferência produzida pelo disparo que falhou. Ausente quando o cashout foi rejeitado antes de uma liquidação ser registrada. example: f1a2b3c4-1111-4d5e-9f6a-7b8c9d0e1f23 type: string type: object ScheduleDestination: properties: account: allOf: - $ref: '#/components/schemas/ScheduleDestinationAccount' description: >- Account contém agência / número / ISPB do participante / tipo de conta. key: description: >- Key é a chave Pix associada ao destino no momento da initiation, quando o usuário pagou via KEY ou QR_CODE. Apenas snapshot — não usada no momento do disparo. example: john.doe@example.com type: string owner: allOf: - $ref: '#/components/schemas/ScheduleDestinationOwner' description: >- Owner contém o documento, o nome e o nome fantasia opcional do titular da conta de destino. type: object ScheduleDestinationAccount: properties: branch: description: >- Branch é o código da agência bancária (tipicamente 4 dígitos, com zeros à esquerda). example: '0001' type: string number: description: Number é o número da conta na instituição de destino. example: '123456789' type: string participant: description: Participant é o ISPB de 8 dígitos da instituição de destino. example: '12345678' type: string type: description: 'Type é o tipo de conta: CACC, SVGS, TRAN, OTHR.' enum: - CACC - SVGS - TRAN - OTHR example: CACC type: string type: object ScheduleDestinationOwner: properties: document: description: Document é o CPF (11 dígitos) ou CNPJ (14 dígitos) do titular. example: '12345678901' type: string name: description: Name é o nome completo ou razão social do titular de destino. example: John Doe type: string tradeName: description: TradeName é o nome fantasia opcional (apenas pessoas jurídicas). example: John's Business type: string type: object securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````