Create Beneficiary

Note: The sample payloads below are for reference only. All bank account details, account numbers, and other information shown in these examples are mock data and should not be used for actual transactions.

COMPANY-USD-SWIFT

{
    "entity_type": "COMPANY",
    "company_name": "UQPAY TECHNOLOGY",
    "payment_method": "SWIFT",
    "bank_details": {
        "bank_name": "Bank of America",
        "bank_address": "123 Main St",
        "bank_country_code": "US",
        "account_holder": "John Doe",
        "account_currency_code": "USD",
        "clearing_system": "SWIFT",
        "swift_code": "WELGBE22",
        "account_number": "12345678222"
    },
    "address": {
        "country": "US",
        "city": "CA",
        "street_address": "123 Main St",
        "postal_code": "123456",
        "state": "CA"
    }
}

COMPANY-USD-LOCAL ACH

{
    "entity_type": "COMPANY",
    "company_name": "UQPAY TECHNOLOGY",
    "payment_method": "LOCAL",
    "bank_details": {
        "bank_name": "Bank of America",
        "bank_address": "123 Main St",
        "bank_country_code": "US",
        "account_holder": "John Doe",
        "account_currency_code": "USD",
        "clearing_system": "ACH",
        "swift_code": "WELGBE22",
        "account_number": "777888123",
        "routing_code_type1": "ach",
        "routing_code_value1": "123456"
    },
    "address": {
        "country": "US",
        "city": "CA",
        "street_address": "123 Main St",
        "postal_code": "123456",
        "state": "CA"
    }
}

COMPANY-CNH-SWIFT

Notes:

The cnaps_number refers to the China National Advanced Payment System Number. You can look it up here.
The additional_info.organization_code field applies to companies registered in Mainland China and must contain the Unified Social Credit Code.

{
    "entity_type": "COMPANY",
    "company_name": "实力（杭州）无限公司",
    "payment_method": "SWIFT",
    "bank_details": {
        "bank_name": "农业银行",
        "bank_address": "浙江省杭州市",
        "bank_country_code": "CN",
        "account_holder": "张三",
        "account_currency_code": "CNH",
        "clearing_system": "LOCAL",
        "swift_code": "WELGBE22",
        "account_number": "777888223",
        "routing_code_type1": "cnaps_number",
        "routing_code_value1": "103331000015"
    },
    "address": {
        "country": "CN",
        "city": "Hangzhou",
        "street_address": "123 Main St",
        "postal_code": "123456",
        "state": "Hangzhou"
    },
    "additional_info": {
        "organization_code": "91210106MA0P46BWXY"
    }
}

INDIVIDUAL-THB-SWIFT

{
    "entity_type": "INDIVIDUAL",
    "first_name": "John",
    "last_name": "Doe",
    "payment_method": "SWIFT",
    "bank_details": {
        "bank_name": "The Currency Cloud Limited",
        "bank_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
        "bank_country_code": "TH",
        "account_holder": "UQPAY PTE. LTD.",
        "account_currency_code": "THB",
        "clearing_system": "SWIFT",
        "swift_code": "BKKBTHBKXXX",
        "account_number": "12345678901"
    },
    "address": {
        "country": "TH",
        "city": "Bangkok",
        "street_address": "123 Main St",
        "postal_code": "10310",
        "state": "Bangkok"
    }
}

INDIVIDUAL-EUR-SWIFT

Notes:

For most European countries and certain others, the IBAN field is mandatory. For a detailed list, refer to the field description in the API documentation.

{
    "entity_type": "INDIVIDUAL",
    "first_name": "John",
    "last_name": "Doe",
    "payment_method": "SWIFT",
    "bank_details": {
        "bank_name": "BNP Paribas",
        "bank_address": "16 Boulevard des Italiens, 75009 Paris, France",
        "bank_country_code": "FR",
        "account_holder": "John Doe",
        "account_currency_code": "EUR",
        "clearing_system": "SWIFT",
        "swift_code": "BNPAFRPPXXX",
        "iban": "FR7630004000031234567890143"
    },
    "address": {
        "country": "FR",
        "city": "Paris",
        "street_address": "25 Rue de la Paix",
        "postal_code": "75002",
        "state": "Île-de-France"
    }
}