Introduction

The bank accounts are the destination of the settlements. We offer you the function to add the bank account ahead of the settlements and help you manage them. So consider this step as preparation for your future transactions.

The bank account you added can be used for the scenarios below:

• Schedule settlement. We will fetch the saved bank account information when creating scheduled settlements.
• On-demand settlement. You can simply include the bank account ID in the API request instead of the full bank account information. This will reduce the likelihood of errors for you to deal with a lot of fields each time.

The bank accounts should be bound with either a liable account or a user account.

Add a bank account to an account

The detailed bank account information requirements are the same as with payout and vary per country. For more detailed information, please refer to the Payout country requirements.

When doing scheduled settlement, if there are multiple bank accounts you added to an account, we will set a default for you in configuration.

Example request

Check the complete information in our API Reference section.

{
"bank": {
   "country": "AR",
   "currency": "ARS",
   "code": 55,
   "account_number": "4578981237412",
   "type": "local",
   "branch": "34",
   "account_type": "checking",
   "swift": "BFRPARBA",
   "beneficiary": {
     "name": "Pedro",
     "last_name": "Perez",
     "document_id": "38655345",
     "document_type": "DNI",
     "address": "Montevideo 567",
     "phone": "+5493517896611",
     "email": "[email protected]"
    }
}
}

Overall flow

Validation check

At the moment you add a bank account, we will do all the possible validation checks to avoid errors when creating settlements. That includes:

1. The basic validity field checks such as length of account number, special characters acceptance of account holder name, etc. You will receive the HTTP error for this scenario.
2. For some countries, we will perform the account validation with the banks or providers locally. We will reflect the result in status fields.

So when you add a bank account, we might need some time to do the validation. You can subscribe to our webhook or use Get bank account API to see if the status is active and valid to process a settlement.

Example response

{
       "account_id": "d907f733-5e17-4470-b963-c2ac2c11a440",
       "bank_account_id": "303ccb43-f346-4365-a245-910aeafea032",
       "creation_date": "2023-07-10T00:00:00.000Z",
       "status": "ACTIVE",
       "status_code": "200",
       "status_detail": "Bank account enabled",
       "bank": {
         "country": "AR",
         "currency": "ARS",          
         "code": 55,
         "account_number": "4578981237412",
         "type": "local",
         "branch": "34",
         "swift": "BFRPARBA",
         "account_type": "checking",
         "beneficiary":{
           "name": "Pedro",
           "last_name": "Perez",
           "document_id": "38655345",
           "document_type": "DNI",
           "address": "Montevideo 567",
           "email": "[email protected]",
           "phone": "+5493517896611"
        }
    }
}

Handle bank accounts

Get bank account information

You can get bank account information with:

• A specific bank account ID, we will respond with all the information and the current status of that bank account ID.
• The account ID, we will revert all the bank accounts that are associated with this account.

Explore full details in our API Documentation section.

Bank account status

Disable and enable a bank account

You can disable a bank account if you don't want to use it and also enable an inactive bank account.

🚧

Please pay attention to leave at least one valid bank account to avoid failure if you are doing schedule settlement.