Skip to main content
POST
Cancelar agendamento de Pix Automático

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).

Parâmetros de caminho

endToEndId
string
obrigatório

O id da transação de pagamento (32 caracteres).

Corpo

application/json
reason
integer<int64>
obrigatório

motivoCancelamento (0..6).

recipientIspb
string
obrigatório

ISPB do participante de destino (ispbDestinatario, string).

reconciliationId
string
obrigatório

Id de conciliação do recebedor (idConciliacaoRecebedor).

requester
integer<int64>
obrigatório

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

requesterDocument
string
obrigatório

CPF/CNPJ do solicitante (cpfCnpjSolCancelamento, string).

requesterIspb
string
obrigatório

ISPB do participante solicitante (ispbSolicitante, string).

requesterPersonType
integer<int64>
obrigatório

tpPessoaSol (0=Pessoa Fisica, 1=Pessoa Juridica).

Resposta

Aceito

cancelledAt
string
obrigatório

Data/hora do cancelamento (dtHrCancelamento, UTC).

endToEndId
string
obrigatório

O id da transação de pagamento (ecoado).

idCancelamento
string
obrigatório

O id do cancelamento (29 caracteres, CA...).

reconciliationId
string
obrigatório

O id de conciliação do recebedor (ecoado).

status
string
obrigatório

O status local resultante do agendamento.