Skip to main content
POST
Validate an inbound PIX Automatico cancellation

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
cpfCnpjSolCancelamento
string
required

Requester CPF/CNPJ (a v5.5.0 string).

Example:

"77379362038"

dtInicialRecorrencia
string
required

First payment date (aaaa-mm-dd).

Example:

"2024-01-10"

idCancelamento
string
required

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

Example:

"IC0435879820240605bcdb1fhn43a"

idRecorrencia
string
required

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

Example:

"RR0435879820240920njua7shf40o"

motivoCancelamento
integer<int64>
required

Cancellation reason (0..10).

Example:

6

nrContrato
string
required

Contract/order identifier (35-char).

Example:

"1234567890ABC"

pagador
object
required

The recurrence pagador.

recebedor
object
required

The recurrence recebedor.

tpFrequencia
integer<int64>
required

Recurrence periodicity (0..4).

Example:

4

tpPessoaSol
integer<int64>
required

Requester person type (0=PF, 1=PJ).

Example:

0

descContrato
string

Free-text contract description (35-char).

Example:

"Conta de energia"

devedor
object

The devedor, sent only when it differs from the payer.

dtFinalRecorrencia
string

Last payment date (aaaa-mm-dd).

Example:

"2026-01-10"

dtHrCancelamento
string

Cancellation timestamp (UTC).

Example:

"2024-09-23T10:10:06.101Z"

dtHrCriacaoRecorrencia
string

Recurrence creation timestamp (UTC).

Example:

"2024-09-20T09:25:49.025Z"

valor
number<double>

Fixed payment amount in reais (a JSON number).

Example:

550

Response

OK

dtHrValidacao
string
required

Validation timestamp (UTC).

Example:

"2024-09-20T14:12:05.025Z"

resultado
integer<int64>
required

Validation result (0=Invalido, 1=Valido).

Example:

1

motivoRejeicao
string

Rejection reason code (required when resultado=0).

Example:

"AP03"