Skip to main content
GET
Consult a PIX Automatico schedule cancellation

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"

idCancelamento
string
required

The cancellation id (29-char, CA...).

Example:

"CA0435879820240605abcd1234567"

Response

OK

cancelStatus
integer<int64>
required

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

Example:

0

endToEndId
string
required

The payment-transaction id.

Example:

"E00038166202409171500y6j6mt9l0pi"

idCancelamento
string
required

The cancellation id (CA...).

Example:

"CA0435879820240605abcd1234567"

localStatus
string
required

Local ScheduleStatus projected from the JDPI situation.

Example:

"Cancelled"

localStatusKnown
boolean
required

False when the JDPI situation carries no projected local status.

Example:

true

reason
integer<int64>
required

motivoCancelamento (0..6).

Example:

0

recipientIspb
string
required

ispbDestinatario (string).

Example:

"00038166"

requester
integer<int64>
required

solCancelamento (0=PSP pagador, 1=PSP recebedor).

Example:

1

requesterDocument
string
required

Requester CPF/CNPJ (string).

Example:

"04623217035"

requesterIspb
string
required

ispbSolicitante (string).

Example:

"04358798"

requesterType
integer<int64>
required

tpPessoaSol.

Example:

0

stJdPi
integer<int64>
required

JDPI overall situation.

Example:

9

stJdPiProc
integer<int64>
required

JDPI intermediate situation.

Example:

9

cancelledAt
string

Cancellation timestamp (UTC).

Example:

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

errorCode
string

JDPI error code.

Example:

""

errorDesc
string

JDPI error description.

Example:

""

reconciliationId
string

The receiver conciliation id.

Example:

"JDPI2024091700000000000000000000001"

requestedAt
string

JDPI request timestamp (UTC).

Example:

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

situationAt
string

Situation timestamp (UTC).

Example:

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