POST api/Transaction/GetTransactionsByTransactionDate
Get transactions within a given date range from a UserInstitutionAccount
Request Information
URI Parameters
None.
Body Parameters
GetTransactionByDateParamsName | Description | Type | Additional information |
---|---|---|---|
AccountID |
Guid-type AccountID of a UserInstitutionAccount |
globally unique identifier |
None. |
StartDate |
Transactions retrieved must not be earlier than this start date. Date format, e.g. "2018/10/01" |
date |
None. |
EndDate |
Transactions retrieved must not be later than this end date. Date format, e.g. "2018/10/31" |
date |
None. |
Request Formats
application/json, text/json
{ "AccountID": "d4867dcf-13c3-4fcd-a8d2-1cd135fa3c44", "StartDate": "2025-01-23T03:21:24.5377843+00:00", "EndDate": "2025-01-23T03:21:24.5377843+00:00" }
application/xml, text/xml
Coming soon.
Response Information
Resource Description
List of transactions within the given date ranger from the given account.
Collection of TransactionInformationName | Description | Type | Additional information |
---|---|---|---|
CheckImage |
If Transaction's a check, CheckImage includes the link to download the check image (Optional). |
string |
None. |
UserInstitutionAccountID |
Guid-type ID of the UserInstitutionAccount from which the transaction was downloaded. |
globally unique identifier |
None. |
TransactionID |
Guid-type ID of the Transaction. |
globally unique identifier |
None. |
Status |
Transaction's Status such as "Pending", "Posted" (Optional). |
string |
None. |
Type |
Transaction's Type such as "DEBIT", "CREDIT" (Optional). |
string |
None. |
Amount |
Transaction's Amount. |
decimal number |
None. |
Currency |
Transaction's Currency symbol, such as "$" (Optional). |
string |
None. |
Date |
Transaction's Date. |
date |
None. |
TransactionDate |
Transaction's Transaction Date. |
date |
None. |
PostDate |
Transaction's Posted Date. |
date |
None. |
Description |
Transaction's Description. |
string |
None. |
Balance |
Transaction's Running Balance. |
decimal number |
None. |
Merchant |
Transaction's Merchant information (Optional). |
string |
None. |
Category |
Transaction's Category information (Optional). |
string |
None. |
CheckNum |
Transaction's Check Number information (Optional). |
string |
None. |
Memo |
Transaction's Memo information (Optional). |
string |
None. |
LastModified |
Transaction's last modified date |
date |
None. |
Response Formats
application/json, text/json
[ { "UserInstitutionAccountID": "58da4f2c-48eb-46db-80dc-22bb3b3fe724", "TransactionID": "8b677892-4b7f-4f99-8670-44a737a05efb", "Status": "sample string 3", "Type": "sample string 4", "Amount": 1.0, "Currency": "sample string 5", "Date": "2025-01-23T03:21:24.5377843+00:00", "TransactionDate": "2025-01-23T03:21:24.5377843+00:00", "PostDate": "2025-01-23T03:21:24.5377843+00:00", "Description": "sample string 6", "Balance": 1.0, "Merchant": "sample string 7", "Category": "sample string 8", "CheckNum": "sample string 9", "Memo": "sample string 10", "LastModified": "2025-01-23T03:21:24.5377843+00:00", "CheckImage": "sample string 1" }, { "UserInstitutionAccountID": "58da4f2c-48eb-46db-80dc-22bb3b3fe724", "TransactionID": "8b677892-4b7f-4f99-8670-44a737a05efb", "Status": "sample string 3", "Type": "sample string 4", "Amount": 1.0, "Currency": "sample string 5", "Date": "2025-01-23T03:21:24.5377843+00:00", "TransactionDate": "2025-01-23T03:21:24.5377843+00:00", "PostDate": "2025-01-23T03:21:24.5377843+00:00", "Description": "sample string 6", "Balance": 1.0, "Merchant": "sample string 7", "Category": "sample string 8", "CheckNum": "sample string 9", "Memo": "sample string 10", "LastModified": "2025-01-23T03:21:24.5377843+00:00", "CheckImage": "sample string 1" } ]
application/xml, text/xml
Coming soon.