Skip to main content
GET
/
api
/
v1
/
payouts
curl 'https://api.sandbox.uqpay.org/api/v1/payouts?page_num=1&page_size=10&date_type=create_time' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
"code": 200,
"message": "Success",
"data": {
    "total_item": 9,
    "total_page": 1,
    "item_list": [
        {
            "payout_id": "f62e97a4-695d-4efb-bf76-40cb53471be6",
            "reference_id": "P231023-UHLWIV9N",
            "payment_date": "2023-10-23",
            "payout_status": "processing",
            "payout_reason": "test payout",
            "payout_reference": "test payout",
            "beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
            "beneficiary_name": "AYALILI",
            "unique_request_id": "fdf26c91-27a1-42bb-9654-a69c744b3b34",
            "amount": "100",
            "fee_amount": "15",
            "currency": "USD",
            "fee_paid_by": "shared",
            "create_time": "2023-10-23T22:05:22+08:00",
            "update_time": "2023-10-23T22:05:24+08:00",
            "complete_time": "0001-01-01T00:00:00Z"
        },
        {
            "payout_id": "80f11927-ad7f-4182-817b-629a470330c3",
            "reference_id": "P231023-TBPQBNDP",
            "payment_date": "2023-10-23",
            "payout_status": "processing",
            "payout_reason": "test payout",
            "payout_reference": "test payout",
            "beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
            "beneficiary_name": "AYALILI",
            "unique_request_id": "fdf26c91-27a1-42bb-9654-a69c744b3b34",
            "amount": "100",
            "fee_amount": "15",
            "currency": "USD",
            "fee_paid_by": "shared",
            "create_time": "2023-10-23T17:49:08+08:00",
            "update_time": "2023-10-23T17:49:14+08:00",
            "complete_time": "0001-01-01T00:00:00Z"
        }
    ]
}
}
​
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 50
​
scope
string
Filter on scope.
One of house_account, clients_account
​
reference_id
string
Exact search by short ID of the payout.
Maximum Length 36
​
currency
string
Currency of the payout.
Three-letter ISO 4217 currency code.
​
status
string
Filter on status of the payout.
One of awaiting_funds, trade_settled, closed, funds_arrived
​
date_type
string
Filter on date type.
One of settle_time, create_time
​
start_time
number
The starting value for specifying a date range for results to be returned.
​
end_time
number
The ending value for specifying a date range for results to be returned.

​
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/payouts?page_num=1&page_size=10&date_type=create_time' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
"code": 200,
"message": "Success",
"data": {
    "total_item": 9,
    "total_page": 1,
    "item_list": [
        {
            "payout_id": "f62e97a4-695d-4efb-bf76-40cb53471be6",
            "reference_id": "P231023-UHLWIV9N",
            "payment_date": "2023-10-23",
            "payout_status": "processing",
            "payout_reason": "test payout",
            "payout_reference": "test payout",
            "beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
            "beneficiary_name": "AYALILI",
            "unique_request_id": "fdf26c91-27a1-42bb-9654-a69c744b3b34",
            "amount": "100",
            "fee_amount": "15",
            "currency": "USD",
            "fee_paid_by": "shared",
            "create_time": "2023-10-23T22:05:22+08:00",
            "update_time": "2023-10-23T22:05:24+08:00",
            "complete_time": "0001-01-01T00:00:00Z"
        },
        {
            "payout_id": "80f11927-ad7f-4182-817b-629a470330c3",
            "reference_id": "P231023-TBPQBNDP",
            "payment_date": "2023-10-23",
            "payout_status": "processing",
            "payout_reason": "test payout",
            "payout_reference": "test payout",
            "beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
            "beneficiary_name": "AYALILI",
            "unique_request_id": "fdf26c91-27a1-42bb-9654-a69c744b3b34",
            "amount": "100",
            "fee_amount": "15",
            "currency": "USD",
            "fee_paid_by": "shared",
            "create_time": "2023-10-23T17:49:08+08:00",
            "update_time": "2023-10-23T17:49:14+08:00",
            "complete_time": "0001-01-01T00:00:00Z"
        }
    ]
}
}