Exclusão de chaves

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

A chave a ser excluída não esteja em um processo de reinvindicação. Se esse for o caso, é necessário aguardar o encerramento da disputa para realizar a exclusão.

Requisição (Request)

Requisição HTTP

DELETE https://sandbox.hiperbanco.com.br/pix/keys/{{addressKey}}

--request DELETE 'https://sandbox.hiperbanco.com.br/pix/keys/{{addressKey}}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
version	cutting-edge	Essa propriedade garante que o response da API seja retornado no formato JSON

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

Nome	Tipo	Descrição
addressKey	path	Obrigatório. Valor da chave de endereçamento a ser excluída. Veja na tabela a seguir as possibilidades de preenchimento.

Chave de endereçamento

Chave	Instrução de preenchimento
CPF	11 dígitos, sem caracteres especiais.
CNPJ	14 dígitos, sem caracteres especiais.
EMAIL	Todos os caracteres em minúsculo. Tamanho máximo de 72 caracteres.
PHONE	Número de telefone celular, composto por símbolo ‘+’, seguido pelo código do país, DDD e número de celular com até nove dígitos. Ex.: +5523415162342.
EVP	Tamanho máximo de 36 caracteres. Exemplo: 123e4967-e89b-12d3-a456-426655440000.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 204 indicará que a chave foi excluída com sucesso.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
400	INVALID_ENTRY_STATUS_FOR_EXCLUSION	Entry can only be excluded when status is OWNED.	A chave só pode ser excluída por seu proprietário.
422	ENTRY_NOT_FOUND	Entry not found.	Chave não encontrada.
422	ENTRY_REGISTERED_TO_ANOTHER_PARTNER	Entry registered to another partner.	A chave foi cadastrada para outro parceiro Hiperbanco e é por ele que ela deve ser excluída.
422	ENTRY_LOCKED_BY_CLAIM	Entry is locked when claim request is being process.	A chave está em processo de reivindicação e, portanto, não pode ser excluída.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.