Skip to main content
POST
Receive a Pix Automático recipient-side authorization registration event

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Headers

Authorization
string

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

X-DataHoraEvento
string
required

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

X-NomeEvento
string
required

Event name. Mandatory per; informational passthrough.

Body

application/json
dtHrAutorizacaoRecorrencia
string
required

Authorization timestamp (UTC).

dtHrCriacaoRecorrencia
string
required

Recurrence creation timestamp (UTC).

dtInicialRecorrencia
string
required

First payment date (aaaa-mm-dd).

idRecorrencia
string
required

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

idReqJdPi
string
required

Upstream request id (36-char GUID).

jornada
integer<int64>
required

Authorization journey (2..4).

nrContrato
string
required

Contract/order identifier (35-char).

pagador
object
required
recebedor
object
required
resultadoAutorizacao
boolean
required

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

retentativa
integer<int64>
required

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

tpFrequencia
integer<int64>
required

Recurrence periodicity (0..4).

descContrato
string

Free-text contract description (35-char).

devedor
object
dtFinalRecorrencia
string

Last payment date (aaaa-mm-dd).

motivoRejeicao
string

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

valor
number<double>

Fixed payment amount in reais (a JSON number).

Response

No Content