Transactions
The Transactions API provides read-only access to account transaction history for a specified account, including deposits, withdrawals, transfers, payments, fees, and adjustments. The API supports retrieval of posted, pending, and optionally future-dated transactions using date-based filters and standard pagination controls.
Transaction responses may include optional image metadata, enabling downstream retrieval of related banking images when supported by the institution.
End-user benefits
- View posted, pending, and future-dated transaction activity for an account.
- Filter transaction history by date range for statements, reporting, and account history views.
- Use transaction-level image metadata (
imageIdentifier,imageType) to retrieve associated banking images when available.
Integration capabilities
- List transactions (GET /v1/transactions) — Requires
accountId; supports ISO 8601startDateandendDatefilters (FI-configured defaults apply when omitted). - Set
retrieveFutureTransactionsto include future-dated transactions (may override endDate based on institution configuration). - Support pagination and filtering using
$skip,$top,$filter, and optionalisCreditTransaction; includeadditionalFieldsto return institution time zone data. - When using client credentials authentication, provide either
hostUserIdorloginId(mutually exclusive). - Use
institutionCustomerIdto scope results to a specific business location (see the Get Customer Profile API for more details). This is specific to Business Banking users.
Scopes
| Scope | Description |
|---|---|
transactions:read | Read transactions |
Required headers
| Header | Description |
|---|---|
Authorization | Bearer {token} (OAuth V2) |
transactionId | UUID used to trace and correlate requests across services for debugging and logging. |
Error codes (TXN_*)
| Code | Message | HTTP Status Code |
|---|---|---|
| TXN_10001 | The date(s) provided could not be parsed, or represented an invalid range. | 400 |
| TXN_10002 | Request is missing a transactionId header | 400 |
| TXN_10003 | Request should only contain printable ASCII characters | 400 |
| TXN_10004 | Request transactionId header is too long | 400 |
| TXN_10005 | Invalid query param | 400 |
| TXN_10006 | A valid institution customer id is required for business users. | 400 |
| TXN_10007 | A valid account id is required. | 400 |
| TXN_10008 | Request header is too long | 500 |
| TXN_10009 | Request callingAppId header is too long | 400 |
| TXN_10010 | One or more query params are invalid or blank | 400 |
| TXN_10011 | The authorization for this request does not allow for one or more attributes to be passed as parameters | 400 |
| TXN_11001 | Full authentication was not provided in the request. | 401 |
| TXN_11002 | The authentication token that was sent in the request is invalid. | 401 |
| TXN_11003 | The authentication provided does not authorize this request. | 403 |
| TXN_11004 | Unauthorized access | 403 |
| TXN_20001 | Transaction history is not enabled for this account. | 400 |
| TXN_20002 | This user is not entitled to see transaction history for this account. | 400 |
| TXN_20003 | Transactions for this account are available on an external site. | 400 |
| TXN_20004 | The CIF number is required, but was not found | 400 |
| TXN_20005 | Error processing filter expression | 400 |
| TXN_20006 | Error processing pagination expression | 400 |
| TXN_88888 | Internal validation error. | 500 |
| TXN_90000 | Server cannot handle this request | 400, 404, or 500 |
| TXN_99988 | Server can only handle JSON request. Other media types are not supported | 415 |
| TXN_99990 | Client error | 400 |
| TXN_99999 | Server error. | 500 |