Skip to content

List Transactions

Mirrors the admin Sales → Transactions datagrid. Every transaction column plus the raw gateway data blob and the linked order summary are populated on each row.

Endpoint

EndpointMethod
/api/admin/transactionsGET

Query Parameters

ParameterTypeDescription
page, per_pageintegerPagination (default 10, cap 50).
idstringFilter by transaction row id (int or comma-list).
transaction_idstringPartial gateway transaction id.
invoice_idintegerFilter by invoice id.
order_idstringPartial order increment number.
statusstringpaid, pending, COMPLETED.
created_at_from / _todateRange.
sortstringid, transaction_id, amount, invoice_id, order_id, status, created_at.
orderstringasc, desc.

Response fields

FieldTypeDescription
idIntegerTransaction row id.
transactionIdStringGateway transaction id.
invoiceIdIntegerThe invoice this transaction paid (if any).
orderId / orderIncrementIdInteger / StringParent order id and human-facing number.
amount / formattedAmountNumber / StringTransaction amount, raw and formatted.
statusStringTransaction status — e.g. paid, pending.
typeStringTransaction type — e.g. capture.
paymentMethod / paymentTitleStringPayment method code and its human-readable title.
dataObjectThe verbatim gateway response payload (shape varies by gateway; may be null).
createdAt / updatedAtStringTimestamps.
orderObjectSlim order summary — id, incrementId, status, customerName, customerEmail, grandTotal, orderCurrencyCode.

Permission

sales.transactions.view

Released under the MIT License.