Skip to main content
POST
Cancel a PIX Automatico authorization

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"

Body

application/json
reason
integer<int64>
required

motivoCancelamento (0..10).

Example:

0

requesterDocument
string
required

Requester CPF/CNPJ (cpfCnpjSolCancelamento, string).

Example:

"04623217035"

requesterType
integer<int64>
required

tpPessoaSol (0=Pessoa Fisica, 1=Pessoa Juridica).

Example:

0

Response

OK

cancelledAt
string
required

Cancellation timestamp (dtHrCancelamento, UTC).

Example:

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

idCancelamento
string
required

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

Example:

"IC0435879820240605abcd1234567"

idRecorrencia
string
required

The recurrence id.

Example:

"RR0435879820240605njua7shf40o"

status
string
required

The resulting local authorization status.

Example:

"Cancelled"