Skip to main content
GET
Consult a PIX Automatico authorization situation

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

idRecorrencia
string
required

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

Example:

"RR0435879820240605njua7shf40o"

Query Parameters

idReqJdPi
string

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

Example:

""

ispb
string

The ISPB of the direct participant this consult is made AS. It is ROUTING DATA you supply and guarantee - never a credential, never read from a header or a path, and it never widens what your token can reach. It is IGNORED while exactly ONE participant of this deployment holds this recurrence: the recorded row already names the direct participant whose books it lives in, and that is authoritative. It DECIDES when TWO do - this deployment can be both PSPs of one recurrence inside its own economic group, and then it holds one row per side, in two participants' books, with no way to choose between them. OPTIONAL in every other case: omit it and the row, or the tenant default when there is no row, answers. Omitting it with a row on each side is 422 PIX-0127, an ISPB this deployment does not act as is 422 PIX-0128, and one that holds none of the recorded rows is 400 PIX-0061. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$
Example:

"12345678"

Response

OK

authorizationGiven
boolean
required

resultadoAutorizacao.

Example:

true

frequency
integer<int64>
required

tpFrequencia (0..4).

Example:

1

idRecorrencia
string
required
deprecated

Deprecated: read recurrenceId, which carries the same value. The recurrence id.

Example:

"RR0435879820240605njua7shf40o"

localStatus
string
required

Local AuthorizationStatus projected from the JDPI situation.

Example:

"Active"

localStatusKnown
boolean
required

False when the JDPI situation carries no projected local status.

Example:

true

payer
object
required

The recurrence pagador.

recipient
object
required

The recurrence recebedor.

recurrenceId
string
required

The recurrence id.

Example:

"RR0435879820240605njua7shf40o"

retry
integer<int64>
required

retentativa (0=no retries, 1=up to 3 retries). Always present, including 0.

Example:

1

stJdPi
integer<int64>
required

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

Example:

9

stJdPiProc
integer<int64>
required

JDPI intermediate situation (0..10).

Example:

9

startDate
string
required

First payment date (aaaa-mm-dd).

Example:

"2024-01-10"

amount
integer<int64>

Fixed payment amount in centavos.

Example:

110001

authorizedAt
string

Authorization timestamp (UTC).

Example:

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

cancellations
object[] | null

Cancellation history (cancelamentos).

contractDesc
string

Free-text contract description.

Example:

"Conta de energia"

contractNumber
string

Contract/order identifier (nrContrato).

Example:

"1234567890ABC"

debtor
object

The recurrence devedor; absent when the debtor is the payer.

endDate
string

Last payment date (aaaa-mm-dd).

Example:

"2026-01-10"

floorMaxAmount
integer<int64>

Receiver floor in centavos.

Example:

55000

idReqJdPi
string

The JDPI request id (GUID).

Example:

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

idSolicitacao
string
deprecated

Deprecated: read requestId, which carries the same value. The solicitation id (29-char, IS...).

Example:

"IS0435879820240605abcd1234567"

journey
integer<int64>

jornada (1..4).

Example:

2

payerMaxAmount
integer<int64>

Payer max cap in centavos.

Example:

200000

requestId
string

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

Example:

"IS0435879820240605abcd1234567"

requestedAt
string

JDPI request timestamp (UTC).

Example:

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

situationAt
string

Situation timestamp (dtHrSituacao, UTC).

Example:

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

updatedAt
string

Last-update timestamp (UTC).

Example:

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