Consult a PIX Automatico schedule situation
Consults the live JDPI situation of a scheduled payment instruction (JDPI 4.4.2), projecting the JDPI situation axes onto the local schedule status.
Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
The payment-transaction id (32-char).
"E00038166202409171500y6j6mt9l0pi"
Query Parameters
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
The payment-transaction id (32-char).
"E00038166202409171500y6j6mt9l0pi"
Deprecated: read recurrenceId, which carries the same value. The recurrence id (RR...).
"RR0435879820240605njua7shf40o"
Local ScheduleStatus projected from the JDPI situation.
"Accepted"
False when the JDPI situation carries no projected local status.
true
The scheduled pagador.
finalidadeAgendamento (0=first attempt, 1=post-due retry, 2=resend after a settlement error). Always present, including 0.
0
The scheduled recebedor.
The recurrence id (RR...).
"RR0435879820240605njua7shf40o"
JDPI overall situation (-1/0/9/10/11).
9
JDPI intermediate situation (0/1/2/5/7/8/9/10/11).
9
Accept/reject timestamp (dtHrAceiteRejeite, UTC).
"2024-09-17T15:10:05Z"
Scheduled amount in centavos.
55000
Cancellation history (cancelamento).
The scheduled devedor; absent when the debtor is the payer.
Due date (aaaa-mm-dd).
"2024-09-24"
JDPI error code.
""
JDPI error description.
""
Free-text receiver-to-payer info.
""
Recipient PSP reception timestamp (UTC).
"2024-09-17T10:25:49Z"
The receiver conciliation id.
"JDPI2024091700000000000000000000001"
JDPI request timestamp (UTC).
"2024-09-17T10:10:05Z"
stAgendamento (0=Aceito, 1=Rejeitado). Absent when JDPI did not report it.
0
Situation timestamp (dtHrSituacao, UTC).
"2024-09-18T16:34:18Z"

