Retrieve a list of all transactions for the merchant account. Use query parameters to filter and sort transactions based on criteria such as date range, transaction type, status, amount, and more.
The List and Filter All Transactions endpoint allows you to retrieve all transactions associated with the merchant account. You can apply various query parameters to sort and filter the transaction data, enabling you to find specific transactions or analyze transaction history based on different criteria.
Key Features
- Retrieve a paginated list of transactions.
- Filter transactions by date range, status, type, amount, customer, payment method, and more.
- Sort transactions based on specific fields.
Usage Notes
- Combining Filters: You can combine multiple query parameters to narrow down the results to specific transactions.
- Date Range Filtering: When using
start_dateandend_date, ensure the dates are in the correct format (YYYY-MM-DD). - Pagination: Use
pageandper_pageto control the pagination of results. - User Roles: Ensure that the API key or user has the necessary permissions to access transaction data.
Response Structure
Code | Response | Reason |
|---|---|---|
200 | Success | Returns a paginated list of transaction objects matching the filter criteria. |
400 | Bad Request | Invalid query parameters. |
401 | Unauthorized | Authentication failed. |
500 | Internal Server Error | An unexpected error occurred on the server. |
Important Considerations
Data Security: Ensure that sensitive transaction data is handled securely and in compliance with data protection regulations.
Rate Limiting: Be aware of any rate limits on API calls to avoid throttling.
Data Consistency: Transactions are continually updated; consider implementing webhooks for real-time updates.