Encerramento de conta

stable

O encerramento de uma conta pode ser motivado por:

  • Solicitação do cliente (HOLDER_REQUEST): o cliente solicita ao parceiro Bankly o encerramento de sua conta;
  • Desacordo comercial (COMMERCIAL_DISAGREEMENT): o parceiro Bankly opta pelo encerramento da conta do cliente. Nesse caso, o parceiro deve notificar ao seu cliente a respeito do encerramento.

🚧

Importante

Caso todas as contas de um documento sejam fechadas, o vínculo comercial com o cliente será encerrado automaticamente. Se esse for o intuito, considere utilizar a API de Offboarding, que, além de encerrar o vínculo com o titular, realiza o encerramento da(s) conta(s).

Etapas internas do encerramento

O processo de encerramento de conta passa por duas etapas internas: o encerramento técnico e o legal.

Encerramento técnico

Consiste no encerramento da conta dentro da base de dados do Bankly.

Após o encerramento técnico, o parceiro não conseguirá realizar transações de cash-in e cash-out.

Se houver saldo referente a estorno ou depósito em andamento durante o encerramento, o cliente pode solicitar a devolução desse valor através do Service Desk.

Encerramento legal

O encerramento legal consiste no processo de comunicação ao CCS (Cadastro de Clientes do Sistema Financeiro) do Bacen sobre o encerramento da conta. Esse comunicado pode ocorrer em até 30 dias após o encerramento técnico.

Evidência de pedido de encerramento

Ao realizar o encerramento da conta por solicitação do seu cliente (HOLDER_REQUEST), obrigatoriamente você deverá armazenar a evidência de que o vínculo foi encerrado a pedido do cliente. Essa evidência poderá ser solicitada a qualquer momento por razões de auditoria.

Para mais informações, consulte a Resolução Nº 96, de 19 de maio de 2021.

🚧

Importante

A conta constará como encerrada no Registrato do CSS somente após o processo de encerramento legal.

Chaves Pix no contexto de encerramento

Todas as chaves Pix Bankly vinculadas a uma conta encerrada serão excluídas imediatamente, assim como os processos de solicitação de portabilidade e reivindicação de chave serão cancelados.

Pré-requisitos

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

  • O cliente possua o status ativo (ACTIVE);
  • A conta não possua saldo disponível e nem bloqueado.

🚧

Importante

Em caso de desacordo comercial (COMMERCIAL_DISAGREEMENT), será possível realizar o cancelamento de contas que possuam saldo disponível ou bloqueado.

Requisição

Requisição HTTP

PATCH https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumber}}/closure
--location --request PATCH 'https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumber}}/closure' \
--header 'api-version: 1' \  
--header 'Authorization: Bearer {{Token}}' \  
--header 'Content-Type: application/json' \  
--data-raw '{  
	"reason": "HOLDER_REQUEST"  
	}'

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:

ScopeDescrição
account.closeConcede acesso para encerrar uma conta de pagamentos.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
authorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

NomeTipoDescrição
accountNumberpathNúmero da conta a ser encerrada.

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

NomeTipoDescrição
reasonstringMotivo do encerramento (HOLDER_REQUEST ou COMMERCIAL_DISAGREEMENT) no corpo da requisição.
{  
	"reason": "HOLDER_REQUEST"  
}

Resposta (Response)

O status code 202 indicará que a solicitação de encerramento foi aceita.

Verificação do status

Para conferir o status do encerramento, o parceiro poderá utilizar os seguintes endpoints:

O status CLOSED indicará que a conta foi fechada com sucesso.

🚧

Importante

Indicamos que você consulte o Cache-Control no header da requisição, pois ele indicará o tempo a ser aguardado para fazer uma nova consulta.

Erros

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

Status codeCódigoMensagemDescrição
422ACCOUNT_WITH_NON_ZERO_BALANCEAccount has a balance greater than zero. This account must be settled before requesting the account's closure.O saldo da conta é maior que zero. Para solicitar o encerramento da conta, o saldo precisa estar zerado.
422ACCOUNT_HAS_ALREADY_BEEN_CLOSEDHolder has already been closed.Essa conta já foi encerrada.
422ACCOUNT_NOT_FOUNDAccount not found.A conta não foi encontrada.

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

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são:

Nome do eventoDescrição
ACCOUNT_WAS_CLOSEDA conta foi encerrada tecnicamente.
ACCOUNT_WAS_LEGALLY_CLOSEDA conta foi encerrada legalmente.