Skip to main content
POST
Registrar cancelamento de Pix Automático de entrada

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Corpo

application/json
cpfCnpjSolCancelamento
string
obrigatório

CPF/CNPJ do solicitante (uma string v5.5.0).

dtInicialRecorrencia
string
obrigatório

Data do primeiro pagamento (aaaa-mm-dd).

idCancelamento
string
obrigatório

Id único de cancelamento (29 caracteres, IC...).

idRecorrencia
string
obrigatório

Id único de recorrência (29 caracteres, RR...).

motivoCancelamento
integer<int64>
obrigatório

Motivo do cancelamento (0..10).

nrContrato
string
obrigatório

Identificador de contrato/pedido (35 caracteres).

pagador
object
obrigatório
recebedor
object
obrigatório
stCancelamento
integer<int64>
obrigatório

Status do cancelamento (0=Aceito, 1=Rejeitado).

tpFrequencia
integer<int64>
obrigatório

Periodicidade da recorrência (0..4).

tpPessoaSol
integer<int64>
obrigatório

Tipo de pessoa do solicitante (0=PF, 1=PJ).

codigoErro
string

Código de erro do upstream (100 caracteres; em um cancelamento rejeitado).

descCodigoErro
string

Descrição de erro do upstream (1000 caracteres).

descContrato
string

Descrição de contrato em texto livre (35 caracteres).

devedor
object
dtFinalRecorrencia
string

Data do último pagamento (aaaa-mm-dd).

dtHrCancelamento
string

Data/hora do cancelamento (UTC).

dtHrCriacaoRecorrencia
string

Data/hora de criação da recorrência (UTC).

valor
number<double>

Valor fixo de pagamento em reais (um número JSON).

Resposta

OK

dtHrSgct
string
obrigatório

carimbo de data/hora de registro do gateway de liquidação (UTC).

idSgct
string
obrigatório

Id local de cancelamento do gateway de liquidação (GUID de 36 caracteres).