Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Cancel an ACH Pull Deposit
This request cancels an ACH transfer to pull funds to the brokerage account from a client bank account. This request should be used
in the event that the existing transfer request needs to be canceled and replaced (with a new POST request) with a different transfer.
Error Codes
Code |
Description |
eft.not.owned.by.account |
The transaction doesn't belong to the account. |
uri.matching.rule |
Occurs when the account provided in the uri doesn't match the account passed via the request body JSON. |
withdrawal.cancel.wrong.status |
The wrong cancel status was passed to API or the transaction is in an uncancellable state. |
transaction.invalid.status.transition |
Caused by attempt to cancel transaction that is in-process or already cancelled |
Request URL
Syntax |
PUT /restapi/accounts/{accountnumber}/cashtransfers/achdeposits/{elecFundsTransferOid} |
Example URL |
https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransfers/achdeposits/53323232322 |
Request Data Fields
Field |
Required? |
Description |
eftOid |
Yes |
The unique identifier of the ACH transfer request. |
status |
Yes |
The status of the ACH transfer request. The only available update option is “C” to cancel. |
Request Example
PUT /restapi/accounts/RA1234ABCD/cashtransfers/achdeposits/53323232322HTTP/1.1
Content-Type: application/json
{
"eftOid" : "53323232322",
"status" : "CNLD"
}
Response Example
HTTP/1.1 200 OK
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/11111111111
Content-Type: text/html; charset=iso-8859-1
Content-Length: 0
Date: Fri, 21 Feb 2014 18:08:56 GMT
Change Log
03/12/2020
- Remove the “Description” title
- Remove extra space
- Remove the whole “Notes” part
10/23/2015
- Added Change Log
- Error codes section
- Description header