Create Bank Account
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"account_number": "GB71950018692652646598",
"bank_name": "DBS Bank",
"swift_code": "DBSSSGSG",
"bank_country_code": "SG",
"bank_address": "12 Marina Boulevard, Singapore 018982",
"currency": "SGD",
"bank_code_type": "aba",
"bank_code_value": "021000021",
"bank_branch_code": "00001"
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create"
payload = {
"account_number": "GB71950018692652646598",
"bank_name": "DBS Bank",
"swift_code": "DBSSSGSG",
"bank_country_code": "SG",
"bank_address": "12 Marina Boulevard, Singapore 018982",
"currency": "SGD",
"bank_code_type": "aba",
"bank_code_value": "021000021",
"bank_branch_code": "00001"
}
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-idempotency-key': '<x-idempotency-key>',
'x-auth-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
account_number: 'GB71950018692652646598',
bank_name: 'DBS Bank',
swift_code: 'DBSSSGSG',
bank_country_code: 'SG',
bank_address: '12 Marina Boulevard, Singapore 018982',
currency: 'SGD',
bank_code_type: 'aba',
bank_code_value: '021000021',
bank_branch_code: '00001'
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account_number' => 'GB71950018692652646598',
'bank_name' => 'DBS Bank',
'swift_code' => 'DBSSSGSG',
'bank_country_code' => 'SG',
'bank_address' => '12 Marina Boulevard, Singapore 018982',
'currency' => 'SGD',
'bank_code_type' => 'aba',
'bank_code_value' => '021000021',
'bank_branch_code' => '00001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-auth-token: <api-key>",
"x-idempotency-key: <x-idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create"
payload := strings.NewReader("{\n \"account_number\": \"GB71950018692652646598\",\n \"bank_name\": \"DBS Bank\",\n \"swift_code\": \"DBSSSGSG\",\n \"bank_country_code\": \"SG\",\n \"bank_address\": \"12 Marina Boulevard, Singapore 018982\",\n \"currency\": \"SGD\",\n \"bank_code_type\": \"aba\",\n \"bank_code_value\": \"021000021\",\n \"bank_branch_code\": \"00001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account_number\": \"GB71950018692652646598\",\n \"bank_name\": \"DBS Bank\",\n \"swift_code\": \"DBSSSGSG\",\n \"bank_country_code\": \"SG\",\n \"bank_address\": \"12 Marina Boulevard, Singapore 018982\",\n \"currency\": \"SGD\",\n \"bank_code_type\": \"aba\",\n \"bank_code_value\": \"021000021\",\n \"bank_branch_code\": \"00001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_number\": \"GB71950018692652646598\",\n \"bank_name\": \"DBS Bank\",\n \"swift_code\": \"DBSSSGSG\",\n \"bank_country_code\": \"SG\",\n \"bank_address\": \"12 Marina Boulevard, Singapore 018982\",\n \"currency\": \"SGD\",\n \"bank_code_type\": \"aba\",\n \"bank_code_value\": \"021000021\",\n \"bank_branch_code\": \"00001\"\n}"
response = http.request(request)
puts response.read_body{
"account_number": "GB71950018692652646598",
"bank_name": "DBS Bank",
"swift_code": "DBSSSGSG",
"bank_country_code": "SG",
"bank_address": "12 Marina Boulevard, Singapore 018982",
"bank_code_type": "aba",
"bank_code_value": "021000021",
"bank_branch_code": "00001",
"id": "a7b92a19-bfc3-4c8b-8a4f-cfcf74cab345",
"account_name": "UQPAY PTE. LTD.",
"currency": "SGD",
"account_status": "Valid"
}Bank Accounts
Create Bank Account
Create a new bank account for settlement purposes.
POST
/
v2
/
payment
/
bankaccount
/
create
Create Bank Account
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"account_number": "GB71950018692652646598",
"bank_name": "DBS Bank",
"swift_code": "DBSSSGSG",
"bank_country_code": "SG",
"bank_address": "12 Marina Boulevard, Singapore 018982",
"currency": "SGD",
"bank_code_type": "aba",
"bank_code_value": "021000021",
"bank_branch_code": "00001"
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create"
payload = {
"account_number": "GB71950018692652646598",
"bank_name": "DBS Bank",
"swift_code": "DBSSSGSG",
"bank_country_code": "SG",
"bank_address": "12 Marina Boulevard, Singapore 018982",
"currency": "SGD",
"bank_code_type": "aba",
"bank_code_value": "021000021",
"bank_branch_code": "00001"
}
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-idempotency-key': '<x-idempotency-key>',
'x-auth-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
account_number: 'GB71950018692652646598',
bank_name: 'DBS Bank',
swift_code: 'DBSSSGSG',
bank_country_code: 'SG',
bank_address: '12 Marina Boulevard, Singapore 018982',
currency: 'SGD',
bank_code_type: 'aba',
bank_code_value: '021000021',
bank_branch_code: '00001'
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account_number' => 'GB71950018692652646598',
'bank_name' => 'DBS Bank',
'swift_code' => 'DBSSSGSG',
'bank_country_code' => 'SG',
'bank_address' => '12 Marina Boulevard, Singapore 018982',
'currency' => 'SGD',
'bank_code_type' => 'aba',
'bank_code_value' => '021000021',
'bank_branch_code' => '00001'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-auth-token: <api-key>",
"x-idempotency-key: <x-idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create"
payload := strings.NewReader("{\n \"account_number\": \"GB71950018692652646598\",\n \"bank_name\": \"DBS Bank\",\n \"swift_code\": \"DBSSSGSG\",\n \"bank_country_code\": \"SG\",\n \"bank_address\": \"12 Marina Boulevard, Singapore 018982\",\n \"currency\": \"SGD\",\n \"bank_code_type\": \"aba\",\n \"bank_code_value\": \"021000021\",\n \"bank_branch_code\": \"00001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account_number\": \"GB71950018692652646598\",\n \"bank_name\": \"DBS Bank\",\n \"swift_code\": \"DBSSSGSG\",\n \"bank_country_code\": \"SG\",\n \"bank_address\": \"12 Marina Boulevard, Singapore 018982\",\n \"currency\": \"SGD\",\n \"bank_code_type\": \"aba\",\n \"bank_code_value\": \"021000021\",\n \"bank_branch_code\": \"00001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment/bankaccount/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_number\": \"GB71950018692652646598\",\n \"bank_name\": \"DBS Bank\",\n \"swift_code\": \"DBSSSGSG\",\n \"bank_country_code\": \"SG\",\n \"bank_address\": \"12 Marina Boulevard, Singapore 018982\",\n \"currency\": \"SGD\",\n \"bank_code_type\": \"aba\",\n \"bank_code_value\": \"021000021\",\n \"bank_branch_code\": \"00001\"\n}"
response = http.request(request)
puts response.read_body{
"account_number": "GB71950018692652646598",
"bank_name": "DBS Bank",
"swift_code": "DBSSSGSG",
"bank_country_code": "SG",
"bank_address": "12 Marina Boulevard, Singapore 018982",
"bank_code_type": "aba",
"bank_code_value": "021000021",
"bank_branch_code": "00001",
"id": "a7b92a19-bfc3-4c8b-8a4f-cfcf74cab345",
"account_name": "UQPAY PTE. LTD.",
"currency": "SGD",
"account_status": "Valid"
}Authorizations
The API token for login provided by UQPAY.
Headers
Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account.
More information at Connected Accounts.
A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.
Body
application/json
Common bank account properties shared between request and response.
Bank account number (e.g., IBAN).
Required string length:
5 - 60Example:
"GB71950018692652646598"
Name of the bank.
Example:
"DBS Bank"
SWIFT/BIC code of the bank.
Required string length:
8 - 11Example:
"DBSSSGSG"
Two-letter country code (ISO 3166-1 alpha-2) of the bank.
Required string length:
2Example:
"SG"
Physical address of the bank.
Example:
"12 Marina Boulevard, Singapore 018982"
Currency of the settlement account.
Example:
"SGD"
Type of bank routing code. Required based on currency and country:
aba- Required when currency = "USD" and bank_country_code = "US"bank_code- Required when currency = "CAD" or currency = "HKD"sort_code- Required when currency = "GBP"bsb_code- Required when currency = "AUD"ifsc- Required when currency = "INR"cnaps_number- Required when currency = "CNH" and bank_country_code = "CN"
Available options:
aba, bank_code, sort_code, bsb_code, ifsc, cnaps_number Example:
"aba"
The bank identifier value. The required format depends on the selected
bank_code_type.
Accepted formats by bank_code_type:
aba: Exactly 9 digits.bank_code: Exactly 3 digits.sort_code: Exactly 6 digits.bsb_code: Exactly 6 digits.ifsc: Exactly 11 characters in the format:- First 4 characters: letters (A–Z)
- 5th character: the digit 0
- Last 6 characters: letters (A–Z) or digits (0–9)
cnaps_number: Exactly 12 digits.
Example:
"021000021"
Bank branch code. Required when currency = "CAD".
Example:
"00001"
Response
200 - application/json
Bank account created successfully
Common bank account properties shared between request and response.
Bank account number (e.g., IBAN).
Required string length:
5 - 60Example:
"GB71950018692652646598"
Name of the bank.
Example:
"DBS Bank"
SWIFT/BIC code of the bank.
Required string length:
8 - 11Example:
"DBSSSGSG"
Two-letter country code (ISO 3166-1 alpha-2) of the bank.
Required string length:
2Example:
"SG"
Physical address of the bank.
Example:
"12 Marina Boulevard, Singapore 018982"
Type of bank routing code. Required based on currency and country:
aba- Required when currency = "USD" and bank_country_code = "US"bank_code- Required when currency = "CAD" or currency = "HKD"sort_code- Required when currency = "GBP"bsb_code- Required when currency = "AUD"ifsc- Required when currency = "INR"cnaps_number- Required when currency = "CNH" and bank_country_code = "CN"
Available options:
aba, bank_code, sort_code, bsb_code, ifsc, cnaps_number Example:
"aba"
The bank identifier value. The required format depends on the selected
bank_code_type.
Accepted formats by bank_code_type:
aba: Exactly 9 digits.bank_code: Exactly 3 digits.sort_code: Exactly 6 digits.bsb_code: Exactly 6 digits.ifsc: Exactly 11 characters in the format:- First 4 characters: letters (A–Z)
- 5th character: the digit 0
- Last 6 characters: letters (A–Z) or digits (0–9)
cnaps_number: Exactly 12 digits.
Example:
"021000021"
Bank branch code. Required when currency = "CAD".
Example:
"00001"
Unique identifier (UUID) of the bank account.
Example:
"a7b92a19-bfc3-4c8b-8a4f-cfcf74cab345"
Name of the account holder.
Example:
"UQPAY PTE. LTD."
Currency of the settlement account.
Example:
"SGD"
Status of the bank account.
Valid: The bank account is active and can be used for settlements.Invalid: The bank account is inactive and cannot be used for settlements.
Available options:
Valid, Invalid Example:
"Valid"