Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Get a Bank Link

Description

This request returns a specific bank link that is set up within a client account.

Notes

None

Error Codes

None

Request URL

Syntax GET /restapi/accounts/{accountnumber}/achbanklinks/{banklinkoid}
Example URL https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/achbanklinks/4179340455459241305

Response Data Fields

Field Description
accountType The type of bank account that this link is to.
“C” for checking/money market accounts,
“S” for savings accounts.
bankAccountNumber

The last 4 digits of 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.

bankLinkOid The unique identifier for the specific bank link.
bankName The name of the bank holding the bank account.
banklinkType The type of banklink: ACH(A) or Microdeposit(M)
creationTimestamp The date the bank link was created in the brokerage system. Follows ISO-8601 formatting.
nameOnAccount Name on bank account.
routingNumber The 9 digit routing number used for ACH transfers by the client’s bank.
status The status of the bank link.
“A” for active,
“D” for deleted.
statusTimestamp The date and timestamp of the last status change. Follows ISO-8601 formatting.
activationTimestamp The date and timestamp of the activation of the bank link. This field will not be returned until the link has been activated. Follows ISO-8601 formatting.
verifyStatus The verification status of the banklink. Returns 'true' if the banklink has been verified, false otherwise.
mdverify The verification status of Micro Deposit (MD). Returns 'true' if the MD has been verified, 'false' if the MD has not been verified, 'na' if the MD verification is not enabled.
ovverify The verification status of Owner Verification (OV). Returns 'true' if the OV has been verified, 'false' if the OV has not been verified, 'na' if the OV verification is not enabled.

Response Example


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/achbanklinks/180141801418014
Content-Type: application/json
Transfer-Encoding: chunked
Date: Wed, 12 Mar 2014 14:04:43 GMT

{
 "accountType" : "C",
 "bankAccountNumber" : " XXXXXX6123",
 "bankLinkOid" : "180141801418014",
 "banklinkType" : "M",
 "bankName" : "COOPERATIVA A/C LARES REGION C",
 "creationTimestamp" : "2014-03-12T10:04:44.033-04:00",
 "nameOnAccount" : "foliofn Investments Inc.",
 "routingNumber" : "021583218",
 "status" : "A",
 "statusTimestamp" : "2014-03-12T10:04:44.010-04:00",
 "activationTimestamp" : "2014-03-12T10:04:44.010-04:00",
 "verifyStatus" : "false",
"mdverify" : "true", "ovverify" : "false" }

Change Log

4//22/2016

  1. Added mdverify and ovverify statuses.

9/11/2015

  1. Added Change Log

9/10/2015

  1. Added banklinkType and verifyStatus to response data fields
  2. Added banklinkType and verifyStatus to response example

Getting Started

REST APIs

Resources

Developer Home