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"

Query Parameters

ispb
string

The ISPB of the direct participant this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the recurrence row this write addresses has to be booked in that participant's books, or the answer is 404 PIX-0147 and nothing is sent to JDPI or changed. An ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$
Example:

"12345678"

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

cancellationId
string
required

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

Example:

"IC0435879820240605abcd1234567"

cancelledAt
string
required

When the cancellation was requested (dtHrCancelamento, UTC); the counterparty has not answered yet.

Example:

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

recurrenceId
string
required

The recurrence id.

Example:

"RR0435879820240605njua7shf40o"

status
string
required

The local authorization status, unchanged until the counterparty answers the cancellation.

Example:

"Active"