Skip to main content
GET
Consultar situação de agendamento de Pix Automático

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de caminho

endToEndId
string
obrigatório

O id da transação de pagamento (32 caracteres).

Resposta

OK

debtor
object
obrigatório
endToEndId
string
obrigatório

O id da transação de pagamento (32 caracteres).

idRecorrencia
string
obrigatório

O id da recorrência (RR...).

localStatus
string
obrigatório

ScheduleStatus local projetado a partir da situação do upstream.

localStatusKnown
boolean
obrigatório

False quando a situação do upstream não carrega status local projetado.

payer
object
obrigatório
recipient
object
obrigatório
scheduleStatus
integer<int64>
obrigatório

stAgendamento (0=Aceito, 1=Rejeitado; -1 quando ausente).

stJdPi
integer<int64>
obrigatório

Situação geral do upstream (-1/0/9/10/11).

stJdPiProc
integer<int64>
obrigatório

Situação intermediária do upstream (0/1/2/5/7/8/9/10/11).

acceptRejectAt
string

Data/hora de aceite/rejeição (dtHrAceiteRejeite, UTC).

amount
number<double>

Valor agendado em reais.

cancellations
object[] | null

Histórico de cancelamento (cancelamento).

dueDate
string

Data de vencimento (aaaa-mm-dd).

errorCode
string

Código de erro do upstream.

errorDesc
string

Descrição de erro do upstream.

infoBetweenClients
string

Informação em texto livre do recebedor para o pagador.

purpose
integer<int64>

finalidadeAgendamento.

recipientReceivedAt
string

Data/hora de recepção do PSP recebedor (UTC).

reconciliationId
string

O id de conciliação do recebedor.

requestedAt
string

Data/hora da requisição upstream (UTC).

situationAt
string

Data/hora da situação (dtHrSituacao, UTC).