Create a beneficiary

POST

api

beneficiaries

create

curl 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/create' \
-H 'content-type: application/json' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG' \
--data-raw '{"bank_country":"US","account_currency":"USD","entity_type":"company","email":"[email protected]","nickname":"MANY A-SUN","first_name":"","last_name":"","company_name":"Courtesy Hardware Store","payment_method":"swift","bank_name":"1ST STATE BANK","bank_address":"4929 Briarwood Drive","account_holder":"Robert Shishani","country_code":"US","city":"Montgomery","state":"Alabama","address":"1230 Stafford Dr","postal_code":"36117","clearing_system":"SWIFT","account_number":"4865393923574557","swift_code":"230"}'

{
  "code": 200,
  "message": "Success",
  "data": {
      "beneficiary_id": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "account_currency_code": "SGD",
      "account_number": "33990319141",
      "bank_country_code": "SG",
      "beneficiary_address": "{\"country_code\":\"SG\",\"city\":\"singapore\",\"street_address\":\"7 Burn Road #07-07 Trivex Singapore 413577\",\"postal_code\":\"413577\",\"state\":\"singapore\"}",
      "beneficiary_bank_details": "{\"bank_name\":\"test bank name\",\"bank_address\":\"test bank address\",\"bank_country_code\":\"SG\",\"account_holder\":\"zuuzj\",\"account_currency_code\":\"SGD\",\"account_number\":\"33990319141\",\"iban\":\"\",\"swift_code\":\"UOVBSGSG\",\"clearing_system\":\"local\",\"routing_code_type1\":\"\",\"routing_code_value1\":\"\",\"routing_code_type2\":\"\",\"routing_code_value2\":\"\"}",
      "beneficiary_company_name": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "beneficiary_entity_type": "individual",
      "beneficiary_first_name": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "beneficiary_last_name": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "beneficiary_email": "[email protected]",
      "beneficiary_nickname": "zuuj88",
      "payment_method": "local",
      "beneficiary_status": "pending"
  }
}

x-client-id

string

required

x-client-id.

x-auth-token

string

required

Bearer YOUR_TOKEN_HERE.

Parameters

bank_country

string

required

Account bank country code of the beneficiary.
Two-letter ISO 3166-2 country code.

account_currency

string

required

Account currency code of the beneficiary.
Three-letter ISO 4217 currency code.

entity_type

string

required

Entity type of the beneficiary.
One of company, individual

string

required

Email of the beneficiary.

nickname

string

required

A nickname for the beneficiary.
Maximum length 120

first_name

string

Required if “entity_type” is “individual”.
First name of the beneficiary.
Maximum length 45

last_name

string

Required if “entity_type” is “individual”. Last name of the beneficiary.
Maximum length 45

company_name

string

Required if “entity_type” is “company”.
Company names cannot consist entirely of numbers.
Maximum length 120

payment_method

string

required

Payment method of the beneficiary.
One of local, swift.
It is related to clearing_system, and the relationship can be obtained from this interface Get a list of payment methods.

bank_name

string

required

Bank name of the beneficiary’s bank account.
Maximum length 240

bank_address

string

required

Bank street address.
Maximum length 240

account_holder

string

required

Account holder name of the beneficiary’s bank account.
Maximum length 36

account_number

string

Bank account number.
Maximum length 60
If iban is not required, account_number is required.

iban

string

International bank account number, mostly for european countries.
speaCountrys:AD,AT,BE,BG,CY,HR,CZ,DK,EE,FI,FR,DE,GR,HU,IS,IE,IT,LV,LI,LT,LU,MT,MC,NL,NO,PL,PT,RO,SM,SK,SI,ES,SE,CH,GB,VA
speaCurrency:EUR,USD
If the country and currency are in the above list, the iban is required.

swift_code

string

BIC/SWIFT code
Maximum length 30

clearing_system

string

Which clearing system should be used for this beneficiary.
Maximum length 30
It is related to payment_method, and the relationship can be obtained from this interface Get a list of payment methods.

routing_code_type1

string

Routing code type.
When the validation_field value of Get a list of payment methods does not find the corresponding field in the input parameter list, the field name is put into routing_code_type1 and the value is put into the corresponding routing_code_value1.

routing_code_value1

string

Routing code value.
Routing code for routing_code_type_1.
If supplied, routing_code_type_1 should also be supplied.

routing_code_type2

string

Routing code sub type.
When the validation_field value of Get a list of payment methods does not find the corresponding field in the input parameter list, the field name is put into routing_code_type2 and the value is put into the corresponding routing_code_value2.

routing_code_value2

string

Routing code sub type value.
Routing code for routing_code_type_2.
If supplied, routing_code_type_2 should also be supplied.

country_code

string

required

Country code of the beneficiary
Two-letter ISO 3166-2 country code.

city

string

required

City of the beneficiary.
Maximum length 36

state

string

required

State of the beneficiary.
Maximum length 96

address

string

required

Address of the beneficiary.
Maximum length 255

postal_code

string

required

Postal code of the beneficiary.
Maximum length 12

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

beneficiary_id

string

Beneficiary UUID.

entity_type

string

Entity type of the beneficiary.
One of company, individual

payment_method

string

The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.
One of local, swift

beneficiary_email

string

Email of the beneficiary.

beneficiary_nickname

string

Nickname of the beneficiary.

beneficiary_company_name

string

Company name of the beneficiary.

account_currency_code

string

Account currency code.
Three-letter ISO 4217 currency code.

bank_country_code

string

Bank country code.
Two-letter ISO 3166-2 country code.

beneficiary_first_name

string

First name of the beneficiary.

beneficiary_last_name

string

Last name of the beneficiary.

beneficiary_bank_details

object

Beneficiary’s bank account details where the payment will be credited.

beneficiary_address

object

Beneficiary’s address details.

curl 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/create' \
-H 'content-type: application/json' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG' \
--data-raw '{"bank_country":"US","account_currency":"USD","entity_type":"company","email":"[email protected]","nickname":"MANY A-SUN","first_name":"","last_name":"","company_name":"Courtesy Hardware Store","payment_method":"swift","bank_name":"1ST STATE BANK","bank_address":"4929 Briarwood Drive","account_holder":"Robert Shishani","country_code":"US","city":"Montgomery","state":"Alabama","address":"1230 Stafford Dr","postal_code":"36117","clearing_system":"SWIFT","account_number":"4865393923574557","swift_code":"230"}'

{
  "code": 200,
  "message": "Success",
  "data": {
      "beneficiary_id": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "account_currency_code": "SGD",
      "account_number": "33990319141",
      "bank_country_code": "SG",
      "beneficiary_address": "{\"country_code\":\"SG\",\"city\":\"singapore\",\"street_address\":\"7 Burn Road #07-07 Trivex Singapore 413577\",\"postal_code\":\"413577\",\"state\":\"singapore\"}",
      "beneficiary_bank_details": "{\"bank_name\":\"test bank name\",\"bank_address\":\"test bank address\",\"bank_country_code\":\"SG\",\"account_holder\":\"zuuzj\",\"account_currency_code\":\"SGD\",\"account_number\":\"33990319141\",\"iban\":\"\",\"swift_code\":\"UOVBSGSG\",\"clearing_system\":\"local\",\"routing_code_type1\":\"\",\"routing_code_value1\":\"\",\"routing_code_type2\":\"\",\"routing_code_value2\":\"\"}",
      "beneficiary_company_name": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "beneficiary_entity_type": "individual",
      "beneficiary_first_name": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "beneficiary_last_name": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "beneficiary_email": "[email protected]",
      "beneficiary_nickname": "zuuj88",
      "payment_method": "local",
      "beneficiary_status": "pending"
  }
}

List all beneficiaries Update a beneficiary

curl 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/create' \
-H 'content-type: application/json' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG' \
--data-raw '{"bank_country":"US","account_currency":"USD","entity_type":"company","email":"[email protected]","nickname":"MANY A-SUN","first_name":"","last_name":"","company_name":"Courtesy Hardware Store","payment_method":"swift","bank_name":"1ST STATE BANK","bank_address":"4929 Briarwood Drive","account_holder":"Robert Shishani","country_code":"US","city":"Montgomery","state":"Alabama","address":"1230 Stafford Dr","postal_code":"36117","clearing_system":"SWIFT","account_number":"4865393923574557","swift_code":"230"}'

{
  "code": 200,
  "message": "Success",
  "data": {
      "beneficiary_id": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "account_currency_code": "SGD",
      "account_number": "33990319141",
      "bank_country_code": "SG",
      "beneficiary_address": "{\"country_code\":\"SG\",\"city\":\"singapore\",\"street_address\":\"7 Burn Road #07-07 Trivex Singapore 413577\",\"postal_code\":\"413577\",\"state\":\"singapore\"}",
      "beneficiary_bank_details": "{\"bank_name\":\"test bank name\",\"bank_address\":\"test bank address\",\"bank_country_code\":\"SG\",\"account_holder\":\"zuuzj\",\"account_currency_code\":\"SGD\",\"account_number\":\"33990319141\",\"iban\":\"\",\"swift_code\":\"UOVBSGSG\",\"clearing_system\":\"local\",\"routing_code_type1\":\"\",\"routing_code_value1\":\"\",\"routing_code_type2\":\"\",\"routing_code_value2\":\"\"}",
      "beneficiary_company_name": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "beneficiary_entity_type": "individual",
      "beneficiary_first_name": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "beneficiary_last_name": "00dcbdb4-3642-424d-88bf-76629efaa168",
      "beneficiary_email": "[email protected]",
      "beneficiary_nickname": "zuuj88",
      "payment_method": "local",
      "beneficiary_status": "pending"
  }
}

API OVERVIEW

CORE

ISSUING

PAYOUT

Webhooks

Create a beneficiary

Header

Parameters

Response

API OVERVIEW

CORE

ISSUING

PAYOUT

Webhooks

​Header

​Parameters

​Response

Header

Parameters

Response