Skip to main content
GET
Consult a PIX Automatico schedule situation

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

endToEndId
string
required

The payment-transaction id (32-char).

Example:

"E00038166202409171500y6j6mt9l0pi"

Query Parameters

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

endToEndId
string
required

The payment-transaction id (32-char).

Example:

"E00038166202409171500y6j6mt9l0pi"

idRecorrencia
string
required
deprecated

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

Example:

"RR0435879820240605njua7shf40o"

localStatus
string
required

Local ScheduleStatus projected from the JDPI situation.

Example:

"Accepted"

localStatusKnown
boolean
required

False when the JDPI situation carries no projected local status.

Example:

true

payer
object
required

The scheduled pagador.

purpose
integer<int64>
required

finalidadeAgendamento (0=first attempt, 1=post-due retry, 2=resend after a settlement error). Always present, including 0.

Example:

0

recipient
object
required

The scheduled recebedor.

recurrenceId
string
required

The recurrence id (RR...).

Example:

"RR0435879820240605njua7shf40o"

stJdPi
integer<int64>
required

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

Example:

9

stJdPiProc
integer<int64>
required

JDPI intermediate situation (0/1/2/5/7/8/9/10/11).

Example:

9

acceptRejectAt
string

Accept/reject timestamp (dtHrAceiteRejeite, UTC).

Example:

"2024-09-17T15:10:05Z"

amount
integer<int64>

Scheduled amount in centavos.

Example:

55000

cancellations
object[] | null

Cancellation history (cancelamento).

debtor
object

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

dueDate
string

Due date (aaaa-mm-dd).

Example:

"2024-09-24"

errorCode
string

JDPI error code.

Example:

""

errorDesc
string

JDPI error description.

Example:

""

infoBetweenClients
string

Free-text receiver-to-payer info.

Example:

""

recipientReceivedAt
string

Recipient PSP reception timestamp (UTC).

Example:

"2024-09-17T10:25:49Z"

reconciliationId
string

The receiver conciliation id.

Example:

"JDPI2024091700000000000000000000001"

requestedAt
string

JDPI request timestamp (UTC).

Example:

"2024-09-17T10:10:05Z"

scheduleStatus
integer<int64>

stAgendamento (0=Aceito, 1=Rejeitado). Absent when JDPI did not report it.

Example:

0

situationAt
string

Situation timestamp (dtHrSituacao, UTC).

Example:

"2024-09-18T16:34:18Z"