Skip to content

Export Transactions

Downloads the transactions datagrid as a csv, xls or xlsx file — the same data the admin Sales → Transactions "Export" button produces. The response is a binary file attachment, not JSON. Requires the sales.transactions.view permission.

Endpoint

EndpointMethod
/api/admin/transactions/exportGET

Columns

The export carries the six datagrid columns, in order:

HeaderValue
IDTransaction id.
Transaction IDThe payment gateway's transaction id.
Invoice IDThe related invoice's number.
Order IDThe parent order's number.
StatusThe transaction status (e.g. paid, pending).
DateWhen the transaction was recorded.

Query parameters

format selects the export format — csv (the default), xls or xlsx; any other value returns 422. Send an Accept header matching the format: text/csv, application/vnd.ms-excel or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

The export honours the same filters as the listing, so you export exactly the rows you're viewing: id, transaction_id, invoice_id, order_id, status, created_at_from / _to. (Pagination does not apply — the export returns every matching row.)

Permission

sales.transactions.view

Released under the MIT License.