Skip to main content
POST
Validate an inbound PIX Automatico cancellation

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json
cpfCnpjSolCancelamento
string
requerido

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

Ejemplo:

"77379362038"

dtInicialRecorrencia
string
requerido

First payment date (aaaa-mm-dd).

Ejemplo:

"2024-01-10"

idCancelamento
string
requerido

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

Ejemplo:

"IC0435879820240605bcdb1fhn43a"

idRecorrencia
string
requerido

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

Ejemplo:

"RR0435879820240920njua7shf40o"

motivoCancelamento
integer<int64>
requerido

Cancellation reason (0..10).

Ejemplo:

6

nrContrato
string
requerido

Contract/order identifier (35-char).

Ejemplo:

"1234567890ABC"

pagador
object
requerido

The recurrence pagador.

recebedor
object
requerido

The recurrence recebedor.

tpFrequencia
integer<int64>
requerido

Recurrence periodicity (0..4).

Ejemplo:

4

tpPessoaSol
integer<int64>
requerido

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

Ejemplo:

0

descContrato
string

Free-text contract description (35-char).

Ejemplo:

"Conta de energia"

devedor
object

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

dtFinalRecorrencia
string

Last payment date (aaaa-mm-dd).

Ejemplo:

"2026-01-10"

dtHrCancelamento
string

Cancellation timestamp (UTC).

Ejemplo:

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

dtHrCriacaoRecorrencia
string

Recurrence creation timestamp (UTC).

Ejemplo:

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

valor
number<double>

Fixed payment amount in reais (a JSON number).

Ejemplo:

550

Respuesta

OK

dtHrValidacao
string
requerido

Validation timestamp (UTC).

Ejemplo:

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

resultado
integer<int64>
requerido

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

Ejemplo:

1

motivoRejeicao
string

Rejection reason code (required when resultado=0).

Ejemplo:

"AP03"