Contexto


Neste artigo, explicamos como realizar a exclusão de uma chave PIX de uma conta por meio da nossa API. A exclusão pode ser feita por solicitação do usuário detentor da chave ou obrigatoriamente antes do encerramento de uma conta.


Pré-requisitos


Antes de realizar o encerramento de uma conta, certifique-se de que:

  • Está autenticado com um token válido da nossa API;
  • Possui client_id e client_secret ativos;
  • Salvou previamente o accountId da conta em que a chave está vinculada;
  • A chave PIX que será excluída;


1. Remover a chave PIX


▶️ Endpoint


DELETE {{url}}/v1/accounts/{{accountId}}/aliases/{{alias}}


⚠️ Observações Importantes


2. Códigos de Erro


Código de Erro
HTTP Code
Descrição (PT-BR)
778
400
A chave não está associada a agência e conta informados.


3. Consulta de alias da conta


▶️ Endpoint


GET {{url}}/v1/accounts/{{accountId}}/aliases


Caso a chave excluída seja a única da conta, após a exclusão, retornará um array vazio. Caso não seja, retornará as demais chaves vinculadas a conta.


Suporte


Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte