List transactions
List bank transactions for the authenticated tenant.
Returns a paginated list of transactions. Default scope is settlement (eligible for invoice matching). Amounts are always positive; direction is separate. Each item includes catalog payment-method codes and the own account the movement was retrieved on.
Query parameters
| Name | Type | Required |
|---|---|---|
pagePage number. Default 1. Example: 1 | integer | Optional |
pageSizePage size. Default 20, maximum 100. Example: 20 | integer | Optional |
sortBySort column. Default transaction_date. Unknown values fall back to transaction_date. | string No maximum | Optional |
Allowed values transaction_dateamountadded_atbooking_datestatusremaining_amountdescription_displaydescription_original | ||
sortOrderSort direction. Default desc. Allowed values ascdesc | string No maximum | Optional |
startDateInclusive start of transaction_date (YYYY-MM-DD). Example: 2026-09-01 | string No maximum | Optional |
endDateInclusive end of transaction_date (YYYY-MM-DD). Example: 2026-09-30 | string No maximum | Optional |
statusSingle status, comma-separated list, or to_match (unmatched, unconsidered, and pending). | string No maximum | Optional |
Allowed values unconsideredunmatchedmatchedignoredpendingpartialto_match | ||
directionPayment direction. Amounts are always positive. Allowed values inout | string No maximum | Optional |
flowTypeEconomic flow type. | string No maximum | Optional |
Allowed values paymentrefundfeechargebackpayoutdirect_debittransferadjustmentother | ||
scopeSettlement eligibility. Default settlement. | string No maximum | Optional |
Allowed values settlementallout_of_scope | ||
counterpartyIdFilter by counterparty code (`account_code`). Example: CPT-042 | string No maximum | Optional |
paymentMethodIdFilter by catalog payment-method code (`PM-NNN`). Example: PM-001 | string No maximum | Optional |
ownAccountIdFilter by the tenant own bank account the movement was retrieved on (`code`). Example: PM-001 | string No maximum | Optional |
paymentMethodPayment channel on the transaction, not the catalog instrument type. | string No maximum | Optional |
Allowed values cardtransferdirect_debitcashcheckcryptoother | ||
paymentContextPayment context. | string No maximum | Optional |
Allowed values CITMITrecurringone_timerefundother | ||
searchCase-insensitive match on descriptions, counterparty name, or external_reference. Example: Leones | string Max 100 | Optional |
externalReferenceExact external reference. Example: INV-2026-0042 | string Max 255 | Optional |
currencyISO 4217 currency code. Example: EUR | string Max 3 | Optional |
minAmountMinimum amount (always positive). Example: 100 | number | Optional |
maxAmountMaximum amount (always positive). Example: 5000 | number | Optional |
hasRemainingIf true, only transactions with remaining_amount > 0. false is accepted and ignored. Allowed values truefalse | boolean | Optional |
Errors
This operation can return the following errors in addition to generic HTTP failures.
| Error | HTTP code | Description |
|---|---|---|
Missing Bearer token | 401 | The Authorization header is missing or is not a Bearer token. |
Invalid or revoked API key | 401 | The API key is unknown, malformed, expired, or has been revoked. |
API key is missing scope transactions:read | 403 | The key does not include transactions:read. A write scope does not imply the matching read scope. |
Too many requests, please try again later | 429 | Wait and retry. The Retry-After header is the number of seconds to wait. |
Invalid query parameters | 400 | A query value failed validation. details lists field and message. |
Tenant ID required | 400 | The authenticated credential is not bound to a tenant. |
Internal server error | 500 | Unexpected server error. The JSON body includes correlationId. Retry with backoff. |