Search K

Appearance

List Transactions​

GET
/transactions

Retrieves a paginated list of transactions filtered by date range and optional criteria such as type and status. Sorting options are also available.

Authorizations​

BearerAuth
TypeHTTP (bearer)

Parameters​

Query Parameters

from_date*

The start date for transaction records (DD/MM/YYYY). The time is assumed to be 00:00:00 on the given date.

Typestring
Required
Example01/01/2024
to_date*

The end date for transaction records (DD/MM/YYYY). The time is assumed to be 00:00:00 on the given date.

Typestring
Required
Example31/12/2024
offset*

The pagination offset (zero-based). Determines the starting point of returned records. If negative number is provided, zero is assumed.

Typeinteger
Required
Example0
limit*

The maximum number of records to return in one request. If value provided is equal or lower that 10, then 10 is assumed. If value provided is higher than 100, then 100 is assumed.

Typeinteger
Required
Example10
order_by

The field by which to sort the results (e.g., created_at, updated_at). Defaults to updated_at.

Typestring
Enum
typestatusorder_amountcreated_atupdated_at
defaultupdated_at
order_dir

The sorting direction, either ascending (ASC) or descending (DESC). Defaults to ASC.

Typestring
Enum
ASCDESC
defaultASC
filter_type

Filter the result by transaction type (PAYMENT, REFUND, or CHARGEBACK).

Typestring
Enum
PAYMENTREFUNDCHARGEBACK
filter_status

Filter the result by transaction status (AUTHORIZED, DECLINED, VOIDED, EXPIRED, CAPTURED, etc.).

Typestring
Enum
AUTHORIZEDDECLINEDVOIDEDEXPIREDPARTIAL_CAPTUREDCAPTUREDPARTIAL_SETTLEDSETTLED

Responses​

A paginated list of transactions matching the provided criteria.
application/json
JSON
{
"offset": 0,
"limit": 10,
"amount": 1,
"result": [
{
"id": "trx_01J5XCMDXCFXCAQ1BV8HVG6644",
"type": "string",
"status": "string",
"order_amount": 10000,
"order_currency": "string",
"amount_authorized": 10000,
"amount_captured": 0,
"amount_voided": 0,
"amount_refunded": 0,
"external_id": "496de72d-d4a4-45eb-b426-3d04d2078a85",
"updated_at": "2024-09-05T05:05:25Z"
}
]
}

Samples​

Powered by VitePress OpenAPI