Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Get All Cash Transactions
This request returns a summary of cash transactions for a specified account.
Request URL
| Syntax | GET /restapi/accounts/{accountnumber}/cashtransactions |
|---|---|
| Example URL |
https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions?transactionTypes=AHD,AHW https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions?transactionStatuses=PD,CL https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions?daterange=3d https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions?daterange=06-07-2016,06-10-2016 https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions?minAmount=0.50&maxAmount=5.0 https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions?minAmount=1.00 https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions?maxAmount=1.00 |
Note: daterange is an optional parameter. It can be a date range. The format of a date should be “MM-dd-yyyy”. The start date and the end date should be separated by a comma, (“,”). For example, “daterange=11-01-2013,09-01-2014”. In additional to a customdate range, the value of daterange parameter could also be a code. See the other valid codes in Date Range Codes table below.
Response Data Fields
See detail information of the data fields in Get a Cash Transactions endpoint.
Error Codes
| HTTP Code Status | Field | Code | Description |
|---|---|---|---|
| 403 | – | – | The specified user is not allowed to use this request. |
| 400 | transactionType | 9008 | The transaction type is unsupported. |
| 400 | status | 9052 | Invalid cash transaction status. |
| 400 | dateRange | 9053 | Invalid date range. |
| 400 | amountRange | invalid.amountrange | Invalid amount range. |
Response Example
HTTP/1.1 200 OK
Date: Tue, 07 Jun 2016 18:20:11 GMT
Transfer-Encoding: chunked
Location: http://api.uat.foliofn.com/restapi/accounts/RE04706007/cashtransactions?transactionStatuses=PD,CC
Content-Type: application/json
Content-Language: en
[
{
"accountFees" : "0.00000",
"accountRegistration" : "RegistrationInfo-RE04706007",
"amount" : "2000.00000",
"cancelReason" : "Cancelled by user",
"cancelReasonCode" : "8",
"closeAccountFlag" : false,
"createDateTime" : "2016-10-31T15:40:11.920-04:00",
"distributionReasonCode" : "N",
"fedWithholdAmount" : "10.00",
"fedWithholdType" : "P",
"oid" : "8142508128289123779",
"processDate" : "2016-11-01T00:00:00.000-04:00",
"repeatType" : "O",
"sourceDescription" : "AccountName-RE047060-#RE04706007",
"sourceId" : "RE04706007",
"stateWithholdAmount" : "5.00",
"stateWithholdType" : "P",
"status" : "CC",
"targetDescription" : "PNC BANK INC. - BALT-#XX1234",
"transactionType" : "AHW"
},
{
"accountFees" : "0.00000",
"accountRegistration" : "RegistrationInfo-RE04706007",
"amount" : "2000.00000",
"createDateTime" : "2016-10-31T15:41:24.050-04:00",
"distributionReasonCode" : "N",
"fedWithholdAmount" : "10.00",
"fedWithholdType" : "P",
"oid" : "8502796098478763466",
"processDate" : "2016-11-01T00:00:00.000-04:00",
"repeatType" : "O",
"sourceDescription" : "AccountName-RE047060-#RE04706007",
"sourceId" : "RE04706007",
"stateWithholdAmount" : "5.00",
"stateWithholdType" : "P",
"status" : "PD",
"targetDescription" : "PNC BANK INC. - BALT-#XX1234",
"transactionType" : "AHW"
}
]
Change Log
12/02/2016
- Allow inclusive filtering based on a set of status for the getAll call
- Allow inclusive filtering based on a set of transactionTypes for the getAll call
- Return empty list when there is no cash transaction record found
10/07/2016
- Updated Error Codes.
09/09/2016
- Updated Error Codes.
07/22/2016
- Updated Error Codes.
06/07/2016
- Created page.