Skip to main content
POST
/
api
/
v1
/
payouts
/
create
curl 'https://api.sandbox.uqpay.org/api/v1/payouts/create' \
-H 'content-type: application/json' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG' \
--data-raw '{"currency":"SGD","amount":"50","payout_reason":"test","payout_reference":"test","payment_date":"2023-09-13","beneficiary_id":"83c43be5-44f0-4fb1-aa1a-ba8b05f3a3e5","is_payer":"Y","payer_id":"0"}'

{
  "code": 200,
  "message": "Success",
  "data": {
      "amount": "100",
      "beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
      "create_time": "2023-10-23T17:49:08.090161+08:00",
      "currency": "USD",
      "id": "80f11927-ad7f-4182-817b-629a470330c3",
      "payer_id": "0",
      "payment_date": "2023-10-23T00:00:00+08:00",
      "reason": "test payout",
      "reference": "test payout",
      "short_reference": "P231023-TBPQBNDP",
      "status": "processing",
      "unique_request_id": "fdf26c91-27a1-42bb-9654-a69c744b3b34",
      "update_time": "2023-10-23T17:49:08.090161+08:00"
  }
}
​
x-client-id
string
required
x-client-id.
​
x-auth-token
string
required
Bearer YOUR_TOKEN_HERE.

​
Parameters

​
currency
string
required
Currency of the account balance.
Three-letter ISO 4217 currency code.
​
amount
string
required
Amount to be paid.
​
payout_reason
string
required
Reason for the payment instruction.
​
payout_reference
string
Bank payment reference to be shown on beneficiary’s bank transaction history.
​
payment_date
string
required
Date when payment should be made.
Format: YYYY-MM-DD
​
beneficiary_id
string
required
ID of the beneficiary.
​
is_payer
string
required
Whether the current user is a payer.
One of Y, N
​
payer_id
string
ID of the payer.
​
entity_type
string
Payer’s entity type.
One of individual, company
​
company_name
string
Payer’s company name.
required, if entity_type = company
​
first_name
string
Payer’s first name.
required, if entity_type = individual
​
last_name
string
Payer’s last name.
required, if entity_type = individual
​
birth_date
string
Payer’s date of birth.
Format: YYYY-MM-DD
required, if entity_type = individual
​
country
string
Payer’s country.
Two-letter ISO 3166-2 country code.
​
address
string
Payer’s address.
​
city
string
Payer’s city.
​
state_or_province
string
Payer’s state or province.
​
postal_code
string
Payer’s postal code.
​
identification_type
string
Payer’s identification type. Depends on the value of entity_type.
entity_typeidentification_type
individualOne of passport, drivers_license, national_id
companyOnly incorporation_number
​
identification_value
string
Payer’s identification value.

​
Response

​
code
number
Indicates whether the call was successful. 200 if successful, 400 if not.
​
message
string
Response Message. “Success” if successful, others not.
curl 'https://api.sandbox.uqpay.org/api/v1/payouts/create' \
-H 'content-type: application/json' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG' \
--data-raw '{"currency":"SGD","amount":"50","payout_reason":"test","payout_reference":"test","payment_date":"2023-09-13","beneficiary_id":"83c43be5-44f0-4fb1-aa1a-ba8b05f3a3e5","is_payer":"Y","payer_id":"0"}'

{
  "code": 200,
  "message": "Success",
  "data": {
      "amount": "100",
      "beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
      "create_time": "2023-10-23T17:49:08.090161+08:00",
      "currency": "USD",
      "id": "80f11927-ad7f-4182-817b-629a470330c3",
      "payer_id": "0",
      "payment_date": "2023-10-23T00:00:00+08:00",
      "reason": "test payout",
      "reference": "test payout",
      "short_reference": "P231023-TBPQBNDP",
      "status": "processing",
      "unique_request_id": "fdf26c91-27a1-42bb-9654-a69c744b3b34",
      "update_time": "2023-10-23T17:49:08.090161+08:00"
  }
}