Adding a trusted address

Adding an address to the trusted list to be able to withdraw using the payment widget

Adding a trusted address

post

/api-gateway/personal-addresses/add-trusted-address

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

clientIdstring

User ID in the merchant system

Example: user12345

currencystring

Address currency

Example: USDT

networkstring

Address network

Example: ethereum

addressstring

The address in the blockchain

Example: 0xe68C1e0C4BA59e17fAF970cB7EC69c3dABf25f02

tagstring

Address tag (memo) (relevant only for networks that support the tag, such as Ripple)

aliasstring

Address alias

Example: My main address

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/personal-addresses/add-trusted-address' \
  --header 'Content-Type: application/json' \
  --data '{"clientId":"user12345","currency":"USDT","network":"ethereum","address":"0xe68C1e0C4BA59e17fAF970cB7EC69c3dABf25f02","tag":null,"alias":"My main address"}'

200

200

{
  "success": true,
  "response": {
    "id": "17e1cfc3-e0dc-4f02-bb49-83b35c1e2b15",
    "clientId": "user12345",
    "currency": "USDT",
    "network": "ethereum",
    "address": "0xe68C1e0C4BA59e17fAF970cB7EC69c3dABf25f02",
    "tag": null,
    "alias": "My main address",
    "createdAt": "2024-12-26T08:21:33.227Z"
  }
}