Skip to main content
GET
List transactions
All transactions are returned through a single endpoint regardless of payment method. Results are sorted by the selected field and paginated using cursors.

Sorting

Use sort_by and sort_order to control result ordering: Both asc and desc are supported for sort_order (default: desc).

Filtering

Use payment_method=QR_PH, CARD_PRESENT, or ECOM to filter by payment type.
Use merchant_id with the UUID from /v1/merchants.
Use branch_id with the UUID from /v1/branches.
Use date_from and date_to with RFC 3339 timestamps.
Use status with comma-separated values.
Use activation_code to filter by terminal device identifier.

Pagination

Results are cursor-paginated. Use page_size (default 20, max 100) and the next_cursor from the response:
Cursors are tied to the sort_by field. Changing sort_by between pages will return a 400 error - start a new query instead.

Next Steps

Get Transaction

Retrieve full detail for a single transaction

List Merchants

Get merchant UUIDs for filtering

Authorizations

X-API-Key
string
header
required

API key enabled for Transaction Reporting. Send the complete value exactly as issued.

Query Parameters

merchant_id
string<uuid>

Filter by merchant. Canonical lowercase UUID; uppercase or non-canonical forms are rejected.

branch_id
string<uuid>

Filter by branch. Canonical lowercase UUID; uppercase or non-canonical forms are rejected.

activation_code
string

Filter by terminal activation code. Activation codes are device identifiers printed on hardware, not secrets.

payment_method
enum<string>

Filter by payment method. Omit to include all supported payment methods.

Available options:
QR_PH,
CARD_PRESENT,
ECOM
card_brand
enum<string>

Filter by card brand.

Available options:
VISA,
MASTERCARD,
JCB,
UNIONPAY
status
string

Filter by status. One or more of AUTHORIZED, CAPTURED, PARTIALLY_REFUNDED, REFUNDED, VOIDED, DECLINED, FAILED, PENDING, EXPIRED, CANCELLED, comma-separated. Case-sensitive.

date_from
string<date-time>

Start of the date range (RFC 3339). Must be less than or equal to date_to.

date_to
string<date-time>

End of the date range (RFC 3339). Must be greater than or equal to date_from.

sort_by
enum<string>
default:created_at

Field to sort by. Default: created_at. Cursor pagination works correctly across all sort fields.

Available options:
created_at,
updated_at,
amount
sort_order
enum<string>
default:desc

Sort direction. Default: desc.

Available options:
asc,
desc
page_size
integer
default:20

Number of results per page. Integer 1 to 100 (default 20). Values above 100 are clamped to 100.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor token from a previous response's next_cursor field.

Response

Successful response with transaction list

data
object[]
required
pagination
object
required