curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"entity_type": "COMPANY",
"company_name": "UQPAY PTE. LTD.",
"payment_method": "SWIFT",
"nickname": "Contract 452d7f6f",
"email": "[email protected]",
"bank_details": {
"bank_name": "GREEN LINK DIGITAL BANK",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"account_holder": "UQPAY PTE. LTD.",
"account_currency_code": "SGD",
"account_number": "11020075767",
"clearing_system": "SWIFT",
"swift_code": "GLDTSGSGXXX"
},
"address": {
"country": "SG",
"city": "Singapore",
"state": "Singapore",
"street_address": "Sandbox Contract Test",
"postal_code": 18989
}
}
'{
"beneficiary_id": "285d9110-ed8e-4bb3-b206-f0a7d6d4aaeb",
"short_reference_id": "BF260911-OGJMC98L"
}Create Beneficiary
Create a new beneficiary for payout.
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"entity_type": "COMPANY",
"company_name": "UQPAY PTE. LTD.",
"payment_method": "SWIFT",
"nickname": "Contract 452d7f6f",
"email": "[email protected]",
"bank_details": {
"bank_name": "GREEN LINK DIGITAL BANK",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"account_holder": "UQPAY PTE. LTD.",
"account_currency_code": "SGD",
"account_number": "11020075767",
"clearing_system": "SWIFT",
"swift_code": "GLDTSGSGXXX"
},
"address": {
"country": "SG",
"city": "Singapore",
"state": "Singapore",
"street_address": "Sandbox Contract Test",
"postal_code": 18989
}
}
'{
"beneficiary_id": "285d9110-ed8e-4bb3-b206-f0a7d6d4aaeb",
"short_reference_id": "BF260911-OGJMC98L"
}Authorizations
The API token for login provided by UQPAY.
Headers
Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account.
More information at Connected Accounts.
A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.
Body
- Company bank beneficiary
- Individual bank beneficiary
- Company Mastercard beneficiary
- Individual Mastercard beneficiary
The type of beneficiary entity.
"COMPANY"
Company name of the beneficiary, only exist when the entity_type is COMPANY.
-
When
payment_method = SWIFT:- Only English letters, numbers, special characters (half-width format), and spaces can be included.
- Allowed special characters:
-_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……
-
When
payment_method = LOCAL:- No strict validation rules apply, local language characters are supported.
-
No need to pass this field when
bank_details.bank_country_code = SG&bank_details.account_currency_code = SGD -
When
bank_country_code = CN&account_currency_code = CNH&payment_method = LOCAL&entity_type = COMPANY, Chinese characters and Chinese parentheses（）are supported.
120^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$"UQPAY TECHNOLOGY SG PTE LTD"
Payment method for a bank beneficiary.
LOCAL, SWIFT "LOCAL"
Show child attributes
Show child attributes
Address of the beneficiary.
- No need to pass this field when
bank_details.bank_country_code = SG&bank_details.account_currency_code = SGD
Show child attributes
Show child attributes
Email address of the beneficiary.
Nickname of the beneficiary.
120"John Doe"
Additional information for beneficiaries.
Show child attributes
Show child attributes
Response
Beneficiary creation successfully.