Skip to main content
POST
https://api.sandbox.uqpay.org
/
api
/
v1
/
beneficiaries
/
{beneficiary_id}
/
update
curl 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/ee51860a-9441-4bf8-93b6-6309b3244734/update' \
-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"
}
​
x-client-id
string
required
x-client-id.
​
x-auth-token
string
required
Bearer YOUR_TOKEN_HERE.

​
Parameters

​
bank_country
string
required
Two-letter ISO 3166-2 country code.
​
account_currency
string
required
Three-letter ISO 4217 currency code.
​
entity_type
string
required
Entity type of the beneficiary.
One of individual, company
​
email
string
required
Email of the beneficiary.
​
nickname
string
required
Nickname of the beneficiary.
Maximum length 120
​
first_name
string
First name of the beneficiary.
Maximum length 45
​
last_name
string
Last name of the beneficiary.
Maximum length 45
​
company_name
string
Company name of the beneficiary.
Maximum length 120
​
payment_method
string
required
Payment method of the beneficiary.
One of local, swift
​
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
​
country_code
string
required
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
Street address of the beneficiary.
Maximum length 255
​
postal_code
string
required
Postal code of the beneficiary.
Maximum length 12
​
clearing_system
string
required
Clearing system.
Maximum length 30
​
account_number
string
required
Number of the account this beneficiary is associated with.
Maximum length 60
​
swift_code
string
Swift code.
Maximum length 30

​
Response

​
code
number
Indicates whether the call was successful. 200 if successful, 400 if not.
​
message
string
Response Message. “Success” if successful, others not.
curl 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/ee51860a-9441-4bf8-93b6-6309b3244734/update' \
-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"
}