Update Address Book

curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --data '
{
  "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
  "is_whitelist": 1,
  "address_label": "My USDT Wallet"
}
'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update"

payload = {
    "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
    "is_whitelist": 1,
    "address_label": "My USDT Wallet"
}
headers = {
    "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-auth-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address_id: '72612f65-6026-4cd0-b184-6c48f4850590',
    is_whitelist: 1,
    address_label: 'My USDT Wallet'
  })
};

fetch('https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update', 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/ramp/wallet_address/update",
  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([
    'address_id' => '72612f65-6026-4cd0-b184-6c48f4850590',
    'is_whitelist' => 1,
    'address_label' => 'My USDT Wallet'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-auth-token: <api-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/ramp/wallet_address/update"

	payload := strings.NewReader("{\n  \"address_id\": \"72612f65-6026-4cd0-b184-6c48f4850590\",\n  \"is_whitelist\": 1,\n  \"address_label\": \"My USDT Wallet\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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/ramp/wallet_address/update")
  .header("x-auth-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address_id\": \"72612f65-6026-4cd0-b184-6c48f4850590\",\n  \"is_whitelist\": 1,\n  \"address_label\": \"My USDT Wallet\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address_id\": \"72612f65-6026-4cd0-b184-6c48f4850590\",\n  \"is_whitelist\": 1,\n  \"address_label\": \"My USDT Wallet\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "message": "success",
  "data": {
    "account_id": "9276ffba-7b6c-4d1d-b4e9-b4c8fc435160",
    "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
    "address_type": 2000,
    "address_label": "My USDT Wallet",
    "network": "ETH",
    "currency": "USDT",
    "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "create_time": "2026-01-16 14:30:00",
    "address_status": 1,
    "is_owner": 0,
    "receiver_name": "John Doe",
    "verification_status": 1,
    "need_travel_rule": true,
    "meta_data": {
      "wallet_type": "hosted",
      "address_party": "third_party",
      "beneficiary_information": {
        "entity_type": "individual",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "Acme Pte Ltd",
        "country": "sg",
        "city": "Singapore",
        "vasp_id": "I1QNLP",
        "vasp_name": "Binance",
        "id_type": "<string>",
        "id_primary": "<string>"
      }
    },
    "message": "<string>"
  }
}

POST

ramp

wallet_address

update

Update Address Book

curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --data '
{
  "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
  "is_whitelist": 1,
  "address_label": "My USDT Wallet"
}
'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update"

payload = {
    "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
    "is_whitelist": 1,
    "address_label": "My USDT Wallet"
}
headers = {
    "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-auth-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address_id: '72612f65-6026-4cd0-b184-6c48f4850590',
    is_whitelist: 1,
    address_label: 'My USDT Wallet'
  })
};

fetch('https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update', 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/ramp/wallet_address/update",
  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([
    'address_id' => '72612f65-6026-4cd0-b184-6c48f4850590',
    'is_whitelist' => 1,
    'address_label' => 'My USDT Wallet'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-auth-token: <api-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/ramp/wallet_address/update"

	payload := strings.NewReader("{\n  \"address_id\": \"72612f65-6026-4cd0-b184-6c48f4850590\",\n  \"is_whitelist\": 1,\n  \"address_label\": \"My USDT Wallet\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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/ramp/wallet_address/update")
  .header("x-auth-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address_id\": \"72612f65-6026-4cd0-b184-6c48f4850590\",\n  \"is_whitelist\": 1,\n  \"address_label\": \"My USDT Wallet\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address_id\": \"72612f65-6026-4cd0-b184-6c48f4850590\",\n  \"is_whitelist\": 1,\n  \"address_label\": \"My USDT Wallet\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "message": "success",
  "data": {
    "account_id": "9276ffba-7b6c-4d1d-b4e9-b4c8fc435160",
    "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
    "address_type": 2000,
    "address_label": "My USDT Wallet",
    "network": "ETH",
    "currency": "USDT",
    "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "create_time": "2026-01-16 14:30:00",
    "address_status": 1,
    "is_owner": 0,
    "receiver_name": "John Doe",
    "verification_status": 1,
    "need_travel_rule": true,
    "meta_data": {
      "wallet_type": "hosted",
      "address_party": "third_party",
      "beneficiary_information": {
        "entity_type": "individual",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "Acme Pte Ltd",
        "country": "sg",
        "city": "Singapore",
        "vasp_id": "I1QNLP",
        "vasp_name": "Binance",
        "id_type": "<string>",
        "id_primary": "<string>"
      }
    },
    "message": "<string>"
  }
}

Authorizations

x-auth-token

string

header

required

The API token for login provided by UQPay.

Headers

x-on-behalf-of

string

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 API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-key

string<uuid>

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

address_id

string<uuid>

required

Address entry ID to update

Example:

"72612f65-6026-4cd0-b184-6c48f4850590"

is_whitelist

integer

Whether the address is whitelisted (0: No, 1: Yes)

Example:

1

address_label

string

Address label/name

Example:

"My USDT Wallet"

meta_data

object

Travel Rule data to add or edit for this address. Stored as the address's travel_rule_data.

Show child attributes

Response

200 - application/json

Address book entry updated successfully

code

integer

required

Example:

200

message

string

required

Example:

"success"

data

object

required

Show child attributes

Create address book Create deposit sender