Skip to main content
GET
Consult a PIX Automatico authorization cancellation

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

idRecorrencia
string
obrigatório

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

Exemplo:

"RR0435879820240605njua7shf40o"

idCancelamento
string
obrigatório

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

Exemplo:

"IC0435879820240605abcd1234567"

Resposta

OK

cancelStatus
integer<int64>
obrigatório

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

Exemplo:

0

idCancelamento
string
obrigatório

The cancellation id (IC...).

Exemplo:

"IC0435879820240605abcd1234567"

idRecorrencia
string
obrigatório

The recurrence id.

Exemplo:

"RR0435879820240605njua7shf40o"

payer
object
obrigatório

The recurrence pagador.

reason
integer<int64>
obrigatório

motivoCancelamento (0..10).

Exemplo:

0

recipient
object
obrigatório

The recurrence recebedor.

requesterDocument
string
obrigatório

Requester CPF/CNPJ (string).

Exemplo:

"04623217035"

requesterType
integer<int64>
obrigatório

tpPessoaSol.

Exemplo:

0

cancelledAt
string

Cancellation timestamp (UTC).

Exemplo:

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

errorCode
string

JDPI error code.

Exemplo:

""

errorDesc
string

JDPI error description.

Exemplo:

""

situationAt
string

Situation timestamp (UTC).

Exemplo:

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