List bank transactions

get

https://api.cardda.com/v1/banking/bank_transactions

Returns a paginated list of bank transactions for authorized accounts. This endpoint provides comprehensive filtering, sorting, and pagination capabilities to help you query transaction history effectively.

Key Features

Pagination: Control result size with _start and _end parameters (default: 25 items)
Sorting: Sort by any field in ascending or descending order
Filtering: Apply complex filters on multiple fields including amounts, dates, and statuses
Relationships: Automatically includes related entities (recipients, senders, payables, errors)

Authorization

Regular users can only view transactions from accounts they have access to through a bank key.

Response Structure

The response includes the transaction details along with nested relationships:

recipient: Full recipient information including bank details
sender: Bank account information of the sender
bank_errors: Any errors encountered during processing
payables: Related invoices (if Pay product is activated)
payroll: Associated payroll information (if applicable)

Common Use Cases

Get recent transactions: Use default pagination without filters
Find high-value transactions: Filter by amount range
Check transaction status: Filter by specific status values
Audit trail: Sort by created_at or updated_at with date filters
Reconciliation: Filter by external_id or date ranges

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_start

integer

≥ 0

If all the transactions where in an array, this would represent the index of the first item returned in the response

_end

integer

≥ 0

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order

string

enum

The order method, which can be ascending or descending

Allowed:

_field

string

The field used to sort, the example illustrates a response that would be sorted by the creation date

amount

string

Only as an example of filtering results that have an amount less than $11000. For more detailed explanation, go to the How to filter results section.

sender_id

uuid

Filter transactions by sender bank account ID. Required for non-admin users to access transactions.

status

string

Filter by transaction status. Supports JSON operators:

Single status: "approved"
Multiple statuses: {"$in": ["approved", "declined"]}
Exclude status: {"$ne": "draft"}

Available statuses:

draft: Initial state when transaction is created
enqueued: Transaction queued for processing
dequeued: Transaction removed from queue
preauthorized: Transaction preauthorized by bank
declined: Transaction declined by bank
approved: Transaction approved and processed

recipient_id

uuid

Filter transactions by recipient ID

bank_payroll_id

uuid

Filter transactions belonging to a specific payroll

created_at

string

Filter by creation date using JSON operators:

After date: {"$gte": "2025-01-01T00:00:00Z"}
Before date: {"$lt": "2025-02-01T00:00:00Z"}
Date range: {"$gte": "2025-01-01T00:00:00Z", "$lt": "2025-02-01T00:00:00Z"}

updated_at

string

Filter by last update date. Same operators as created_at.

external_id

string

Filter by the bank's external transaction ID

description

string

Filter by transaction description. Supports:

Exact match: "Pago gastos"
Partial match: {"$like": "%gastos%"}
Case insensitive: {"$ilike": "%GASTOS%"}

idempotency_id

string

Find transaction by idempotency key (useful for checking duplicate prevention)

holder_id

uuid

Filter transactions by the company that owns them

transition

string

Filter by current transition state:

enqueue: Being queued for processing
dequeue: Being removed from queue
authorize: Being authorized
preauthorize: Being preauthorized
remove: Being removed
null: No active transition

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every banking endpoint. See The company-id header for details on how to obtain a value for this header and the error responses to expect when it is missing or invalid.

Responses

200Successfully retrieved bank transactions list

401Unauthorized - Invalid or missing authentication token