Account closure
The "CloseAccount" API has been designed with the aim of simplifying and optimizing the process of closing bank accounts. Its primary purpose is to eliminate the accumulation of closure requests, providing an agile and automated solution for both customers and financial institutions. This documentation is intended to provide a comprehensive understanding of how to use the "CloseAccount" API to achieve this objective.
The Term of Account Closure details the legal conditions for termination of the relationship with FitBank. The customer must agree with all clauses set out in the documentation.
Rules and guidelines for closing accounts:
- To close an account, it is imperative to withdraw the remaining balance. Failure to do so will result in the account not being closed. Withdrawal can be done through a banking transaction (TED or PIX).
- Upon approval of the account closure request, the account holder acknowledges that the closure takes immediate effect. Consequently, all account transactions will be blocked.
- Should the client have any outstanding debts, they cannot proceed with the account closure until the debts are settled.
- If there are future-dated payments scheduled, they must be canceled before using the "closeAccount" endpoint. If the schedule isn't canceled, the account closure cannot proceed.
How to Request the Closure of Your FitBank Account
If you agree with the terms mentioned earlier and your account does not have any of the pending issues mentioned, you can request the closure of your account by following the steps below:
- Identify the Account to be Closed: To initiate the closure process, identify the account using the accountKey or the account's Banks.
- Utilize the JSON Template: Use the JSON template provided below or in the API Reference section.
- Review the Mandatory Fields: Analyze the table that contains mandatory and optional fields required to create the request.
- Make an API Call: Initiate the "closeAccount" method in the API using your credentials.
- Check the API Response: Analyze the response from the method to verify whether your request was successfully generated or if an error occurred.
- Await Request Confirmation: Wait for a response to your request via the "UpdateCloseAccount" webhook, which follows the templates provided in this documentation.
What fields are included in the request?
Field Name | Data Type | Description | Mandatory |
---|---|---|---|
PartnerId | Int | Yes | |
BusinessUnitId | Int | Yes | |
AccountKeys | Array | Identifier of the account(s) to be closed. | No |
TaxNumber | String | Please provide the tax identification number (Tax ID) of the account holder. | Yes |
Justification | String | Please provide a justification for the account closure. | Yes |
Accounts | Array | If you do not have the accountKey, you can use the banks as the identifier for the account(s) to be closed. | Yes |
{
"Method": "CloseAccount",
"PartnerId": 1237,
"BusinessUnitId": 1259,
"AccountKeys": ["096010-254444-0209003-1"],
"TaxNumber": "38.993.681/0001-09",
"Justification": "Teste encerramento de conta",
"Accounts": [
{
"Bank": "341",
"BankAccount": "0268",
"BankAccountDigit": "20588",
"BankBranch": "9"
}
]
}
Sucess
If your request to the method is successful, the returned message will follow the model below:
{ "Success": "true", "Message": "Solicitação do encerramento da conta foi registrada." }
Error
If your request to the method is unsuccessful, the message returned will follow the model below:
{ "Sucess": "false", "Message": "A conta atrelada ao AccountKey 555555-444444-000000-4 já possui um pedido de cancelamento", "Validation": [] }
Automatic Closure RequestAt Fitbank, we have implemented a strategy for accounts that remain in a final disapproved state and are not closed. In certain specific scenarios, an automatic request for account closure is initiated. These automatic request scenarios include:
- Rejected
- Internally Disapproved
- Expired Documentation
If any of these accounts fall into the scenarios mentioned above, an automatic request will be generated to close the account.
When an automatic account closure request occurs, a webhook will be triggered to notify that the account has entered the automatic closure scenario. The webhook template can be found under the "Important Messages" tab.
Important Messages
After you submit the closeAccount method request and receive confirmation that your request has been generated, you should have the "UpdateCloseAccount" webhook set up to receive future updates regarding your request. Below, you'll find the possible scenarios for the feedback you may receive.
// When a closure request is created.
{
"CloseAccountInformationStatus": 0,
"Message": "Solicitação em análise",
"Bank": "",
"BankAccount": "",
"BankBranch": "",
"BankAccountDigit": "",
"AccountKey": "004390-254444-2865635-2",
"Method": "UpdateCloseAccount",
"Method": "UpdateCloseAccount",
"BusinessUnitId": 40726
}
// When the account still holds a positive balance
{
"CloseAccountInformationStatus": 3,
"Message": "A conta possui saldo remanescente. Para continuar o processo, é necessário retirar o valor excedente",
"Bank": "",
"BankAccount": "",
"BankBranch": "",
"BankAccountDigit": "",
"AccountKey": "004390-254444-2865635-2",
"Method": "UpdateCloseAccount",
"Method": "UpdateCloseAccount",
"BusinessUnitId": 40726
}
// When the account still has a negative balance.
{
"CloseAccountInformationStatus": 3,
"Message": "A conta possui saldo negativo. Para continuar o processo, é necessário liquidar o débito",
"Method": "UpdateCloseAccount",
"Bank": "",
"BankAccount": "",
"BankBranch": "",
"BankAccountDigit": "",
"AccountKey": "004390-254444-2865635-2",
"Method": "UpdateCloseAccount",
"BusinessUnitId": 40726
}
// Webhook sent when the account has scheduled transactions.
{
"CloseAccountInformationStatus": 3,
"Message": "Você possui agendamento de pagamentos automáticos em aberto, para prosseguir realize o cancelamento do agendamento",
"Method": "UpdateCloseAccount",
"Bank": "",
"BankAccount": "",
"BankBranch": "",
"BankAccountDigit": "",
"AccountKey": "004390-254444-2865635-2",
"Method": "UpdateCloseAccount",
"BusinessUnitId": 40726
}
// Webhook sent when the account closure request is declined, and as a result, the account will not be closed.
{
"CloseAccountInformationStatus": 4,
"Message": "Solicitação de cancelamento reprovada",
"Bank": "",
"BankAccount": "",
"BankBranch": "",
"BankAccountDigit": "",
"AccountKey": "004390-254444-2865635-2",
"Method": "UpdateCloseAccount",
"Method": "UpdateCloseAccount",
"BusinessUnitId": 40726
}
// Webhook sent when the account closure request is Approved
{
"CloseAccountInformationStatus": 5,
"Message": "Conta cancelada com sucesso",
"Bank": "",
"BankAccount": "",
"BankBranch": "",
"BankAccountDigit": "",
"AccountKey": "004390-254444-2865635-2",
"Method": "UpdateCloseAccount",
"Method": "UpdateCloseAccount",
"BusinessUnitId": 40726
}
//Webhook enviado quando uma conta entrar no cenário de encerramento automático
{
"CloseAccountInformationStatus": 6,
"Message": "Prezado(a) Cliente, informamos que foi iniciado o processo de encerramento automático de sua conta por motivos internos. Pedimos que tente realizar uma nova solicitação de abertura de conta dentro de 72 horas. Agradecemos sua compreensão.",
"Bank": "",
"BankAccount": "",
"BankBranch": "",
"BankAccountDigit": "",
"AccountKey": "004390-254444-2865635-2",
"Method": "UpdateCloseAccount",
"BusinessUnitId": 40726
}
Quais os CloseAccountInformationStatus?
Status | Description |
---|---|
0 | Request Created |
1 | Request Being Processed |
2 | Request Error |
3 | Request Pending |
4 | Request Disapproved |
5 | Request Approved |
6 | Auto-Close Request |
Attention to the Service Level Agreement (SLA).
The account closure request process typically takes up to 48 business hours as it involves an internal security review by the FitBank team. To ensure a prompt closure, it's crucial for customers to provide a valid justification in their request, and if there are no pending matters, the account will be closed quickly.
Updated 5 months ago