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

Create an ACH Pull Deposit

Description

This request creates an ACH transfer to pull funds into the brokerage account by using a bank link set up on the brokerage account.

Notes

• Please note that there are numerous restrictions related to deposits into different types of brokerage accounts based upon account and user characteristics (e.g., no contributions into a beneficiary IRA or any IRA when the account owner is over 70½ years old, etc.) which will be checked when sent through this API and or when the funds are received at Folio. Learn more in the Folio Institutional Help Center.
• The contribution year is the current year UNLESS the deposit occurs between 01/01/ 12:00:00am and 04/15 23:59:59 in which case the contribution year could be the current or previous year.
• The system will reject transactions without a contribution year created on IRA accounts.
• The system will reject attempts to create transactions after the 12:00:00pm the current date. If the current time is after 12:00:00, the transactions must be future dated.
• The system will enforce deposit limits for the target account. The default system limit is $100,000.00.
• The system will reject transactions that fall on non-settlement days (holidays or weekends),
• The system will reject attempts to create transactions with account restrictions.
• The system will allow transactions to be created on unverified banklinks. However, the system will not process those transactions until the banklinks are verified, request date notwithstanding.
• The system will reject attempts to create transactions with amounts less than $00.01.
• The system will reject attempts to create transactions using deleted banklinks.
• The system will reject attempts to create transactions where the banklink is newer than the transaction. In other words, the transaction request date cannot precede the banklink creation date.
• The system will reject attempts to create transactions using banklinks with no explicit relationship with the account.
• The system will reject attempts to create transactions for IRA accounts where the amount exceeds IRA contribution limits.
• The system WILL NOT enforce yearly IRA contribution limits. Five $4000.00 Traditional IRA contributions is allowed.
• In terms of the error messages, process date equals request date.

Error Codes

Request URL

Request Data Fields

Request Example

POST /restapi/accounts/RA1234ABCD/cashtransfers/achdeposits HTTP/1.1
Content-Type: application/json
{
  "amount" : "123.45",
  "banklinkOid" : "828282828282828",
  "requestDate" : "2014-02-27T00:00:00.000-05:00"
  "contributionYear" : "2015"
}

Response Example 1: Successful Deposit Creation

If the deposit attempt fails, the system will return a '400 Bad Request' with information regarding the nature of the error in the response body.
The error code is returned in the 'errorCode' field, while the 'message' field contains information about the actually error.

HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: http://api.uat.foliofn.com/restapi/accounts/RA0024900G/cashtransfers/achdeposits/2017612635063278223
Content-Type: application/json
Transfer-Encoding: chunked
Date: Sat, 05 Jul 2014 13:06:39 GMT

Response Example 2: Failure due to deposit request with non-settlement date of 11/11/2015 (Veterans's Day) and $0.00 amount in request body

If the deposit attempt fails, the system will return a '400 Bad Request' with information regarding the nature of the error in the response body.
The error code is returned in the 'errorCode' field, while the 'message' field contains information about the actually error.

HTTP/1.1 400 Bad Request
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransfers/achdeposits
Content-Type: application/json
Transfer-Encoding: chunked
Date: Sat, 05 Jul 2014 13:06:39 GMT
[
	 {
	  "type":"VALIDATION_RULE",
	  "errorCode":"transaction.rule.validation.error",
	  "message":"Error: processDate:The process date cannot be on a settlement holiday."
	  },
	  {
	    "type":"VALIDATION_RULE",
	    "errorCode":"transaction.rule.validation.error",
	    "message":"Error: amount:The transaction amount should be greater than $0.00."
	  }
]

Change Log

05/13/2016

1. Added additional info about the transaction.rule.validation.error series of errors.
2. Fixed typo of word "banklink".

10/21/2015

1. Added Change Log
2. Error codes section
3. Description header
4. Added Notes section