Sign in
latestOpenAPI 3.1.02026-07-2440101174.2 KB

e20afa10cd0e

Pix agendado

Consulta de agendamento por identificador

Utilize este endpoint para consultar um agendamento a partir do identificador.

get/pix/scheduling-payments/{requestIdentifier}

Path parameters

requestIdentifierstring required

Identificador do agendamento.

Parameters

#/paths/~1pix~1claims/get/parameters/0 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/2 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/3 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/1 — unresolved $ref

Response

Retorno da consulta com sucesso.

initiationForm'MANU' | 'DICT' | 'QRDN' | 'QRES' | 'AUTO' | 'INIC' | 'APES' | 'APDN'

Forma de iniciação.

interbankSettlementAmountnumber

Valor do agendamento interbancário.

liquidationCodeSubType'COMMON_SCHEDULING' | 'AUTOMATIC_PIX_SCHEDULING'

Subtipo de código de liquidação.

dateSchedulestring date

Data do agendamento.

requestIdentifierstring

Identificador da solicitação.

remittanceInformationstring

Informação da remessa.

endToEndIdentificationstring

Identificador de ponta a ponta.

transactionIdentificationstring

Identificador da transação.

insertDateTimestring date-time

Data e hora de inserção.

status'AWAITING_ENRICHMENT' | 'CANCELED' | 'SENT_PRE_VALIDATION' | 'PROCESSING' | 'RESCHEDULED' | 'SCHEDULED' | 'ATTEMPTS_EXCEEDED' | 'SUCCESSFULLY_COMPLETED' | 'UNSUCCESSFULLY_COMPLETED'

Status do agendamento.

purpose'AGND' | 'NTAG' | 'RIFL'

Propósito do agendamento.

paymentInitiatorstring

CNPJ do iniciador do pagamento. ^([A-Z0-9]{12}[0-9]{2})$