List 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

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