Skip to main content
GET
Consult a PIX Automatico authorization cancellation

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

idRecorrencia
string
requerido

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

Ejemplo:

"RR0435879820240605njua7shf40o"

idCancelamento
string
requerido

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

Ejemplo:

"IC0435879820240605abcd1234567"

Respuesta

OK

cancelStatus
integer<int64>
requerido

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

Ejemplo:

0

idCancelamento
string
requerido

The cancellation id (IC...).

Ejemplo:

"IC0435879820240605abcd1234567"

idRecorrencia
string
requerido

The recurrence id.

Ejemplo:

"RR0435879820240605njua7shf40o"

payer
object
requerido

The recurrence pagador.

reason
integer<int64>
requerido

motivoCancelamento (0..10).

Ejemplo:

0

recipient
object
requerido

The recurrence recebedor.

requesterDocument
string
requerido

Requester CPF/CNPJ (string).

Ejemplo:

"04623217035"

requesterType
integer<int64>
requerido

tpPessoaSol.

Ejemplo:

0

cancelledAt
string

Cancellation timestamp (UTC).

Ejemplo:

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

errorCode
string

JDPI error code.

Ejemplo:

""

errorDesc
string

JDPI error description.

Ejemplo:

""

situationAt
string

Situation timestamp (UTC).

Ejemplo:

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