Skip to main content
GET
Consult a PIX Automatico schedule situation

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

endToEndId
string
obrigatório

The payment-transaction id (32-char).

Exemplo:

"E00038166202409171500y6j6mt9l0pi"

Resposta

OK

debtor
object
obrigatório

The scheduled devedor.

endToEndId
string
obrigatório

The payment-transaction id (32-char).

Exemplo:

"E00038166202409171500y6j6mt9l0pi"

idRecorrencia
string
obrigatório

The recurrence id (RR...).

Exemplo:

"RR0435879820240605njua7shf40o"

localStatus
string
obrigatório

Local ScheduleStatus projected from the JDPI situation.

Exemplo:

"Accepted"

localStatusKnown
boolean
obrigatório

False when the JDPI situation carries no projected local status.

Exemplo:

true

payer
object
obrigatório

The scheduled pagador.

recipient
object
obrigatório

The scheduled recebedor.

scheduleStatus
integer<int64>
obrigatório

stAgendamento (0=Aceito, 1=Rejeitado; -1 when absent).

Exemplo:

0

stJdPi
integer<int64>
obrigatório

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

Exemplo:

9

stJdPiProc
integer<int64>
obrigatório

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

Exemplo:

9

acceptRejectAt
string

Accept/reject timestamp (dtHrAceiteRejeite, UTC).

Exemplo:

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

amount
integer<int64>

Scheduled amount in centavos.

Exemplo:

55000

cancellations
object[] | null

Cancellation history (cancelamento).

dueDate
string

Due date (aaaa-mm-dd).

Exemplo:

"2024-09-24"

errorCode
string

JDPI error code.

Exemplo:

""

errorDesc
string

JDPI error description.

Exemplo:

""

infoBetweenClients
string

Free-text receiver-to-payer info.

Exemplo:

""

purpose
integer<int64>

finalidadeAgendamento.

Exemplo:

0

recipientReceivedAt
string

Recipient PSP reception timestamp (UTC).

Exemplo:

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

reconciliationId
string

The receiver conciliation id.

Exemplo:

"JDPI2024091700000000000000000000001"

requestedAt
string

JDPI request timestamp (UTC).

Exemplo:

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

situationAt
string

Situation timestamp (dtHrSituacao, UTC).

Exemplo:

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