Skip to main content
GET
Consult a PIX Automatico authorization situation

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

idRecorrencia
string
obrigatório

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

Exemplo:

"RR0435879820240605njua7shf40o"

Parâmetros de consulta

idReqJdPi
string

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

Exemplo:

""

Resposta

OK

authorizationGiven
boolean
obrigatório

resultadoAutorizacao.

Exemplo:

true

debtor
object
obrigatório

The recurrence devedor.

frequency
integer<int64>
obrigatório

tpFrequencia (0..4).

Exemplo:

1

idRecorrencia
string
obrigatório

The recurrence id.

Exemplo:

"RR0435879820240605njua7shf40o"

localStatus
string
obrigatório

Local AuthorizationStatus projected from the JDPI situation.

Exemplo:

"Active"

localStatusKnown
boolean
obrigatório

False when the JDPI situation carries no projected local status.

Exemplo:

true

payer
object
obrigatório

The recurrence pagador.

recipient
object
obrigatório

The recurrence recebedor.

stJdPi
integer<int64>
obrigatório

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

Exemplo:

9

stJdPiProc
integer<int64>
obrigatório

JDPI intermediate situation (0..10).

Exemplo:

9

startDate
string
obrigatório

First payment date (aaaa-mm-dd).

Exemplo:

"2024-01-10"

amount
integer<int64>

Fixed payment amount in centavos.

Exemplo:

110001

authorizedAt
string

Authorization timestamp (UTC).

Exemplo:

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

cancellations
object[] | null

Cancellation history (cancelamentos).

contractDesc
string

Free-text contract description.

Exemplo:

"Conta de energia"

contractNumber
string

Contract/order identifier (nrContrato).

Exemplo:

"1234567890ABC"

endDate
string

Last payment date (aaaa-mm-dd).

Exemplo:

"2026-01-10"

floorMaxAmount
integer<int64>

Receiver floor in centavos.

Exemplo:

55000

idReqJdPi
string

The JDPI request id (GUID).

Exemplo:

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

idSolicitacao
string

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

Exemplo:

"IS0435879820240605abcd1234567"

journey
integer<int64>

jornada (1..4).

Exemplo:

2

payerMaxAmount
integer<int64>

Payer max cap in centavos.

Exemplo:

200000

requestedAt
string

JDPI request timestamp (UTC).

Exemplo:

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

retry
integer<int64>

retentativa (0/1).

Exemplo:

1

situationAt
string

Situation timestamp (dtHrSituacao, UTC).

Exemplo:

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

updatedAt
string

Last-update timestamp (UTC).

Exemplo:

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