Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Create a Bank Link
This request creates a bank link on an account. This link can be used to initiate ACH transfers of cash with the client’s bank account into or out of their brokerage account. Based on how the API user’s permissions are configured, the system may create either a standard or microdeposit(MD) banklink. MD banklinks are banklinks that have associated microdeposit transactions. These transactions are sent to the client’s bank account where the amounts are used to verify the bank account’s information.
Request URL
| Syntax | POST /restapi/accounts/{accountnumber}/achbanklinks?useExistingBankInfo={boolean} |
|---|---|
| Example URL | https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/achbanklinks?useExistingBankInfo=true |
Query Parameters
| Name | Required? | Values | Description |
|---|---|---|---|
| useExistingBankInfo | No | boolean | An optional boolean indicator that attempts to create the requested bank link associated with an existing bank link for the member without generating new micro deposits. Must be requested by the same user that created the existing bank link, and bank link details (bankAccountNumber, routingNumber, accountType) must be identical to an existing bank link for the same account owner. |
Additional "useExistingBankInfo" Notes
- The API will continue to work when provided with the full bank account number. A partial bank account number in excess of four digits is unsupported. What does this mean? It means that we treat any bank account number greater than four digits as a full bank account number. For example, let's say we've created a banklink for account 1 with account number "13334567". We now attempt to create a second banklink for account 2 using "useExistingBankInfo". Here are the following scenarios "XXXXX4567" - failure for a few reasons: no matching number AND non-numeric not allowed. "34567" - failure, treated as full bank account number, no match was found "4567" - success, found match using supported four character partial "13334567" - success, found match using original number
- If the API is passed a four digit partial, the system will search for all account numbers that end with that partial. If it finds more than one hit, that is considered ambiguous. Namely, the system cannot determine which account number to use, so it will return an error.
- If you use "useExistingBankInfo" and pass in a completely different account number, it will function as if "useExistingBankInfo" wasn't used as a parameter and create an entirely new bank link based on that account number.
Request Data Fields
| Field | Required? | Description |
|---|---|---|
| accountType | Yes | The type of bank account being linked to. “C” for checking/money market accounts, “S” for savings accounts. |
| bankAccountNumber | Yes |
The account number of the linked bank account. In the rare case that there is a need for a firm to receive the full account number of the linked bank account and such firm is permissioned by Folio to receive this data, the response to this call will return the full account number of the linked bank account. |
| routingNumber | Yes | The 9 digit routing number used for ACH transfers by the client’s bank. |
| nameOnAccount | No | Name on bank account. If not supplied, this field will be the client’s name. |
Request Example
POST /restapi/accounts/RA1234ABCD/achbanklinks HTTP/1.1
Content-Type: application/json
{
"accountType" : "C",
"bankAccountNumber" : " 1234556123",
"routingNumber" : "123456789",
"nameOnAccount" : "my bank account"
}
Response Example
HTTP/1.1 201 Created
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/achbanklinks/11111111
Content-Type: text/html; charset=iso-8859-1
Content-Length: 0
Date: Fri, 21 Feb 2014 18:08:56 GMT
Notes
- MD banklinks will auto-delete after 90 days if they are not verified.
- Creating banklinks will result in email alerts.
- Once banklinks are created, they cannot be modified. You would have to cancel and create a new banklink.
- The banklink id returned in the response’s location header can be used to retrieve additional information about the banklink.
Error Codes
None
Change Log
03/12/2020
- Remove the “Description” title
08/21/2018
- Added additional notes about useExistingBankInfo
07/25/2017
- Corrected Case of Query Parameter
09/30/2016
- Added Query Parameter
- Reordered page
09/10/2015
- Expanded endpoint title description
- Added 'Notes' section
- Added Change log section