Skip to main content
POST
/
v1
/
beneficiaries
Create Beneficiary
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 TECHNOLOGY SG PTE LTD",
  "payment_method": "LOCAL",
  "bank_details": {
    "bank_name": "Bank of America",
    "bank_address": "123 Main St",
    "bank_country_code": "SG",
    "account_holder": "John Doe",
    "account_currency_code": "USD",
    "swift_code": "WELGBE22",
    "clearing_system": "GIRO",
    "account_number": "12345678",
    "iban": "GB82 WEST 1234 5698 7654 32",
    "routing_code_type1": "aba",
    "routing_code_value1": "123456789",
    "routing_code_type2": "ach",
    "routing_code_value2": "123456789"
  },
  "address": {
    "country": "SG",
    "city": "Singapore",
    "street_address": "123 Main St",
    "postal_code": "123456",
    "state": "CA",
    "nationality": "SG"
  },
  "email": "example@uqpay.com",
  "nickname": "John Doe",
  "additional_info": {
    "organization_code": "91210106MA0P46BWXY",
    "proxy_id": "<string>",
    "id_type": "PASSPORT",
    "id_number": "AB1234567",
    "tax_id": "123456789",
    "msisdn": "+65111111"
  }
}
'
{
  "beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
  "short_reference_id": "P220406-LLCVLRM"
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

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.

​
x-idempotency-key
string<uuid>
required

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

application/json
​
entity_type
string
default:COMPANY
required

The type of beneficiary entity.

Example:

"COMPANY"

​
company_name
string
required

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.

Maximum string length: 120
Pattern: ^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$
Example:

"UQPAY TECHNOLOGY SG PTE LTD"

​
payment_method
enum<string>
required

The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.

Available options:
LOCAL,
SWIFT
Example:

"LOCAL"

​
bank_details
object
required
​
address
object
required

Address of the beneficiary.

  • No need to pass this field when bank_details.bank_country_code = SG & bank_details.account_currency_code = SGD
​
email
string

Email address of the beneficiary.

Example:

"example@uqpay.com"

​
nickname
string

Nickname of the beneficiary.

Maximum string length: 120
Example:

"John Doe"

​
additional_info
object

Additional information for beneficiaries.

Response

Beneficiary creation successfully.

​
beneficiary_id
string<uuid>

Universally unique identifier (UUID v4) of the beneficiary.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

​
short_reference_id
string

The reference generated by the system to identify the entity.

Example:

"P220406-LLCVLRM"