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' \
-H 'x-request-id: Up2sIsjiETPXLy7gON9PMG' \
--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": {
        "payout_id": "765fc9ea-088e-468a-85bc-949b48c42663"
    }
}
​
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.

​
purpose_code
string
required

Purpose code of transfer .

Purpose codedirection
audio_visual_servicesAudiovisual services
bill_paymentBill payment
business_expensesBusiness expenses
constructionConstruction
donation_charitable_contributionDonation/charitable contribution
education_trainingEducation/training
family_supportFamily support
freightFreight
goods_purchasedGoods purchased
investment_capitalInvestment capital
investment_proceedsInvestment proceeds
living_expensesLiving expenses
loan_credit_repaymentLoan/credit repayment
medical_servicesMedical services
pensionPension
personal_remittancePersonal remittance
professional_business_servicesProfessional/business services
real_estateReal estate
taxesTaxes
technical_servicesTechnical services
transfer_to_own_accountTransfer to own account
travelTravel
wages_salaryWages/salary
other_servicesOther services
​
payout_reference
string
required

Bank payment reference to be shown on beneficiary’s bank transaction history.

​
charge_type
string
required

Charge type of transfer . One of shared, ours

​
payment_date
string
required

Date when payment should be made.
Format: YYYY-MM-DD

​
beneficiary_id
string

ID of the beneficiary.Use this interface to query List all beneficiaries.

​
is_payer
string
required

Whether the current user is a payer.
One of Y, N

​
payer_id
string

ID of the payer. If is_payer is Y, payer_id is empty, if is_payer is N, payer_id is required. payer_id is queried from this interface Get list of payers.

​
entity_type
string

This field is required when is_payer = N.
Payer’s entity type.
One of individual, company

​
company_name
string

Payer’s company name.
This field is required when entity_type = company

​
first_name
string

Payer’s first name.
This field is required when entity_type = individual

​
last_name
string

Payer’s last name.
This field is required when entity_type = individual

​
birth_date
string

Payer’s date of birth.
Format: YYYY-MM-DD
This field is required when entity_type = individual

​
country
string

This field is required when is_payer = N.
Payer’s country.
Two-letter ISO 3166-2 country code.

​
address
string

This field is required when is_payer = N.
Payer’s address.

​
city
string

This field is required when is_payer = N.
Payer’s city.

​
state_or_province
string

This field is required when is_payer = N.
Payer’s state or province.

​
postal_code
string

This field is required when is_payer = N.
Payer’s postal code.

​
identification_type
string

This field is required when is_payer = N.
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

This field is required when is_payer = N.
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.

​
data
object
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' \
-H 'x-request-id: Up2sIsjiETPXLy7gON9PMG' \
--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": {
        "payout_id": "765fc9ea-088e-468a-85bc-949b48c42663"
    }
}