Skip to main content
POST
Receive a PIX Automatico recipient-side authorization registration event

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization
string

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

Ejemplo:

"Bearer eyJ..."

X-DataHoraEvento
string
requerido

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

Ejemplo:

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

X-NomeEvento
string
requerido

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

Ejemplo:

"situacao-autorizacao-callback"

Cuerpo

application/json
dtHrAutorizacaoRecorrencia
string
requerido

Authorization timestamp (UTC).

Ejemplo:

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

dtHrCriacaoRecorrencia
string
requerido

Recurrence creation timestamp (UTC).

Ejemplo:

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

dtInicialRecorrencia
string
requerido

First payment date (aaaa-mm-dd).

Ejemplo:

"2024-01-10"

idRecorrencia
string
requerido

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

Ejemplo:

"RR0435879820240920njua7shf40o"

idReqJdPi
string
requerido

JDPI request id (36-char GUID).

Ejemplo:

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

jornada
integer<int64>
requerido

Authorization journey (2..4).

Ejemplo:

2

nrContrato
string
requerido

Contract/order identifier (35-char).

Ejemplo:

"1234567890ABC"

pagador
object
requerido

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
requerido

The recurrence recebedor.

resultadoAutorizacao
boolean
requerido

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

Ejemplo:

true

retentativa
integer<int64>
requerido

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

Ejemplo:

1

tpFrequencia
integer<int64>
requerido

Recurrence periodicity (0..4).

Ejemplo:

4

descContrato
string

Free-text contract description (35-char).

Ejemplo:

"Conta de energia"

devedor
object

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

dtFinalRecorrencia
string

Last payment date (aaaa-mm-dd).

Ejemplo:

"2026-01-10"

motivoRejeicao
string

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

Ejemplo:

"AP13"

valor
number<double>

Fixed payment amount in reais (a JSON number).

Ejemplo:

550

Respuesta

No Content