API's
InstitucionalBlogService DeskStatus Page

Cancelamento de um pedido de reivindicação

patch
https://api-mtls.sandbox.bankly.com.br/pix/claims//cancel

Cancele um pedido de reivindicação de posse ou portabilidade de uma chave. Tanto o doador quanto o reivindicador poderão realizar o cancelamento, desde que o status do pedido de reivindicação esteja como WAITING_RESOLUTION.

stable scope: pix.claims.cancel
📘

Nota

O cliente doador só poderá cancelar um pedido de reivindicação de posse ou portabilidade de e-mail e telefone após validar a posse da chave por meio do código TOTP. Confira a documentação Cancelamento de um pedido de reivindicação para mais informações.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string | null
required

Identificador único do pedido. Esse valor é retornado na criação de pedido de reivindicação de chave, no evento PIX_CLAIM_WAS_CONFIRMED e na consulta de pedidos de reivindicação.

Body Params
string
enum
required

Motivo de cancelamento do pedido de reivindicação.

Allowed:
Headers
string
required
Defaults to 1

Versão da API.
Atualmente estamos na 1.0.

string
required

Número do documento do usuário que está fazendo a requisição. Informe somente números para CPF e caracteres alfanuméricos para CNPJ, sem formatação.

string

O envio desse campo no header da requisição é obrigatório apenas para reivindicação de chaves do tipo e-mail e telefone. Ele deve ser preenchido com o hash gerado na criação do código TOTP.

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados