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"
}
]
}
}
Balances
List all transactions
List all transactions related to the account.
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"
}
]
}
}
Header
string
required
x-client-id.string
required
Bearer
YOUR_TOKEN_HERE.Parameters
number
required
Page number, starts from 1.
number
required
Number of results per page.
Maximum 100string
Filter on scope.
One of
One of
house_account, clients_accountstring
Associated original order (Short order ID)
string
Transaction type.
| Value | Description |
|---|---|
payin | Transaction payin |
payout | Transaction payout |
deposit | Transaction deposit |
transfer | Transaction payout |
conversion | Transaction convert |
card fee | Card fee |
card charge | Card charge |
fee | Fee |
adjustment | Adjustment |
string
Status of the transaction.
| Value | Description |
|---|---|
-1 | failed |
0 | pending |
1 | completed |
2 | cancelled |
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.number
Start timestamps for different
Date Types.number
End timestamps for different
Date Types. The time span range does not exceed 30 days.Response
number
Indicates whether the call was successful. 200 if successful, 400 if not.
string
Response Message. “Success” if successful, others not.
object
Hide details
Hide details
number
Total items.
number
Total pages.
array
Hide details
Hide details
string
Transaction id
string
Account’name
string
One of Transaction type.
| Value | Description |
|---|---|
payin | Transaction payin |
payout | Transaction payout |
deposit | Transaction deposit |
transfer | Transaction payout |
conversion | Transaction convert |
card fee | Card fee |
card charge | Card charge |
fee | Fee |
adjustment | Adjustment |
string
Total amount of transaction
string
The time when the transaction was created at
string
The time when the transaction was settled at
string
The time when the transaction was completed at
string
One of the transaction status.
failed,pending,completed,cancelledstring
Associated original order (Long order ID)
string
Associated original order (Short order ID)
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"
}
]
}
}