Search transactions
Searches transactions. Each result holds the fields of the transaction, prefixed with t_, and of its order.
Add ?format=csv to get CSV. Supports search_after.
apiKeyAuthorizationBasic <token>HTTP Basic authentication with your admin API key as the username and an empty password.
format?"csv"Set to csv to get the results as CSV.
"csv"application/json- body
query?stringThe query, in Lucene query syntax. Terms without an operator must all match.
size?integerThe number of results to return.
20start?integerThe offset of the first result. start and size reach the first 10,000 results.
0sort?stringA field name, optionally followed by asc or desc. Without it, the results are sorted by relevance.
search_after?stringPage with a cursor instead of start. Send -1 in the first request, then the sort value of
the last result of the previous page. Can't be combined with start.
The matching transactions.
- response
hits?HitsThe number of matches. Counts up to 10,000.
transactions?array<>curl -X POST 'https://api.example.com/v1/admin/search/transactions/' \ --user "$API_KEY:" \ -H 'Content-Type: application/json' \ -d '{ "query": "status:completed AND currency:EUR", "size": 100, "search_after": "-1", "sort": "created asc"}'{ "hits": 0, "transactions": [ { "id": "string", "merchant_id": "string", "project_id": "string", "merchant_order_id": "string", "created": "2019-08-24T14:15:22Z", "modified": "2019-08-24T14:15:22Z", "completed": "2019-08-24T14:15:22Z", "status": "string", "amount": 0, "currency": "string", "description": "string", "flags": [ "string" ], "refund_of_order_id": "string", "refund_orders": [ "string" ], "chargeback_of_order_id": "string", "chargeback_orders": [ "string" ], "c_first_name": "string", "c_last_name": "string", "c_email_address": "string", "c_address": "string", "c_country": "string", "c_merchant_customer_id": "string", "t_id": "string", "t_status": "string", "t_reason": "string", "t_amount": 0, "t_currency": "string", "t_description": "string", "t_payment_method": "string", "t_payment_method_brand": "string", "t_credit_debit": "credit", "t_balance": "internal", "t_created": "2019-08-24T14:15:22Z", "t_modified": "2019-08-24T14:15:22Z", "t_completed": "2019-08-24T14:15:22Z", "t_settled": "2019-08-24T14:15:22Z", "t_payout_batch_id": "string", "t_msc_amount": 0, "t_msc_currency": "string", "t_icf_amount": 0, "t_icf_currency": "string", "t_icp_amount": 0, "t_icp_currency": "string", "t_order_lines": [ {} ], "t_payment_method_details__transaction_id": "string", "t_payment_method_details__reference": "string", "sort": [ null ] } ]}