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"

Response

OK

cancelStatus
integer<int64>
required

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

Example:

0

idCancelamento
string
required

The cancellation id (IC...).

Example:

"IC0435879820240605abcd1234567"

idRecorrencia
string
required

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.

requesterDocument
string
required

Requester CPF/CNPJ (string).

Example:

"04623217035"

requesterType
integer<int64>
required

tpPessoaSol.

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"