Skip to main content
POST
Receive a PIX Automatico recipient-side authorization 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
dtHrAutorizacaoRecorrencia
string
obrigatório

Authorization timestamp (UTC).

Exemplo:

"2024-09-20T14:11:27.453Z"

dtHrCriacaoRecorrencia
string
obrigatório

Recurrence creation timestamp (UTC).

Exemplo:

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

dtInicialRecorrencia
string
obrigatório

First payment date (aaaa-mm-dd).

Exemplo:

"2024-01-10"

idRecorrencia
string
obrigatório

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

Exemplo:

"RR0435879820240920njua7shf40o"

idReqJdPi
string
obrigatório

JDPI request id (36-char GUID).

Exemplo:

"45F763C6-7487-4363-9406-A1DE2A9636D3"

jornada
integer<int64>
obrigatório

Authorization journey (2..4).

Exemplo:

2

nrContrato
string
obrigatório

Contract/order identifier (35-char).

Exemplo:

"1234567890ABC"

pagador
object
obrigatório

The recurrence pagador. The spec marks pagador.codMunIbge Sim on 5.2.4, but it is accepted-not-consumed this wave (the domain has no municipality field).

recebedor
object
obrigatório

The recurrence recebedor.

resultadoAutorizacao
boolean
obrigatório

Payer analysis result (true=Aceita, false=Rejeitada).

Exemplo:

true

retentativa
integer<int64>
obrigatório

Retry policy (0=none, 1=up to 3 in 7 days).

Exemplo:

1

tpFrequencia
integer<int64>
obrigatório

Recurrence periodicity (0..4).

Exemplo:

4

descContrato
string

Free-text contract description (35-char).

Exemplo:

"Conta de energia"

devedor
object

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

dtFinalRecorrencia
string

Last payment date (aaaa-mm-dd).

Exemplo:

"2026-01-10"

motivoRejeicao
string

Rejection reason code (4-char; required when resultadoAutorizacao=false).

Exemplo:

"AP13"

valor
number<double>

Fixed payment amount in reais (a JSON number).

Exemplo:

550

Resposta

No Content