Skip to main content
GET
Consult a PIX Automatico authorization cancellation

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

idRecorrencia
string
required

The recurrence id (29-char, RR...).

Example:

"RR0435879820240605njua7shf40o"

idCancelamento
string
required

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

Example:

"IC0435879820240605abcd1234567"

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

cancellationId
string
required

The cancellation id (IC...).

Example:

"IC0435879820240605abcd1234567"

idCancelamento
string
required
deprecated

Deprecated: read cancellationId, which carries the same value. The cancellation id (IC...).

Example:

"IC0435879820240605abcd1234567"

idRecorrencia
string
required
deprecated

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

Example:

"RR0435879820240605njua7shf40o"

payer
object
required

The recurrence pagador.

reason
integer<int64>
required

motivoCancelamento (0..10).

Example:

0

recipient
object
required

The recurrence recebedor.

recurrenceId
string
required

The recurrence id.

Example:

"RR0435879820240605njua7shf40o"

requesterDocument
string
required

Requester CPF/CNPJ (string).

Example:

"04623217035"

requesterType
integer<int64>
required

tpPessoaSol.

Example:

0

cancelStatus
integer<int64>

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

Example:

0

cancelledAt
string

Cancellation timestamp (UTC).

Example:

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

errorCode
string

JDPI error code.

Example:

""

errorDesc
string

JDPI error description.

Example:

""

situationAt
string

Situation timestamp (UTC).

Example:

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