Cancelamento de um pedido de reivindicação

O endpoint de cancelamento de um pedido de reivindicação pode ser utilizado pelo doador da chave quando ele desejar cancelar um pedido de portabilidade.

Porém, só será possível realizar o cancelamento de reivindicações com o status WAITING_RESOLUTION.

🚧
Importante
O cliente doador só poderá cancelar um pedido de reivindicação de portabilidade de e-mail e telefone após validar a posse da chave através do código TOTP.

Endpoint

Para utilizar o endpoint de cancelamento de um pedido de reivindicação de chaves, preencha obrigatoriamente os seguintes campos:

Path

claimId: identificador único do pedido. Este valor é retornado na criação de pedido de reivindicação de chave;

Header

x-bkly-pix-user-id: número do documento do cliente que está fazendo a requisição. Insira apenas números, sem formatação;
x-bkly-transactional-hash: o envio desse campo no header da requisição é obrigatório apenas para cancelamento de reivindicação de portabilidade de chaves do tipo e-mail e telefone, realizado pelo doador. Ele deve ser preenchido com o hash gerado na criação do código TOTP.

Body

reason: motivo do cancelamento do pedido. Esse campo deve ser preenchido com "DONOR_REQUEST" (pedido do doador).

curl --location --request PATCH 'https://api-mtls.sandbox.bankly.com.br/pix/claims/{{CLAIMID}}/cancel' \ 
--header 'api-version: 1' \ 
--header 'x-bkly-pix-user-id: {{DOCUMENT_NUMBER}}' \ 
--header 'Content-Type: application/json' \ 
--header ' x-bkly-transactional-hash: {{hash}}' \ 
--header 'Accept: application/json' \ 
--header 'Authorization: {{Bearer}} ' \ 
--data-raw '{ 
  "reason": "DONOR_REQUEST" 
}'

Retorno

O sucesso na requisição retornará o status code 200.

Erros

Status code	Código	Descrição
422	CLAIM_RESOLUTION_PERIOD_NOT_ENDED	Após o período informado no campo `resolutionLimitDate`, não é possível solicitar o cancelamento do pedido de reivindicação.
422	CLAIM_STATUS_DOES_NOT_ALLOW_CANCELATION	O status atual da reivindicação não permite o cancelamento.
422	INVALID_CLAIM_CANCEL_REASON	O motivo do cancelamento da reivindicação é inválido.
422	CLAIM_ALREADY_CANCELED	Pedido de reivindicação já cancelado.
422	INVALID_STATUS_TO_CANCEL_CLAIM	O pedido de reivindicação não pode ser cancelado se o status for diferente de WAITING_RESOLUTION
422	CANCELATION_REASON_NOT_INFORMED	Motivo do cancelamento não informado.
422	CANCELATION_REASON_INVALID_TO_PORTABILITY_CLAIM	O motivo do cancelamento é inválido para a reivindicação de portabilidade.
422	PORTABILITY_CLAIM_STATUS_DOES_NOT_ALLOW_CANCELATION	O status atual do pedido de reivindicação de portabilidade não permite o cancelamento.
422	OWNERSHIP_CLAIM_STATUS_DOES_NOT_ALLOW_CANCELATION	O status atual da reivindicação de posse não permite o cancelamento.
422	CANCELATION_REASON_INVALID_TO_OWNERSHIP_CLAIM	O motivo do cancelamento é inválido para reivindicação de posse.
422	PORTABILITY_CLAIM_RESOLUTION_DATE_NOT_ENDED	A data de resolução da reivindicação de portabilidade não terminou para que se possa usar o motivo de cancelamento DEFAULT_OPERATION.
422	CLAIM_CAN_ONLY_BE_CANCELED_BY_CLAIMER_OR_DONOR	O pedido de reivindicação de portabilidade e o pedido de reivindicação de posse só podem ser cancelados pelo doador.