Skip to main content

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 institutionCustomerId for 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

ScopeDescription
transactions:readRead transactions

Required headers

HeaderDescription
AuthorizationBearer token (V2 authentication)
transactionIdUnique identifier for request tracking

Error codes (TXN_*)

CodeMessageHTTP Status Code
TXN_10001The date(s) provided could not be parsed, or represented an invalid range400
TXN_10002Request is missing a transactionId header500
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 users400
TXN_10007A valid account id is required400
TXN_10008Request header is too long400
TXN_10009Request callingAppId header is too long400
TXN_11001Full authentication was not provided in the request401
TXN_11002The authentication token that was sent in the request is invalid401
TXN_11003The authentication provided does not authorize this request403
TXN_20001Transaction history is not enabled for this account400
TXN_20002This user is not entitled to see transaction history for this account400
TXN_20003Transactions for this account are available on an external site400
TXN_20004The CIF number is required, but was not found400
TXN_22001Internal validation error500
TXN_90000Server cannot handle this requestVaries
TXN_99990Client error400
TXN_99999Server error500

Endpoints