List and Filter All Transactions

get

https://apiprod.fattlabs.com/transaction

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, 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_date and end_date, ensure the dates are in the correct format (YYYY-MM-DD).
Pagination: Use page and per_page to control the pagination of results.
Suspected Fraud Filtering: Use is_suspected_fraud=1 to 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 the success parameter.
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. 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.
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.

Query Params

page

integer

Page number for pagination.

per_page

integer

Number of results per page.

start_date

date

Filter transactions from this date (YYYY-MM-DD).

end_date

date

Filter transactions up to this date (YYYY-MM-DD).

type

string

Filter by transaction type (e.g., charge, refund, void).

success

string

enum

Filter by transaction success status. Use 1 for successful transactions and 0 for failed transactions. Do not combine with is_suspected_fraud.

Allowed:

is_suspected_fraud

string

enum

Filter for transactions flagged as suspected fraud. Set to 1 to retrieve only blocked transactions that Stax Connect hid from the merchant. Do not combine with the success parameter.

Allowed:

sort

string

Field to sort results by.

order

string

enum

Defaults to DESC

Sort order: ASC (ascending) or DESC (descending).

Allowed:

keywords[]

array of strings

Search across multiple transaction fields using keywords.

keywords[]

customer_id

string

Filter transactions by customer ID.

payment_method_id

string

Filter transactions by payment method ID.

Responses

200

Returns a paginated list of transaction objects matching the filter criteria.

400

Invalid query parameters.

401

Authentication failed.

500

An unexpected error occurred on the server.