Bank Accounts
Bank account resources are eligible bank accounts that are to receive a transfer at the end of a transfer period. You can create, edit, and delete bank accounts via the merchant console.
You can create up to 10 bank accounts, but only one can be set to primary. The primary bank account is the one that will be transfered to at the end of the next pay cycle.
A bank account starts in the new
state, and then when a transfer has been made to it, it becomes verified
. If a transfer is unable to be made, it will be change to the unable_to_verify
state and the user will be contacted. If a transfer has been made to the account before, but subsequently rejected, it will be set to errored
.
The bank account object
Fields | |
---|---|
id | string (UUID) The unique identifier for the bank account |
holder_name | string The account holder’s name |
bank_name | string The name of the bank |
branch_name | string The name of the bank’s branch |
country | string (ISO Alpha-2) The country of the bank account |
bank_address | string The address of the bank account |
currency | string (ISO-4217) The currency the bank account handles. |
account_number | string The account number, obfuscated except the last 4 digits. |
routing_number | string The routing number for the bank account. |
swift_code | string The SWIFT code fo the bank account |
last_four | string The last 4 digits of the bank account. |
status | string One of new , verified , unable_to_verify , or errored . |
primary | boolean Whether the bank account is the primary account or not. |
created_on | string (ISO-8601) The date the refund was created on. |