Exclusão de chaves

stable

Este endpoint permite realizar a exclusão de chaves Pix de uma conta.

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

Requisição HTTP

HTTP

DELETE 'https://api-mtls.sandbox.bankly.com.br/pix/entries/{{addressingKeyValue}}'

cURL

--curl --request DELETE \
       --url 'https://api-mtls.sandbox.bankly.com.br/pix/entries/{{addressingKeyValue}}'\
       --header 'Accept: application/json' \
       --header 'api-version: 1' \
       --header 'Authorization: Bearer {{Token}}'\
       --header 'x-correlation-id: {{correlationId}}' \

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Scope	Descrição
pix.entries.delete	Concede acesso para excluir uma chave de endereçamento.

Cabeçalhos (Headers)

Nome	Descrição
api-version	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
Authorization	Obrigatório. Token de autorização do tipo Bearer.
x-correlation-id	Se desejar, informe um GUID v4, sendo um novo cada requisição.

Parâmetros da rota (Path)

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

Nome	Tipo	Descrição
addressingKeyValue	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 formatação.
CNPJ	14 dígitos, sem formatação.
E-mail	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.: [phone].
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.

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

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	—	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	—	A chave foi cadastrada para outro parceiro Bankly 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. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.