Transactions
Transactions APIs return account transaction history (deposits, withdrawals, transfers, payments, fees, and adjustments) with date-range and pending/future options.
End-user benefits
- Review posted transactions including checks and deposits.
- Filter history by date range; use image identifiers from history to fetch banking images.
Integration capabilities
- ISO 8601 dates (
startDate,endDate); default range when omitted is FI-configured. - Supports balance-based alerting and analytics downstream.
- Business Banking: use
institutionCustomerIdfor location/business context; resolve the business entity via the Institution User API when needed.
Transaction types
- Debits: WITHDRAWAL, CHECK, ATM_WITHDRAWAL, POS_PURCHASE, BILL_PAYMENT, TRANSFER_DEBIT, …
- Credits: DEPOSIT, DIRECT_DEPOSIT, ATM_DEPOSIT, TRANSFER_CREDIT, PAYMENT, DIVIDEND, …
- Fees: SERVICE_CHARGE, ATM_FEE, INSUFFICIENT_FUNDS_CHARGE, OVERDRAFT_FEE, LATE_PAYMENT_FEE, …
- Adjustments: LEDGER_ADJUSTMENT_DEBIT/CREDIT, DEBIT_ADJUSTMENT, CREDIT_ADJUSTMENT, …
Scopes
| Scope | Description |
|---|---|
transactions:read | Read transactions |
Required headers
| Header | Description |
|---|---|
Authorization | Bearer token (V2 authentication) |
transactionId | Unique identifier for request tracking |
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 | 500 |
| 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 | 400 |
| TXN_10009 | Request callingAppId header is too long | 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_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_22001 | Internal validation error | 500 |
| TXN_90000 | Server cannot handle this request | Varies |
| TXN_99990 | Client error | 400 |
| TXN_99999 | Server error | 500 |