curl 'https://api.sandbox.uqpay.org/api/v1/payouts/d4bfcc79-24a5-4e03-9e2a-d70fd1e3e572/retrieve' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
{
"code": 200,
"message": "Success",
"data": {
"amount": "100",
"beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
"complete_time": "0001-01-01T00:00:00Z",
"create_time": "2023-10-23T17:49:08+08:00",
"currency": "USD",
"fee_amount": "15",
"fee_paid_by": "shared",
"payer_id": "0",
"payout_date": "2023-10-23",
"payout_id": "80f11927-ad7f-4182-817b-629a470330c3",
"payout_reason": "test payout",
"payout_reference": "test payout",
"payout_status": "processing",
"short_reference_id": "P231023-TBPQBNDP",
"unique_request_id": "fdf26c91-27a1-42bb-9654-a69c744b3b34",
"update_time": "2023-10-23T17:49:14+08:00"
}
}
Payout
Retrieve a payout by id
This endpoint returns a payout based on the id.
GET
/
api
/
v1
/
payouts
/
{payout_id}
/
retrieve
curl 'https://api.sandbox.uqpay.org/api/v1/payouts/d4bfcc79-24a5-4e03-9e2a-d70fd1e3e572/retrieve' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
{
"code": 200,
"message": "Success",
"data": {
"amount": "100",
"beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
"complete_time": "0001-01-01T00:00:00Z",
"create_time": "2023-10-23T17:49:08+08:00",
"currency": "USD",
"fee_amount": "15",
"fee_paid_by": "shared",
"payer_id": "0",
"payout_date": "2023-10-23",
"payout_id": "80f11927-ad7f-4182-817b-629a470330c3",
"payout_reason": "test payout",
"payout_reference": "test payout",
"payout_status": "processing",
"short_reference_id": "P231023-TBPQBNDP",
"unique_request_id": "fdf26c91-27a1-42bb-9654-a69c744b3b34",
"update_time": "2023-10-23T17:49:14+08:00"
}
}
Header
string
required
x-client-id.string
required
Bearer
YOUR_TOKEN_HERE.Parameters
string
required
ID of the payout.
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
string
Payout id.
string
Payout amount.
string
Payout currency.
string
Fee paid by.
string
Payout date
string
Payout reason.
string
Payout reference.
string
Fee amount.
string
Payout status.
string
Short reference id.
string
User-generated idempotency key.
string
Complete time.
string
Update time.
string
Create time.
curl 'https://api.sandbox.uqpay.org/api/v1/payouts/d4bfcc79-24a5-4e03-9e2a-d70fd1e3e572/retrieve' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
{
"code": 200,
"message": "Success",
"data": {
"amount": "100",
"beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
"complete_time": "0001-01-01T00:00:00Z",
"create_time": "2023-10-23T17:49:08+08:00",
"currency": "USD",
"fee_amount": "15",
"fee_paid_by": "shared",
"payer_id": "0",
"payout_date": "2023-10-23",
"payout_id": "80f11927-ad7f-4182-817b-629a470330c3",
"payout_reason": "test payout",
"payout_reference": "test payout",
"payout_status": "processing",
"short_reference_id": "P231023-TBPQBNDP",
"unique_request_id": "fdf26c91-27a1-42bb-9654-a69c744b3b34",
"update_time": "2023-10-23T17:49:14+08:00"
}
}
⌘I