Skip to main content

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 8601 startDate and endDate filters (FI-configured defaults apply when omitted).
  • Set retrieveFutureTransactions to include future-dated transactions (may override endDate based on institution configuration).
  • Support pagination and filtering using $skip, $top, $filter, and optional isCreditTransaction; include additionalFields to return institution time zone data.
  • When using client credentials authentication, provide either hostUserId or loginId (mutually exclusive).
  • Use institutionCustomerId to scope results to a specific business location (see the Get Customer Profile API for more details). This is specific to Business Banking users.

Scopes

ScopeDescription
transactions:readRead transactions

Required headers

HeaderDescription
AuthorizationBearer {token} (OAuth V2)
transactionIdUUID used to trace and correlate requests across services for debugging and logging.

Error codes (TXN_*)

CodeMessageHTTP Status Code
TXN_10001The date(s) provided could not be parsed, or represented an invalid range.400
TXN_10002Request is missing a transactionId header400
TXN_10003Request should only contain printable ASCII characters400
TXN_10004Request transactionId header is too long400
TXN_10005Invalid query param400
TXN_10006A valid institution customer id is required for business users.400
TXN_10007A valid account id is required.400
TXN_10008Request header is too long500
TXN_10009Request callingAppId header is too long400
TXN_10010One or more query params are invalid or blank400
TXN_10011The authorization for this request does not allow for one or more attributes to be passed as parameters400
TXN_11001Full authentication was not provided in the request.401
TXN_11002The authentication token that was sent in the request is invalid.401
TXN_11003The authentication provided does not authorize this request.403
TXN_11004Unauthorized access403
TXN_20001Transaction history is not enabled for this account.400
TXN_20002This user is not entitled to see transaction history for this account.400
TXN_20003Transactions for this account are available on an external site.400
TXN_20004The CIF number is required, but was not found400
TXN_20005Error processing filter expression400
TXN_20006Error processing pagination expression400
TXN_88888Internal validation error.500
TXN_90000Server cannot handle this request400, 404, or 500
TXN_99988Server can only handle JSON request. Other media types are not supported415
TXN_99990Client error400
TXN_99999Server error.500

Endpoints