Skip to main content
GET
List Cards Transactions

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts endpoint. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Query Parameters

page_size
integer
default:10
required

The maximum number of items to return per page. This number can be between 10 - 100, and will default to 10

Required range: 10 <= x <= 100
page_number
integer
default:1
required

The page number to retrieve the next set of items. The number has to be greater than 1, and will default to 1

Required range: x >= 1
card_id
string<uuid>

Universally unique identifier (UUID v4) of a card.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

start_time
string

The earliest transaction creation time to filter by, in ISO 8601 format. The maximum time interval between start_time and end_time is 90 days.

When the value includes a timezone offset such as +08:00, the + character must be URL-encoded as %2B in the query string — otherwise the server interprets it as a space and rejects the request. Example: start_time=2024-03-21T17:17:32%2B08:00. UTC values ending with Z (e.g., 2024-03-21T09:17:32Z) do not require encoding.

Example:

"2024-03-21T09:17:32Z"

end_time
string

The latest transaction creation time to filter by, in ISO 8601 format. The maximum time interval between start_time and end_time is 90 days.

When the value includes a timezone offset such as +08:00, the + character must be URL-encoded as %2B in the query string — otherwise the server interprets it as a space and rejects the request. Example: end_time=2024-03-21T17:17:32%2B08:00. UTC values ending with Z (e.g., 2024-03-21T09:17:32Z) do not require encoding.

Example:

"2024-03-21T09:17:32Z"

Response

200 - application/json

OK - Card transactions returned successfully.

total_pages
integer

The total pages of available items.

Example:

1

total_items
integer

The total counts of available items.

Example:

10

data
object[]