Skip to main content
POST
Confirm a PIX Automatico authorization

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

idRecorrencia
string
requerido

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

Ejemplo:

"RR0435879820240605njua7shf40o"

Cuerpo

application/json
contractNumber
string
requerido

Contract/order identifier (nrContrato).

Ejemplo:

"1234567890ABC"

frequency
integer<int64>
requerido

tpFrequencia (0..4).

Ejemplo:

1

journey
integer<int64>
requerido

jornada (2..4).

Ejemplo:

2

payer
object
requerido

The recurrence pagador (incl. name, accountType, ibgeCode).

recipient
object
requerido

The recurrence recebedor.

startDate
string
requerido

First payment date (dtInicialRecorrencia; aaaa-mm-dd).

Ejemplo:

"2024-01-10"

amount
integer<int64>

Fixed payment amount in centavos (valor).

Ejemplo:

110001

authorizedAt
string

Authorization timestamp (dtHrAutorizacaoRecorrencia, UTC).

Ejemplo:

"2024-01-06T10:00:00Z"

contractDesc
string

Free-text contract description.

Ejemplo:

"Conta de energia"

createdDateTime
string

Recurrence creation timestamp (dtHrCriacaoRecorrencia, UTC).

Ejemplo:

"2024-01-05T10:00:00Z"

debtor
object

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

endDate
string

Last payment date (dtFinalRecorrencia).

Ejemplo:

"2026-01-10"

floorMaxAmount
integer<int64>

Receiver floor in centavos (pisoValorMaximo).

Ejemplo:

55000

payerMaxAmount
integer<int64>

Payer max cap in centavos (vlrMaxPagador).

Ejemplo:

200000

settlementConfirmedAt
string

Settlement confirmation timestamp (dtHrConfirmacaoLiquidacao, UTC; required for jornada=3).

Ejemplo:

"2024-01-06T10:05:00Z"

Respuesta

Accepted

idRecorrencia
string
requerido

The recurrence id.

Ejemplo:

"RR0435879820240605njua7shf40o"

requestedAt
string
requerido

JDPI request timestamp (dtHrReqJdPi, UTC).

Ejemplo:

"2024-01-06T10:00:01Z"

idReqJdPi
string

The JDPI request id (36-char GUID; omitted by 4.3.10).

Ejemplo:

"52c43361-caa1-4ddb-9152-708426a25db3"

status
string

The resulting local authorization status.

Ejemplo:

"Accepted"