Skip to main content
GET
/
api
/
v1
/
transactions
  curl 'https://api.sandbox.uqpay.org/api/v1/transactions' \
    -H 'authority: api.sandbox.uqpay.org' \
    -H 'x-auth-token: Your Token ' \
    -H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
    "code": 200,
    "message": "Success",
    "data": {
        "total_item": 1,
        "total_page": 1,
        "item_list": [
            {
                "transaction_id": "24a97271-c018-4d51-8313-1b1b2a024dcf",
                "account_name": "Cooper's account",
                "transaction_type": "conversion",
                "currency": "SGD",
                "amount": "100",
                "create_time": "2023-09-07T10:19:15+08:00",
                "settle_time": "2023-09-07T10:19:15+08:00",
                "complete_time": "0001-01-01T00:00:00Z",
                "transaction_status": "pending",
                "reference_id": "08e294f1-ecb3-4b7e-b4e3-3fd1e98e5429",
                "short_reference_id": "C230907-YGUJ4DHW"
            }
        ]
    }
}

Documentation Index

Fetch the complete documentation index at: https://docs.uqpay.org/llms.txt

Use this file to discover all available pages before exploring further.

​
x-client-id
string
required
x-client-id.
​
x-auth-token
string
required
Bearer YOUR_TOKEN_HERE.

​
Parameters

​
page_num
number
required
Page number, starts from 1.
​
page_size
number
required
Number of results per page.
Maximum 100
​
scope
string
Filter on scope.
One of house_account, clients_account
​
trans_no
string
Associated original order (Short order ID)
​
trans_type
string
Transaction type.
ValueDescription
payinTransaction payin
payoutTransaction payout
depositTransaction deposit
transferTransaction payout
conversionTransaction convert
card feeCard fee
card chargeCard charge
feeFee
adjustmentAdjustment
​
trans_status
string
Status of the transaction.
ValueDescription
-1failed
0pending
1completed
2cancelled
​
trans_currency
string
Currency of the transaction.
Three-letter ISO 4217 currency code.
​
date_type
string
Date Type is one of create_time settle_time complete_time

create_time : The time When the transaction was created at.
settle_time : The time when the transaction was settled at.
complete_time : The time when the transaction was completed at.
​
start_time
number
Start timestamps for different Date Types.
​
end_time
number
End timestamps for different Date Types. The time span range does not exceed 30 days.

​
Response

​
code
number
Indicates whether the call was successful. 200 if successful, 400 if not.
​
message
string
Response Message. “Success” if successful, others not.
​
data
object
  curl 'https://api.sandbox.uqpay.org/api/v1/transactions' \
    -H 'authority: api.sandbox.uqpay.org' \
    -H 'x-auth-token: Your Token ' \
    -H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
    "code": 200,
    "message": "Success",
    "data": {
        "total_item": 1,
        "total_page": 1,
        "item_list": [
            {
                "transaction_id": "24a97271-c018-4d51-8313-1b1b2a024dcf",
                "account_name": "Cooper's account",
                "transaction_type": "conversion",
                "currency": "SGD",
                "amount": "100",
                "create_time": "2023-09-07T10:19:15+08:00",
                "settle_time": "2023-09-07T10:19:15+08:00",
                "complete_time": "0001-01-01T00:00:00Z",
                "transaction_status": "pending",
                "reference_id": "08e294f1-ecb3-4b7e-b4e3-3fd1e98e5429",
                "short_reference_id": "C230907-YGUJ4DHW"
            }
        ]
    }
}