Consult a PIX Automatico authorization situation
Consults the live JDPI situation of a recurring-payment authorization (JDPI 4.3.4), projecting the JDPI situation axes onto the local authorization status.
Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
The recurrence id (29-char, RR...).
"RR0435879820240605njua7shf40o"
Query Parameters
The JDPI request id (GUID) fallback when the idRecorrencia consult 404s.
""
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.
^[0-9]{8}$"12345678"
Response
OK
resultadoAutorizacao.
true
tpFrequencia (0..4).
1
Deprecated: read recurrenceId, which carries the same value. The recurrence id.
"RR0435879820240605njua7shf40o"
Local AuthorizationStatus projected from the JDPI situation.
"Active"
False when the JDPI situation carries no projected local status.
true
The recurrence pagador.
The recurrence recebedor.
The recurrence id.
"RR0435879820240605njua7shf40o"
retentativa (0=no retries, 1=up to 3 retries). Always present, including 0.
1
JDPI overall situation (-1/0/9/10).
9
JDPI intermediate situation (0..10).
9
First payment date (aaaa-mm-dd).
"2024-01-10"
Fixed payment amount in centavos.
110001
Authorization timestamp (UTC).
"2024-01-06T10:00:00Z"
Cancellation history (cancelamentos).
Free-text contract description.
"Conta de energia"
Contract/order identifier (nrContrato).
"1234567890ABC"
The recurrence devedor; absent when the debtor is the payer.
Last payment date (aaaa-mm-dd).
"2026-01-10"
Receiver floor in centavos.
55000
The JDPI request id (GUID).
"52c43361-caa1-4ddb-9152-708426a25db3"
Deprecated: read requestId, which carries the same value. The solicitation id (29-char, IS...).
"IS0435879820240605abcd1234567"
jornada (1..4).
2
Payer max cap in centavos.
200000
The solicitation id (29-char, IS...).
"IS0435879820240605abcd1234567"
JDPI request timestamp (UTC).
"2024-01-05T10:00:01Z"
Situation timestamp (dtHrSituacao, UTC).
"2024-01-06T10:00:00Z"
Last-update timestamp (UTC).
"2024-01-06T10:00:00Z"

