Skip to main content
POST
Receber evento de status 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).

Cabeçalhos

Authorization
string

Token de acesso Bearer (o portão de entrada financeira; o handler falha de forma fechada com Pix-0082 quando ausente).

X-DataHoraEvento
string
obrigatório

Instante de registro do evento (UTC: aaaa-mm-ddTHH:mm:ss.sssZ). Obrigatório conforme

X-NomeEvento
string
obrigatório

Nome do evento. Obrigatório conforme; passthrough informativo.

Corpo

application/json
dtHrSituacao
string
obrigatório

Data/hora da consulta de situação (UTC).

endToEndId
string
obrigatório

Id único de instrução de pagamento (32 caracteres).

stJdPi
integer<int64>
obrigatório

Situação geral da requisição (-1/0/9/10/11).

stJdPiProc
integer<int64>
obrigatório

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

codigoErro
string

Código de erro do upstream (em uma rejeição ou erro interno).

descCodigoErro
string

Descrição de erro do upstream.

dtHrAceiteRejeite
string

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

dtHrReqJdPi
string

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

dtVencimento
string

Data de vencimento da cobrança recorrente (aaaa-mm-dd).

idConciliacaoRecebedor
string

Id de conciliação do recebedor (35 caracteres).

idRecorrencia
string

Id único de recorrência (29 caracteres, RR...).

recebedor
object
stAgendamento
integer<int64>

Status do agendamento (0=Aceito, 1=Rejeitado).

valor
number<double>

Valor de pagamento recorrente em reais (um número JSON).

Resposta

Sem Conteúdo