Whitelisting addresses

In most cases, when you are sending cryptocurrency to an external wallet, you want to make sure that you are sending the funds to the right crypto address.

Whitelist an address

POST https://payments.finrax.com/api/v1/whitelist-addresses

Request Body

NameTypeDescription

clientAddressId*

String

Unique whitelisted address identifier provided in the request

currency*

String

The cryptocurrency for this address

address*

String

The address you would like to whitelist

destinationTag

String

Applicable for XRP and XLM

label

String

Useful for grouping multiple whitelisted addresses

network*

String

The network of the address that will be whitelisted. Supported networks match the ones listed for crypto withdrawals.

{
        "address": "3MmmSoYJjSyRdkfAinGcrxLJeZZNF3EXSm",
        "clientAddressId": "Demo Address",
        "createdAt": 1634129290,
        "currency": "BTC",
        "network": "BTC",
        "id": "53318d5b-da4a-4565-84dc-63ca679913d4",
        "label": "Users in EU"
}
ParameterTypeDescription

id

string [required]

Unique whitelisted address identifier within Finrax system UUID

clientAddressId

string [required]

Unique whitelisted address identifier provided in the request

currency

string [required]

The cryptocurrency for this address

network

string [required]

The network of this cryptocurrency address.

address

string [required]

The address you would like to whitelist

destinationTag

string [optional]

Applicable for XRP and XLM

label

string [optional]

Useful for grouping multiple whitelisted addresses

createdAt

string [required]

Timestamp when the whitelisted address got created UNIX

Last updated