Contexto


Neste artigo, explicamos como realizar o encerramento de uma conta por meio da nossa API. O encerramento é permitido somente para contas que estejam com saldo zerado, garantindo a segurança e a integridade do encerramento das operações vinculadas.


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 que será encerrada;
  • A conta está com saldo zerado ;
  • As chaves Pix vinculadas à conta foram previamente excluídas - veja mais detalhes de como excluir chaves  no artigo Exclusão de chave PIX.


1. Fluxo de encerramento


Considerando os requisitos acima, para realizar o encerramento de uma conta via API é necessário realizar os processos no seguinte fluxo:

  1. Verificar o saldo da conta - para mais detalhes acesse Guia Técnico – Consulta de Saldo por Período
    ▶️ Endpoint
    GET {{url}}/v2/accounts/{{accountId}}/balance
  2. Caso o saldo seja diferente de 0, é necessário realizar o Cashout do saldo em conta
    ▶️ Endpoint
    POST {{url}}/v1/accounts/{{accountId}}/withdraw
  3. Remover as chaves PIX vinculadas à conta - para mais detalhes acesse Exclusão de chave PIX
    ▶️ Endpoint
    DELETE {{url}}/v1/accounts/{{accountId}}/aliases/{{alias}}
  4. Encerramento da conta - veja o detalhamento técnico a seguir.

 

2. Encerrar Conta


▶️ Endpoint


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


⚠️ Observações Importantes

  • O encerramento não será processado caso a conta possua saldo disponível.
  • Recomendamos, antes de solicitar o encerramento, excluir todas as chaves Pix ativas vinculadas à conta.
  • Esta ação é irreversível e a conta não poderá ser reativada após o encerramento.
  • Para contas impossibilitadas de serem encerradas (saldos bloqueados, tarifas pendentes ou erros desconhecidos), tratar via ticket no Portal de Suporte.


3. Códigos de Erro


Código de Erro
HTTP Code
Descrição (PT-BR)
97
500
Saldo Contábil diferente de 0. Impossível desativar!


4. Consulta de status da conta


▶️ Endpoint


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


Será retornado o accountStatus CLOSED indicando que a conta foi encerrada.


Suporte


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