Skip to main content
POST
Validate an inbound PIX Automatico schedule 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"

dtHrCancelamento
string
required

Cancellation timestamp (UTC).

Example:

"2024-09-20T10:10:05.025Z"

endToEndId
string
required

Unique payment-instruction id (32-char).

Example:

"E11111111202409201500y6j6mt9l1pi"

idCancelamento
string
required

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

Example:

"CA0435879820240920bcdb1fhn43a"

idConciliacaoRecebedor
string
required

Receiver conciliation id (35-char).

Example:

"JDPI2024091800000000000000000000002"

idRecorrencia
string
required

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

Example:

"RR0435879820240919njua7shf40o"

ispbDestinatario
string
required

Destination PSP ISPB (8 digits, a v5.5.0 string).

Example:

"11111111"

ispbSolicitante
string
required

Requesting PSP ISPB (8 digits, a v5.5.0 string).

Example:

"04358798"

motivoCancelamento
integer<int64>
required

Cancellation reason (0..6).

Example:

5

solCancelamento
integer<int64>
required

Requesting PSP (0=pagador, 1=recebedor).

Example:

0

tpPessoaSol
integer<int64>
required

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

Example:

0

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:

"CH16"