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. Transactions flagged as suspected fraud are hidden by default.
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, payment link, suspected fraud flag, 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. - Suspected Fraud Filtering: Use
is_suspected_fraud=1to retrieve only transactions that have been flagged as suspected fraud. These are charges that were blocked by Stax Connect on behalf of the merchant. When using this parameter, do not combine it with thesuccessparameter. - User Roles: Ensure that the API key or user has the necessary permissions to access transaction data.
- Suspected Fraud Filtering: Transactions flagged as suspected fraud are hidden by default from all transaction listings, searches, and exports. To include flagged transactions alongside all other results, pass
is_suspected_fraud=1. Omitting the parameter or passingis_suspected_fraud=0keeps flagged transactions hidden. The parameter accepts boolean values (1or0); invalid values will return a422validation error.
Response Structure
| Code | Response | Reason |
|---|---|---|
| 200 | Success | Returns a paginated list of transaction objects matching the filter criteria. Each transaction object includes details such as id, type, status, amount, currency, customer_id, payment_method_id, created_at, and meta |
| 400 | Bad Request | Invalid query parameters. |
| 422 | Unprocessable Entity | Validation failed for one or more query parameters (e.g., invalid value for is_suspected_fraud). |
| 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.
Returns a paginated list of transaction objects matching the filter criteria.
Invalid query parameters.
Authentication failed.
Validation failed for one or more query parameters.
An unexpected error occurred on the server.