Overview
The Transactions API allows you to query and filter payment transactions and payment sessions. Use it for reporting, reconciliation, and displaying payment history to customers.
Transaction Types
- Payment Sessions: Checkout sessions created via the Checkout API
- Transactions: Individual payment records with amounts, fees, and payment methods
Quick Start
Step 1: List Transactions
Code
Step 2: List Payment Sessions
Code
API Reference
List Transactions
GET /api/transactions?external_id=order-123&limit=20
Query Parameters
| Parameter | Type | Description |
|---|---|---|
external_id | string | Filter by external ID |
limit | number | 1-100, default 10 |
offset | number | Pagination offset |
status | string | Filter by status |
paymentMethod | string | Filter by payment method |
dateFrom | string | Filter from date (ISO 8601) |
dateTo | string | Filter to date (ISO 8601) |
amountMin | number | Minimum amount filter |
amountMax | number | Maximum amount filter |
List Payment Sessions
GET /api/transactions/payment-sessions?status=completed&limit=20
Get Payment Session by Token
GET /api/transactions/payment-sessions/{sessionToken}
Get Transaction by ID
GET /api/transactions/transactions/{transactionId}
SDK Reference
Transaction Methods
The SDK provides transaction querying through the client's transaction resource.
Best Practices
- Use pagination for large result sets
- Filter by date range for efficient queries
- Cache frequently accessed transaction data
- Use
external_idfor order reconciliation
Related Guides:
- Checkout Guide - For creating payment sessions
- Refund Guide - For refund transactions
Last modified on
