Finrax API
HomeChangelogIntegration GuideResources
HomeChangelogIntegration GuideResources
  1. Payments and Withdrawals
  • Getting Started
    • Introduction
    • Environments
    • Errors
    • Authorization
      • API Key Management
      • Signature
      • Code Snippets
  • Payments and Withdrawals
    • Crypto Payments
      • Fetch payment by ID
      • 🔒Fetch payments
      • Submit crypto payment
      • Request crypto payment
    • Fetch withdrawals
      GET
    • Fetch withdrawal metadata
      GET
    • Request crypto withdrawal
      POST
    • Fetch whitelisted addresses
      GET
    • Whitelist an address
      POST
    • Fetch crypto withdrawal approval by ID
      GET
    • Fetch business by ID
      GET
    • Fetch business balance
      GET
    • Unwhitelist an address
      DELETE
  • Callbacks
    • Deposit received notification
    • Withdrawal broadcast notification
    • Withdrawal approved/rejected notification
  • Address validation
    • Validate address
      GET
    • Validate address and destination tag
      GET
  • Rates and metadata
    • Fetch market rates
      GET
    • Fetch fiat rates
      GET
    • Fetch deposit rates
      GET
    • Fetch all currencies
      GET
  1. Payments and Withdrawals

Whitelist an address

POST
/api/v1/whitelist-addresses
Whitelist a crypto address.

Request

Authorization
Add parameter in header
FRX-API
Example:
FRX-API: ********************
Body Params application/json
clientAddressId
string 
required
Address ID provided by the client.
currency
enum<string> 
required
Allowed values:
BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP
network
enum<string> 
required
Allowed values:
BCHBTCLTCXLMXRPETHBSCSOLTRX
address
string 
required
Crypto address.
destinationTag
string 
optional
XLM/XRP destination tag.
label
string 
optional
Label of the address, useful for grouping multiple whitelisted addresses.
Example
{
    "clientAddressId": "Client ID",
    "currency": "ETH",
    "address": "0xcefcca169357a18eb8c3f230f92b58562e48cae5",
    "network": "BSC",
    "label": "Users in Europe"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://payments.finrax.com/api/v1/whitelist-addresses' \
--header 'Content-Type: application/json' \
--header 'FRX-API;' \
--data-raw '{
    "clientAddressId": "Client ID",
    "currency": "ETH",
    "address": "0xcefcca169357a18eb8c3f230f92b58562e48cae5",
    "network": "BSC",
    "label": "Users in Europe"
}'

Responses

🟢201Address was successfully whitelisted.
application/json
Body
id
string <uuid>
required
Address ID.
clientAddressId
string 
required
Address ID provided by the client.
currency
enum<string> 
required
Address' intended currency.
Allowed values:
BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP
network
enum<string> 
required
Blockchain.
Allowed values:
BCHBTCLTCXLMXRPETHBSCSOLTRX
address
string 
required
Crypto address.
destinationTag
string 
optional
XLM/XRP destination tag.
label
string 
optional
Label of the address, useful for grouping multiple whitelisted addresses.
createdAt
integer <int64>
required
UNIX seconds at which the address was created.
Example
{
  "id": "6b6ae97a-d6af-4752-8629-7e9485618df2",
  "clientAddressId": "Client ID",
  "currency": "ETH",
  "network": "BSC",
  "address": "0xcefcca169357a18eb8c3f230f92b58562e48cae5",
  "label": "Users in Europe",
  "createdAt": 1702990609,
}
Modified at 2024-07-24 14:04:47
Previous
Fetch whitelisted addresses
Next
Fetch crypto withdrawal approval by ID
Built with