Skip to main content
POST
Receive a PIX Automatico schedule registration event

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Authorization
string

Bearer access token (the financial-ingress gate; the handler fails closed with PIX-0082 when absent).

Exemplo:

"Bearer eyJ..."

X-DataHoraEvento
string
obrigatório

Event registration instant (UTC: aaaa-mm-ddTHH:mm:ss.sssZ). Mandatory per §6.1.

Exemplo:

"2024-06-05T10:10:05.025Z"

X-NomeEvento
string
obrigatório

Event name (see §6.3.1 catalog). Mandatory per §6.1; informational passthrough.

Exemplo:

"situacao-autorizacao-callback"

Corpo

application/json
dtVencimento
string
obrigatório

Recurring charge due date (aaaa-mm-dd).

Exemplo:

"2024-09-26"

endToEndId
string
obrigatório

Unique payment-instruction id (32-char).

Exemplo:

"E00038166202409201500y6j6mt9l0pi"

finalidadeAgendamento
integer<int64>
obrigatório

Schedule purpose (0=first, 1=post-due retry, 2=settlement resend).

Exemplo:

0

idConciliacaoRecebedor
string
obrigatório

Receiver conciliation id (35-char).

Exemplo:

"JDPI2024092000000000000000000000001"

idRecorrencia
string
obrigatório

Unique recurrence id (29-char, RR...).

Exemplo:

"RR0435879820240919njua7shf40o"

pagador
object
obrigatório

The instruction pagador.

recebedor
object
obrigatório

The instruction recebedor.

stAgendamento
integer<int64>
obrigatório

Schedule status (0=Aceito, 1=Rejeitado).

Exemplo:

0

codigoErro
string

JDPI error code (100-char; on a rejection).

Exemplo:

""

descCodigoErro
string

JDPI error description (1000-char).

Exemplo:

""

devedor
object

The devedor, sent only when it differs from the payer.

dtHrRecepcaoPspRecebedor
string

PSP-receiver reception timestamp (UTC; required when finalidadeAgendamento=0).

Exemplo:

"2024-09-20T09:25:49.025Z"

infEntreClientes
string

Free-text receiver-to-payer info (140-char).

Exemplo:

"Cobranca da Enel"

valor
number<double>

Recurring payment amount in reais (a JSON number).

Exemplo:

550

Resposta

No Content