curl 'https://api.sandbox.uqpay.org/api/v1/balances/EUR/bank_details' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
{
"code": 200,
"message": "Success",
"data": {
"local": [
{
"account_bank_id": "60d33671-0f2d-4353-b3e7-4e3af71408ac",
"account_holder": "Johnson",
"account_id": "c614094e-c13b-4df9-876a-01ed1206f26a",
"account_number": "GB01TCCL28232805570870",
"bank_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
"bank_code": "",
"bank_name": "The Currency Cloud Limited",
"clearing_system_code": "TCCLGB31",
"clearing_system_type": "bic swift",
"country_code": "GB",
"currency_code": "EUR",
"payment_reference": "B9637636096"
}
],
"status": "opened",
"swift": [
{
"account_bank_id": "aca22cc9-04ee-4598-af6b-e3ba696585f5",
"account_holder": "Johnson",
"account_id": "c614094e-c13b-4df9-876a-01ed1206f26a",
"account_number": "GB64TCCL12345621576812",
"bank_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
"bank_code": "",
"bank_name": "The Currency Cloud Limited",
"clearing_system_code": "TCCLGB3L",
"clearing_system_type": "bic swift",
"country_code": "GB",
"currency_code": "EUR",
"payment_reference": "B9637636096"
}
]
}
}
Balances
Retrieve a bank details
This endpoint returns a bank details of a balance based on the currency.
GET
/
api
/
v1
/
balances
/
{currency}
/
bank_details
curl 'https://api.sandbox.uqpay.org/api/v1/balances/EUR/bank_details' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
{
"code": 200,
"message": "Success",
"data": {
"local": [
{
"account_bank_id": "60d33671-0f2d-4353-b3e7-4e3af71408ac",
"account_holder": "Johnson",
"account_id": "c614094e-c13b-4df9-876a-01ed1206f26a",
"account_number": "GB01TCCL28232805570870",
"bank_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
"bank_code": "",
"bank_name": "The Currency Cloud Limited",
"clearing_system_code": "TCCLGB31",
"clearing_system_type": "bic swift",
"country_code": "GB",
"currency_code": "EUR",
"payment_reference": "B9637636096"
}
],
"status": "opened",
"swift": [
{
"account_bank_id": "aca22cc9-04ee-4598-af6b-e3ba696585f5",
"account_holder": "Johnson",
"account_id": "c614094e-c13b-4df9-876a-01ed1206f26a",
"account_number": "GB64TCCL12345621576812",
"bank_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
"bank_code": "",
"bank_name": "The Currency Cloud Limited",
"clearing_system_code": "TCCLGB3L",
"clearing_system_type": "bic swift",
"country_code": "GB",
"currency_code": "EUR",
"payment_reference": "B9637636096"
}
]
}
}
Header
string
required
x-client-id.string
required
Bearer
YOUR_TOKEN_HERE.Parameters
Response
number
Indicates whether the call was successful. 200 if successful, 400 if not.
string
Response Message. “Success” if successful, others not.
object
Hide details
Hide details
array
Hide details
Hide details
string
ID of the account this balance is associated with.
string
ID of the bank this balance is associated with.
string
Two-letter ISO 3166-2 country code.
string
Account holder of the balance.
string
Account number of the balance.
string
Clearing system type is one of SG-FAST, RTGS, GIRO, US-ACH, Fedwire, SEPA, Faster Payments, CHAPS, Bacs, Zengin, Bank, FPS, MEPS, SWIFT.
string
Clearing system code is the number of ACH, FEDWIRE, GRIO, SWIFT CODE.
string
Name of the bank this balance is associated with.
string
Code of the bank this balance is associated with.
string
Address of the bank this balance is associated with.
string
Payment reference used for bank transfers to quote remarks.
string
Status of the account.
array
Show details
Show details
string
ID of the account this balance is associated with.
string
ID of the bank this balance is associated with.
string
Two-letter ISO 3166-2 country code.
string
Account holder of the balance.
string
Account number of the balance.
string
Clearing system type is one of SG-FAST, RTGS, GIRO, US-ACH, Fedwire, SEPA, Faster Payments, CHAPS, Bacs, Zengin, Bank, FPS, MEPS, SWIFT.
string
Clearing system code is the number of ACH, FEDWIRE, GRIO, SWIFT CODE.
string
Name of the bank this balance is associated with.
string
Code of the bank this balance is associated with.
string
Address of the bank this balance is associated with.
string
Payment reference used for bank transfers to quote remarks.
curl 'https://api.sandbox.uqpay.org/api/v1/balances/EUR/bank_details' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
{
"code": 200,
"message": "Success",
"data": {
"local": [
{
"account_bank_id": "60d33671-0f2d-4353-b3e7-4e3af71408ac",
"account_holder": "Johnson",
"account_id": "c614094e-c13b-4df9-876a-01ed1206f26a",
"account_number": "GB01TCCL28232805570870",
"bank_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
"bank_code": "",
"bank_name": "The Currency Cloud Limited",
"clearing_system_code": "TCCLGB31",
"clearing_system_type": "bic swift",
"country_code": "GB",
"currency_code": "EUR",
"payment_reference": "B9637636096"
}
],
"status": "opened",
"swift": [
{
"account_bank_id": "aca22cc9-04ee-4598-af6b-e3ba696585f5",
"account_holder": "Johnson",
"account_id": "c614094e-c13b-4df9-876a-01ed1206f26a",
"account_number": "GB64TCCL12345621576812",
"bank_address": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
"bank_code": "",
"bank_name": "The Currency Cloud Limited",
"clearing_system_code": "TCCLGB3L",
"clearing_system_type": "bic swift",
"country_code": "GB",
"currency_code": "EUR",
"payment_reference": "B9637636096"
}
]
}
}
⌘I