Fetching whitelisted addresses

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

Query Parameters

NameTypeDescription

id

String

clientAddressId

String

currency

String

label

String

Addresses with label

after

String

Results only after date

before

String

Results only before date

descending

String

If the results should be sorted in descending or ascending order. True by default

limit

String

The default limit is 25

[
    {
        "address": "3MmmSoYJjSyRdkfAinGcrxLJeZZNF3EXSm",
        "clientAddressId": "Demo Address",
        "createdAt": 1634129290,
        "currency": "BTC",
        "network": "BTC",
        "id": "53318d5b-da4a-4565-84dc-63ca679913d4",
        "label": "Users in EU"
    },
    {
        "address": "rLZSHHDSgiWcNiHiLoPJxPWPK3hLj31W1A",
        "clientAddressId": "Demo Address 2",
        "createdAt": 1634127768,
        "currency": "XRP",
        "network": "XRP",
        "destinationTag": "1317",
        "id": "480c0e3f-aaf0-4cc9-ba4f-0c03e5b8560b",
        "label": "Users in Asia"
    }
]
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