Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Beneficiaries

Create Beneficiary

Create a new beneficiary for payout.

post/v1/beneficiaries

Headers

x-on-behalf-ofstring

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 API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring uuid

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.

Request body

OR

Example request

{
  "entity_type": "COMPANY",
  "email": "example@uqpay.com",
  "company_name": "UQPAY TECHNOLOGY SG PTE LTD",
  "payment_method": {
    "card": {
      "billing": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "phone_number": "12025550123",
        "address": {
          "country_code": "SG",
          "city": "Singapore",
          "street": "444 Orchard Rd, Midpoint Orchard, Singapore ",
          "postcode": "924011"
        }
      }
    }
  },
  "nickname": "John Doe",
  "bank_details": {
    "bank_name": "Bank of America",
    "bank_address": "123 Main St",
    "bank_country_code": "SG",
    "account_holder": "John Doe",
    "account_number": "12345678",
    "iban": "GB82 WEST 1234 5698 7654 32",
    "swift_code": "WELGBE22",
    "clearing_system": "GIRO",
    "routing_code_type1": "aba",
    "routing_code_value1": "123456789",
    "routing_code_type2": "ach",
    "routing_code_value2": "123456789"
  },
  "address": {
    "country": "SG",
    "nationality": "SG",
    "city": "Singapore",
    "street_address": "123 Main St",
    "postal_code": "123456",
    "state": "CA"
  },
  "additional_info": {
    "organization_code": "91210106MA0P46BWXY",
    "id_type": "PASSPORT",
    "id_number": "AB1234567",
    "tax_id": "123456789",
    "msisdn": "+65111111"
  }
}

Response

Beneficiary creation successfully.

beneficiary_idstring uuid

Universally unique identifier (UUID v4) of the beneficiary.

short_reference_idstring

The reference generated by the system to identify the entity.

Example response

{
  "beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
  "short_reference_id": "P220406-LLCVLRM"
}