Encerramento de conta

Este endpoint possibilita realizar o encerramento de uma conta do cliente de nosso parceiro.

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.

📘
Nota
Se além de cancelar a conta, o parceiro deseja encerrar o vínculo comercial com o cliente, considere utilizar a API de Offboarding, que, além de excluir os dados do titular, realiza a exclusão da conta.

Pré-requisito

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

O cliente possua uma conta ativa;
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/{{accountNumRequest}}/closure?branch={branch}'

curl  
--request PATCH  
--url 'https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumRequest}}/closure?branch={2020}' \
--header 'api-version: 1' \  
--header 'Authorization: Bearer {{Token}}' \  
--header 'Content-Type: application/json' \
--header 'x-bkly-license: 24ac71da-4309-4348-9cc0-a0c88f867993' 
--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:

Scope	Descrição
`account.close`	Concede acesso para encerrar uma conta.

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-bkly-license`	Obrigatório. Id da licença bancária vinculada ao produto.

Parâmetros da rota (Path)

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

Nome	Tipo	Descrição
`accountNumRequest`	`path`	Obrigatório. Número da conta a ser encerrada.
`branch`	`query`	Agência a que pertence a conta que será encerrada.

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`reason`	`string`	Motivo do encerramento, o qual pode ser HOLDER_REQUEST (solicitação do cliente) ou COMMERCIAL_DISAGREEMENT (desacordo comercial).

{  
    "reason": "HOLDER_REQUEST"  
}

📘
Nota
Após solicitar o encerramento da conta, todas as chaves Pix vinculadas à ela serão excluídas automaticamente. Além disso, todos os processos de disputa por pedido de portabilidade ou reivindicação de posse atrelados às chaves excluídas serão encerrados.

Resposta (Response)

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

👍
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
422	ACCOUNT_WITH_NON_ZERO_BALANCE	Account 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.
422	ACCOUNT_HAS_ALREADY_BEEN_CLOSED	Holder has already been closed.	Essa conta já foi encerrada.
422	ACCOUNT_NOT_FOUND	Account 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).

Verificação do status

Para conferir o status do encerramento, é possível utilizar o endpoint de Consulta de contas do cliente pessoa física ou Consulta de dados de uma conta.

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.

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.

Etapas internas

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

Após 30 dias do encerramento técnico, é feito o encerramento legal, momento em que reportamos o fechamento da conta ao Cadastro de Clientes do Sistema Financeiro – CCS do Bacen.

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

Eventos

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

Nome do evento	Descrição
`ACCOUNT_WAS_CLOSED`	A conta foi encerrada tecnicamente.
`ACCOUNT_WAS_LEGALLY_CLOSED`	A conta foi encerrada legalmente. Neste caso, o Banco central foi informado do encerramento.