API OVERVIEW
CORE
- Auth
- Balances
ISSUING
- Cards
- Products
- Cardholders
- Transactions
PAYOUT
Webhooks
- Payout
- Beneficiary
Retrieve a beneficiary by id
This endpoint returns a beneficiary based on the id.
curl 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/c45a4e8e-5969-4609-8218-091f5db7287e' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
{
"code": 200,
"message": "Success",
"data": {
"beneficiary_id": "c45a4e8e-5969-4609-8218-091f5db7287e",
"entity_type": "company",
"payment_method": "swift",
"beneficiary_email": "[email protected]",
"beneficiary_nickname": "MANY A-SUN",
"beneficiary_company_name": "Courtesy Hardware Store",
"beneficiary_summary": "USD account ending in 4557",
"account_currency_code": "USD",
"bank_country_code": "US",
"beneficiary_bank_details": {
"bank_name": "1ST STATE BANK",
"bank_address": "4929 Briarwood Drive",
"bank_country_code": "US",
"account_holder": "Robert Shishani",
"account_currency_code": "USD",
"account_number": "4865393923574557",
"iban": "",
"swift_code": "230",
"clearing_system": "SWIFT",
"routing_code_type1": "",
"routing_code_value1": "",
"routing_code_type2": "",
"routing_code_value2": ""
},
"beneficiary_address": {
"country_code": "US",
"city": "Montgomery",
"street_address": "1230 Stafford Dr",
"postal_code": "36117",
"state": "Alabama"
}
}
}
Header
x-client-id.
Bearer YOUR_TOKEN_HERE.
Parameters
ID of the beneficiary.
Response
Indicates whether the call was successful. 200 if successful, 400 if not.
Response Message. “Success” if successful, others not.
ID of the beneficiary.
Entity type of the beneficiary.
One of company, individual
The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method. This is required for timely and accurate delivery of funds to the beneficiary account.
Email of the beneficiary.
Nickname of the beneficiary.
Company name of the beneficiary.
Summary of the beneficiary.
Bank country code.
Two-letter ISO 3166-2 country code.
First name of the beneficiary.
Last name of the beneficiary.
Beneficiary’s bank account details where the payment will be credited.
Bank name of the beneficiary’s bank account.
Bank street address.
Bank country code.
Two-letter ISO 3166-2 country code.
Account holder name of the beneficiary’s bank account.
Number of the account this beneficiary is associated with.
International bank account number, mostly for european countries.
Bank swift code.
Supported clearing systems to remit incoming funds to the account.
Routing code type.
Routing code value.
Routing code sub type.
Routing code sub type value.
curl 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/c45a4e8e-5969-4609-8218-091f5db7287e' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
{
"code": 200,
"message": "Success",
"data": {
"beneficiary_id": "c45a4e8e-5969-4609-8218-091f5db7287e",
"entity_type": "company",
"payment_method": "swift",
"beneficiary_email": "[email protected]",
"beneficiary_nickname": "MANY A-SUN",
"beneficiary_company_name": "Courtesy Hardware Store",
"beneficiary_summary": "USD account ending in 4557",
"account_currency_code": "USD",
"bank_country_code": "US",
"beneficiary_bank_details": {
"bank_name": "1ST STATE BANK",
"bank_address": "4929 Briarwood Drive",
"bank_country_code": "US",
"account_holder": "Robert Shishani",
"account_currency_code": "USD",
"account_number": "4865393923574557",
"iban": "",
"swift_code": "230",
"clearing_system": "SWIFT",
"routing_code_type1": "",
"routing_code_value1": "",
"routing_code_type2": "",
"routing_code_value2": ""
},
"beneficiary_address": {
"country_code": "US",
"city": "Montgomery",
"street_address": "1230 Stafford Dr",
"postal_code": "36117",
"state": "Alabama"
}
}
}
curl 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/c45a4e8e-5969-4609-8218-091f5db7287e' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
{
"code": 200,
"message": "Success",
"data": {
"beneficiary_id": "c45a4e8e-5969-4609-8218-091f5db7287e",
"entity_type": "company",
"payment_method": "swift",
"beneficiary_email": "[email protected]",
"beneficiary_nickname": "MANY A-SUN",
"beneficiary_company_name": "Courtesy Hardware Store",
"beneficiary_summary": "USD account ending in 4557",
"account_currency_code": "USD",
"bank_country_code": "US",
"beneficiary_bank_details": {
"bank_name": "1ST STATE BANK",
"bank_address": "4929 Briarwood Drive",
"bank_country_code": "US",
"account_holder": "Robert Shishani",
"account_currency_code": "USD",
"account_number": "4865393923574557",
"iban": "",
"swift_code": "230",
"clearing_system": "SWIFT",
"routing_code_type1": "",
"routing_code_value1": "",
"routing_code_type2": "",
"routing_code_value2": ""
},
"beneficiary_address": {
"country_code": "US",
"city": "Montgomery",
"street_address": "1230 Stafford Dr",
"postal_code": "36117",
"state": "Alabama"
}
}
}