Skip to main content
GET
Consult a PIX Automatico authorization situation

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"

Parámetros de consulta

idReqJdPi
string

The JDPI request id (GUID) fallback when the idRecorrencia consult 404s.

Ejemplo:

""

Respuesta

OK

authorizationGiven
boolean
requerido

resultadoAutorizacao.

Ejemplo:

true

debtor
object
requerido

The recurrence devedor.

frequency
integer<int64>
requerido

tpFrequencia (0..4).

Ejemplo:

1

idRecorrencia
string
requerido

The recurrence id.

Ejemplo:

"RR0435879820240605njua7shf40o"

localStatus
string
requerido

Local AuthorizationStatus projected from the JDPI situation.

Ejemplo:

"Active"

localStatusKnown
boolean
requerido

False when the JDPI situation carries no projected local status.

Ejemplo:

true

payer
object
requerido

The recurrence pagador.

recipient
object
requerido

The recurrence recebedor.

stJdPi
integer<int64>
requerido

JDPI overall situation (-1/0/9/10).

Ejemplo:

9

stJdPiProc
integer<int64>
requerido

JDPI intermediate situation (0..10).

Ejemplo:

9

startDate
string
requerido

First payment date (aaaa-mm-dd).

Ejemplo:

"2024-01-10"

amount
integer<int64>

Fixed payment amount in centavos.

Ejemplo:

110001

authorizedAt
string

Authorization timestamp (UTC).

Ejemplo:

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

cancellations
object[] | null

Cancellation history (cancelamentos).

contractDesc
string

Free-text contract description.

Ejemplo:

"Conta de energia"

contractNumber
string

Contract/order identifier (nrContrato).

Ejemplo:

"1234567890ABC"

endDate
string

Last payment date (aaaa-mm-dd).

Ejemplo:

"2026-01-10"

floorMaxAmount
integer<int64>

Receiver floor in centavos.

Ejemplo:

55000

idReqJdPi
string

The JDPI request id (GUID).

Ejemplo:

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

idSolicitacao
string

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

Ejemplo:

"IS0435879820240605abcd1234567"

journey
integer<int64>

jornada (1..4).

Ejemplo:

2

payerMaxAmount
integer<int64>

Payer max cap in centavos.

Ejemplo:

200000

requestedAt
string

JDPI request timestamp (UTC).

Ejemplo:

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

retry
integer<int64>

retentativa (0/1).

Ejemplo:

1

situationAt
string

Situation timestamp (dtHrSituacao, UTC).

Ejemplo:

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

updatedAt
string

Last-update timestamp (UTC).

Ejemplo:

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