Skip to main content
POST
Validate an inbound PIX Automatico authorization

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
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"

jornada
integer<int64>
obrigatório

Authorization journey (1..4).

Exemplo:

2

nrContrato
string
obrigatório

Contract/order identifier (35-char).

Exemplo:

"1234567890ABC"

pagador
object
obrigatório

The recurrence pagador.

recebedor
object
obrigatório

The recurrence recebedor.

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"

dtHrAutorizacaoRecorrencia
string

Authorization timestamp (UTC).

Exemplo:

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

idSolicitacaoRecorrencia
string

Confirmation-solicitation id (29-char, IS...).

Exemplo:

"IS0435879820240605abcd1234567"

motivoRejeicao
string

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

Exemplo:

"AP03"

resultadoAutorizacao
boolean

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

Exemplo:

true

valor
number<double>

Fixed payment amount in reais (a JSON number).

Exemplo:

550

Resposta

OK

dtHrValidacao
string
obrigatório

Validation timestamp (UTC).

Exemplo:

"2024-09-20T14:12:05.025Z"

motivoRejeicao
string

Rejection reason code (required when resultado=0).

Exemplo:

"AP03"

resultado
integer<int64>

Validation result (0=Invalido, 1=Valido); omitted on the 202 async ack.

Exemplo:

1