Learn how to manage bank accounts for the direct deposit switching and paycheck linked loans
Information related to the bank accounts used for the Direct Deposit in a user's payroll account is collected during the verification of income and employment and can be accessed before making the deposit switches.
Attributes
Attributes of the Bank Account:
Attribute | Type | Description |
---|---|---|
account_number | string | The unique account number of the selected bank account |
routing_number | string | The unique routing number of the selected bank account |
account_name | string | User-friendly account name that is related to the bank account |
account_type | string | The account type of the bank account. There are two types of accounts: C - Checking account S - Saving account |
deposit_type | string | The deposit type of the bank account. There are three types of deposits: E - Entire Paycheck P - Percentage of the Paycheck A - Fixed Amount from the paycheck |
deposit_value | string | The deposit value of the selected bank account |
bank_name | string | The bank name of the selected bank account |
Endpoints
Available endpoint list for bank accounts:
Endpoint |
---|
List of Bank Accounts - GET /links/{link_id}/bank_accounts |
Create Bridge Token for a new direct deposit - POST /users/{user_id}/tokens/ |
Sample Object
The example object returned by the List of Bank Accounts endpoint:
[
{
"account_number": "11114623",
"routing_number": "101014378",
"account_name": null,
"account_type": "C",
"deposit_type": "A",
"deposit_value": "1604.98",
"bank_name": "Sandbox Bank"
},
{
"account_number": "11111308",
"routing_number": "101013399",
"account_name": null,
"account_type": "C",
"deposit_type": "A",
"deposit_value": "25.00",
"bank_name": "Sandbox Bank"
}
]