---
title: "Get Bank Transactions"
method: GET
path: "/v2/bank-transactions"
tags: ["bank-transactions"]
---

# Get Bank Transactions

`GET /v2/bank-transactions`

## Request

- Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.stuut.ai/v2/bank-transactions`
- Auth: HTTP bearer

List Bank Transactions

Retrieve a list of all bank transactions.

## Query parameters

- `page` integer: Page number, 0 indexed.
- `limit` integer: Number of records per page.
- `sort_by` 'timestamp' | 'amount' | 'account_mask' | 'confidence' | 'counterparty' | 'reference_number' | 'description'
- `sort_order` 'asc' | 'desc'
- `date_from` string, date, nullable: Filter transactions on or after this date (inclusive)
- `date_to` string, date, nullable: Filter transactions on or before this date (inclusive)
- `bank_account_id` string, nullable: Bank account ID to filter by
- `search` string, nullable: Search in description, reference_number, counterparty_name, remote_id
- `status__in` PaymentApplicationStatus[], nullable: Filter by cash application status
- `allocation_status__in` AllocationStatus[], nullable: Filter by allocation status (unallocated, partially_allocated, fully_allocated)
- `include_non_payments` boolean: Include non-payment transactions in results (default: False)
- `has_posting_errors` boolean, nullable: Filter to transactions with (True) or without (False) posting errors
- `partner_id` string, nullable: Filter by partner on the linked payments. A bank transaction is returned if ANY of its payments have this partner.
- `approved_by` string, nullable: Filter by who approved the linked payments. Pass `stuut` to match auto-approved payments, or a user ID to match a specific approver. A bank transaction is returned if ANY of its payments match.
- `amount_min` union: Filter transactions with amount >= this value (in standard units, e.g. dollars). Requires currency or currency__in.
  - number
  - string, decimal
- `amount_max` union: Filter transactions with amount <= this value (in standard units, e.g. dollars). Requires currency or currency__in.
  - number
  - string, decimal
- `currency` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR': The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
- `currency__in` Currency[], nullable: Filter transactions in any of these currencies. With amount_min or amount_max, the range applies in each currency's own units. Combined with currency.

## Response `200`

Successful Response

- PaginatedResponseBankTransactionListItem
  - `data` BankTransactionListItem[], required: The list of records.
    - `created_at` string, date-time, required
    - `modified_at` string, date-time, nullable, required
    - `id` string, required
    - `timestamp` string, date-time, required: If posted, the time the transaction posted. Otherwise the time the transaction was initiated/authorized.
    - `account_mask` string, required: Last 4 digits of the bank account number
    - `account_id` string, required: The id of the `bank_account` associated with the transaction.
    - `reference_number` string, required: The transaction reference number.
    - `description` string, nullable, required: The transaction's detail that often appears on your statement and portal. It can contain remittance information or descriptions about the payment.
    - `posted` boolean, required: Whether the transaction has been posted
    - `amount` string, decimal, required: The gross amount (less any fees) in the currency's smallest unit, e.g. $10 USD would be represented as `1000`. `amount` must be >= 0
    - `currency` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR', required: The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
    - `type` 'deposit' | 'withdrawal', required
    - `agent_extractions` AgentExtractions, required: Agent extractions for a bank transaction.
      - `counterparty_name` string, nullable, required
      - `counterparty_raw` string, nullable, required
      - `invoice_numbers` string[], required
    - `agent_metrics` AgentMetrics, required: The AI agent's confidence metrics
      - `confidence_reason` string, nullable: The justification for the agent's confidence score.
      - `confidence_score` integer, nullable: The confidence score of the result on a scale of 0-100, where 0 indicates no confidence in the accuracy of the result and 100 indicates full confidence in the accuracy of the result.
      - `error_code` 'duplicate' | 'insufficient' | 'invalid_file_type' | 'irrelevant' | 'processing_error' | 'upload_missing', nullable: The code for why an error occurred when processing the statement.
      - `uncertainties` string[]: A list of uncertainties we have regarding the result.
    - `is_agent_processing` boolean, required
    - `payment_status` 'non_payment' | 'potential_payment' | 'draft_payment' | 'posted_payment' | 'handled_outside', required: Status indicating the phase of cash application for a bank transaction.
    - `is_payment` boolean, nullable, required: Whether this is a payment. True=payment, False=non-payment, None=undetermined
    - `non_payment_reason` string, nullable, required: Reason for marking this transaction as a non-payment
    - `total_allocated` string, decimal, required: Total amount allocated to payments
    - `amount_handled_outside` string, decimal, required: Amount handled outside of Stuut
    - `handled_outside_reason` string, nullable, required: Reason why this transaction was handled outside of Stuut
    - `counterparty_info` CounterpartyInfo, required: Counterparty information aggregated from transaction and payments.
      - `display` string, required: Display name for the counterparty
      - `id` string, nullable, required: Partner ID if single partner identified
      - `partner_count` integer, required: Number of distinct partners from payments
    - `has_remittance` boolean, required: Whether transaction or any of its payments are associated to a remittance
    - `has_on_account` boolean, required: Whether any payment on this transaction has funds left on account
    - `amount_on_account` string, decimal, required: Total funds left on account across this transaction's payments, in standard units. Unallocated amounts net of refunds. Like `total_allocated`, this sums payments in the transaction's currency, so it is unreliable when `has_fx_payments` is true.
    - `has_fx_payments` boolean, required: Whether any payment on this transaction involves foreign exchange (different currency than bank transaction)
    - `has_posting_errors` boolean, required: Whether any payment on this transaction has a posting error and has not been posted
    - `confidence` PaymentConfidence, required: Aggregated confidence signals for a bank transaction, derived from its linked payments.
      - `score` integer, nullable, required: Minimum rubric score (0-100) across linked payments, falling back to the transaction's own agent confidence score when no scored payments exist.
      - `summary` string, nullable, required: User-facing summary text from the lowest-scored linked payment. None if no payments have been scored.
      - `should_post` boolean, nullable, required: True if all linked payments should be auto-posted according to the scorer. False if any payment should not be auto-posted. None if no payments have been scored yet.
    - `object` string, required: String representing the object's type. Objects of the same type share the same value.
  - `current_page` integer, required: The current page.
  - `total_records` integer, nullable, required: Total number of records.
  - `next_page` integer, nullable, required: The next page number, if one exists.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/stuut/apis/stuut-api.md) - [All operations](https://skmtc.dev/stuut/apis/stuut-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stuut/apis/stuut-api/revisions/ff0ad16a55ff?raw)