Saltar al contenido principal
GET
Consult a PIX Automatico schedule cancellation

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

endToEndId
string
requerido

The payment-transaction id (32-char).

Ejemplo:

"E00038166202409171500y6j6mt9l0pi"

idCancelamento
string
requerido

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

Ejemplo:

"CA0435879820240605abcd1234567"

Parámetros de consulta

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. While exactly ONE participant of this deployment holds this recurrence, the recorded row names the direct participant whose books it lives in, and that is authoritative: naming that one changes nothing, naming another is refused. 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-9A-Z]{8}$
Ejemplo:

"12345678"

Respuesta

OK

cancellationId
string
requerido

The cancellation id (CA...).

Ejemplo:

"CA0435879820240605abcd1234567"

endToEndId
string
requerido

The payment-transaction id.

Ejemplo:

"E00038166202409171500y6j6mt9l0pi"

localStatus
string
requerido

Local ScheduleStatus projected from the JDPI situation.

Ejemplo:

"Cancelled"

localStatusKnown
boolean
requerido

False when the JDPI situation carries no projected local status.

Ejemplo:

true

reason
integer<int64>
requerido

motivoCancelamento (0..6).

Ejemplo:

0

recipientIspb
string
requerido

ispbDestinatario (string).

Ejemplo:

"00038166"

requester
integer<int64>
requerido

solCancelamento (0=payer's PSP, 1=recipient's PSP).

Ejemplo:

1

requesterDocument
string
requerido

Requester CPF/CNPJ (string).

Ejemplo:

"04623217035"

requesterIspb
string
requerido

Requester participant ISPB (string).

Ejemplo:

"04358798"

requesterType
integer<int64>
requerido

tpPessoaSol.

Ejemplo:

0

stJdPi
integer<int64>
requerido

JDPI overall situation.

Ejemplo:

9

stJdPiProc
integer<int64>
requerido

JDPI intermediate situation.

Ejemplo:

9

cancelStatus
integer<int64>

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

Ejemplo:

0

cancelledAt
string

Cancellation timestamp (UTC).

Ejemplo:

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

errorCode
string

JDPI error code.

Ejemplo:

""

errorDesc
string

JDPI error description.

Ejemplo:

""

reconciliationId
string

The receiver conciliation id.

Ejemplo:

"JDPI2024091700000000000000000000001"

requestedAt
string

JDPI request timestamp (UTC).

Ejemplo:

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

situationAt
string

Situation timestamp (UTC).

Ejemplo:

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