Update Beneficiary
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id} \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"entity_type": "COMPANY",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"payment_method": "LOCAL",
"bank_details": {
"bank_name": "Bank of America",
"bank_address": "123 Main St",
"bank_country_code": "SG",
"account_holder": "John Doe",
"account_currency_code": "USD",
"swift_code": "WELGBE22",
"clearing_system": "GIRO",
"account_number": "12345678",
"iban": "GB82 WEST 1234 5698 7654 32",
"routing_code_type1": "aba",
"routing_code_value1": "123456789",
"routing_code_type2": "ach",
"routing_code_value2": "123456789"
},
"address": {
"country": "SG",
"city": "Singapore",
"street_address": "123 Main St",
"postal_code": "123456",
"state": "CA",
"nationality": "SG"
},
"email": "example@uqpay.com",
"nickname": "John Doe",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}"
payload = {
"entity_type": "COMPANY",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"payment_method": "LOCAL",
"bank_details": {
"bank_name": "Bank of America",
"bank_address": "123 Main St",
"bank_country_code": "SG",
"account_holder": "John Doe",
"account_currency_code": "USD",
"swift_code": "WELGBE22",
"clearing_system": "GIRO",
"account_number": "12345678",
"iban": "GB82 WEST 1234 5698 7654 32",
"routing_code_type1": "aba",
"routing_code_value1": "123456789",
"routing_code_type2": "ach",
"routing_code_value2": "123456789"
},
"address": {
"country": "SG",
"city": "Singapore",
"street_address": "123 Main St",
"postal_code": "123456",
"state": "CA",
"nationality": "SG"
},
"email": "example@uqpay.com",
"nickname": "John Doe",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
}
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({
entity_type: 'COMPANY',
company_name: 'UQPAY TECHNOLOGY SG PTE LTD',
payment_method: 'LOCAL',
bank_details: {
bank_name: 'Bank of America',
bank_address: '123 Main St',
bank_country_code: 'SG',
account_holder: 'John Doe',
account_currency_code: 'USD',
swift_code: 'WELGBE22',
clearing_system: 'GIRO',
account_number: '12345678',
iban: 'GB82 WEST 1234 5698 7654 32',
routing_code_type1: 'aba',
routing_code_value1: '123456789',
routing_code_type2: 'ach',
routing_code_value2: '123456789'
},
address: {
country: 'SG',
city: 'Singapore',
street_address: '123 Main St',
postal_code: '123456',
state: 'CA',
nationality: 'SG'
},
email: 'example@uqpay.com',
nickname: 'John Doe',
additional_info: {
organization_code: '91210106MA0P46BWXY',
proxy_id: '<string>',
id_type: 'PASSPORT',
id_number: 'AB1234567',
tax_id: '123456789',
msisdn: '+65111111'
}
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}', 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/v1/beneficiaries/{id}",
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([
'entity_type' => 'COMPANY',
'company_name' => 'UQPAY TECHNOLOGY SG PTE LTD',
'payment_method' => 'LOCAL',
'bank_details' => [
'bank_name' => 'Bank of America',
'bank_address' => '123 Main St',
'bank_country_code' => 'SG',
'account_holder' => 'John Doe',
'account_currency_code' => 'USD',
'swift_code' => 'WELGBE22',
'clearing_system' => 'GIRO',
'account_number' => '12345678',
'iban' => 'GB82 WEST 1234 5698 7654 32',
'routing_code_type1' => 'aba',
'routing_code_value1' => '123456789',
'routing_code_type2' => 'ach',
'routing_code_value2' => '123456789'
],
'address' => [
'country' => 'SG',
'city' => 'Singapore',
'street_address' => '123 Main St',
'postal_code' => '123456',
'state' => 'CA',
'nationality' => 'SG'
],
'email' => 'example@uqpay.com',
'nickname' => 'John Doe',
'additional_info' => [
'organization_code' => '91210106MA0P46BWXY',
'proxy_id' => '<string>',
'id_type' => 'PASSPORT',
'id_number' => 'AB1234567',
'tax_id' => '123456789',
'msisdn' => '+65111111'
]
]),
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/v1/beneficiaries/{id}"
payload := strings.NewReader("{\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\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/v1/beneficiaries/{id}")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}")
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 \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n}"
response = http.request(request)
puts response.read_body{
"beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"short_reference_id": "P220406-LLCVLRM"
}Beneficiaries
Update Beneficiary
Update a beneficiary. Entity type of the beneficiary cannot be modified.
POST
/
v1
/
beneficiaries
/
{id}
Update Beneficiary
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id} \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"entity_type": "COMPANY",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"payment_method": "LOCAL",
"bank_details": {
"bank_name": "Bank of America",
"bank_address": "123 Main St",
"bank_country_code": "SG",
"account_holder": "John Doe",
"account_currency_code": "USD",
"swift_code": "WELGBE22",
"clearing_system": "GIRO",
"account_number": "12345678",
"iban": "GB82 WEST 1234 5698 7654 32",
"routing_code_type1": "aba",
"routing_code_value1": "123456789",
"routing_code_type2": "ach",
"routing_code_value2": "123456789"
},
"address": {
"country": "SG",
"city": "Singapore",
"street_address": "123 Main St",
"postal_code": "123456",
"state": "CA",
"nationality": "SG"
},
"email": "example@uqpay.com",
"nickname": "John Doe",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}"
payload = {
"entity_type": "COMPANY",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"payment_method": "LOCAL",
"bank_details": {
"bank_name": "Bank of America",
"bank_address": "123 Main St",
"bank_country_code": "SG",
"account_holder": "John Doe",
"account_currency_code": "USD",
"swift_code": "WELGBE22",
"clearing_system": "GIRO",
"account_number": "12345678",
"iban": "GB82 WEST 1234 5698 7654 32",
"routing_code_type1": "aba",
"routing_code_value1": "123456789",
"routing_code_type2": "ach",
"routing_code_value2": "123456789"
},
"address": {
"country": "SG",
"city": "Singapore",
"street_address": "123 Main St",
"postal_code": "123456",
"state": "CA",
"nationality": "SG"
},
"email": "example@uqpay.com",
"nickname": "John Doe",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
}
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({
entity_type: 'COMPANY',
company_name: 'UQPAY TECHNOLOGY SG PTE LTD',
payment_method: 'LOCAL',
bank_details: {
bank_name: 'Bank of America',
bank_address: '123 Main St',
bank_country_code: 'SG',
account_holder: 'John Doe',
account_currency_code: 'USD',
swift_code: 'WELGBE22',
clearing_system: 'GIRO',
account_number: '12345678',
iban: 'GB82 WEST 1234 5698 7654 32',
routing_code_type1: 'aba',
routing_code_value1: '123456789',
routing_code_type2: 'ach',
routing_code_value2: '123456789'
},
address: {
country: 'SG',
city: 'Singapore',
street_address: '123 Main St',
postal_code: '123456',
state: 'CA',
nationality: 'SG'
},
email: 'example@uqpay.com',
nickname: 'John Doe',
additional_info: {
organization_code: '91210106MA0P46BWXY',
proxy_id: '<string>',
id_type: 'PASSPORT',
id_number: 'AB1234567',
tax_id: '123456789',
msisdn: '+65111111'
}
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}', 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/v1/beneficiaries/{id}",
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([
'entity_type' => 'COMPANY',
'company_name' => 'UQPAY TECHNOLOGY SG PTE LTD',
'payment_method' => 'LOCAL',
'bank_details' => [
'bank_name' => 'Bank of America',
'bank_address' => '123 Main St',
'bank_country_code' => 'SG',
'account_holder' => 'John Doe',
'account_currency_code' => 'USD',
'swift_code' => 'WELGBE22',
'clearing_system' => 'GIRO',
'account_number' => '12345678',
'iban' => 'GB82 WEST 1234 5698 7654 32',
'routing_code_type1' => 'aba',
'routing_code_value1' => '123456789',
'routing_code_type2' => 'ach',
'routing_code_value2' => '123456789'
],
'address' => [
'country' => 'SG',
'city' => 'Singapore',
'street_address' => '123 Main St',
'postal_code' => '123456',
'state' => 'CA',
'nationality' => 'SG'
],
'email' => 'example@uqpay.com',
'nickname' => 'John Doe',
'additional_info' => [
'organization_code' => '91210106MA0P46BWXY',
'proxy_id' => '<string>',
'id_type' => 'PASSPORT',
'id_number' => 'AB1234567',
'tax_id' => '123456789',
'msisdn' => '+65111111'
]
]),
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/v1/beneficiaries/{id}"
payload := strings.NewReader("{\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\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/v1/beneficiaries/{id}")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}")
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 \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n}"
response = http.request(request)
puts response.read_body{
"beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"short_reference_id": "P220406-LLCVLRM"
}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.
Path Parameters
Universally unique identifier (UUID v4) of a resource.
Example:
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
Body
application/json
- COMPANY
- INDIVIDUAL
The type of beneficiary entity.
Example:
"COMPANY"
Company name of the beneficiary, only exist when the entity_type is COMPANY.
-
When
payment_method = SWIFT:- Only English letters, numbers, special characters (half-width format), and spaces can be included.
- Allowed special characters:
-_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……
-
When
payment_method = LOCAL:- No strict validation rules apply, local language characters are supported.
-
No need to pass this field when
bank_details.bank_country_code = SG&bank_details.account_currency_code = SGD -
When
bank_country_code = CN&account_currency_code = CNH&payment_method = LOCAL&entity_type = COMPANY, Chinese characters and Chinese parentheses（）are supported.
Maximum string length:
120Pattern:
^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$Example:
"UQPAY TECHNOLOGY SG PTE LTD"
The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.
LOCAL: Payment processed through domestic payment networks with local clearing systems.SWIFT: International payment processed through the SWIFT network for cross-border transfers.
Available options:
LOCAL, SWIFT Example:
"LOCAL"
Show child attributes
Show child attributes
Address of the beneficiary.
- No need to pass this field when
bank_details.bank_country_code = SG&bank_details.account_currency_code = SGD
Show child attributes
Show child attributes
Email address of the beneficiary.
Example:
"example@uqpay.com"
Nickname of the beneficiary.
Maximum string length:
120Example:
"John Doe"
Additional information for beneficiaries.
Show child attributes
Show child attributes
Response
200 - application/json
Beneficiary update successfully.
⌘I