Skip to main content
GET
List Balances 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. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Query Parameters

page_size
integer
required

The maximum number of items to return per page. Must be between 10 and 100, inclusive.

Required range: 1 <= x <= 100
Example:

10

page_number
integer
required

The page number to retrieve a specific set of items. Must be 1 or greater.

Required range: x >= 1
Example:

1

start_time
string

The start time of created_time in ISO8601 format (inclusive).

Example:

"2024-03-01T00:00:00+08:00"

end_time
string

The end time of created_time in ISO8601 format (inclusive).

Example:

"2024-03-01T00:00:00+08:00"

currency
string

Specifies the currency for which transactions are retrieved. Currency codes follow the ISO 4217 standard.

Example:

"USD"

transaction_type
enum<string>

Transaction type.

  • ALL: Includes all types of financial transactions in the system.
  • PAYIN: Incoming payment received from external sources.
  • DEPOSIT: Funds added directly to an account through bank transfer or other means.
  • PAYOUT: Outgoing payment sent to external beneficiaries.
  • TRANSFER: Movement of funds between internal accounts.
  • CONVERSION: Currency exchange between different currencies.
  • FEE: Service charges or transaction fees.
  • REFUND: Reversal of a previous payment or transaction.
  • ADJUSTMENT: Manual or automated correction to account balance.
  • INVOICE: Invoice transaction.
Available options:
ALL,
PAYIN,
DEPOSIT,
PAYOUT,
TRANSFER,
CONVERSION,
FEE,
REFUND,
ADJUSTMENT,
INVOICE
Example:

"PAYOUT"

transaction_status
enum<string>

Transaction status.

  • ALL: Represents all possible transaction statuses.
  • COMPLETED: Transaction has been successfully processed and finalized.
  • PENDING: Transaction is currently being processed and awaiting completion.
  • FAILED: Transaction could not be completed due to an error or rejection.
Available options:
ALL,
COMPLETED,
PENDING,
FAILED
Example:

"COMPLETED"

Response

200 - application/json

OK - Balances transactions returned successfully.

total_pages
integer

The total number of pages of available items.

Example:

10

total_items
integer

The total counts of available items.

Example:

105

data
object[]