Collections

With our deposit system, you can generate unique wallet addresses for your users to receive funds. These addresses can be used for cryptocurrency deposits, and once a deposit is received, you’ll be notified via webhook with transaction details to allow for further processing on your end.

Key Features

Generate Wallet Addresses

You can generate unique wallet addresses for your users using the Create Deposit Address endpoint. These addresses allow users to receive cryptocurrency deposits from other addresses. To ensure a new address is created, the uniqueUserIdentifier in the request payload must be unique per customer. If the same uniqueUserIdentifier is used as in a previous request, the existing wallet address associated with that identifier will be returned instead of creating a new one.

If you’re generating multiple addresses for a customer, use the same uniqueUserIdentifier regardless of what currency/network you’re generating the address for.

Check that a network can receive deposits

Before you generate an address, call the Get Active Networks endpoint. It returns every supported currency and its networks, along with fees, minimums, and two availability flags:

Property	Meaning
`isReceivable`	`true` if you can generate a deposit address and receive deposits for this currency/network pair
`isWithdrawable`	`true` if you can withdraw this currency on this network

Only generate an address when isReceivable is true. If it’s false, the Create Deposit Address request fails with an error.

{
  "message": "Ok",
  "data": {
    "USDT": {
      "currencyName": "Tether",
      "networks": [
        {
          "networkName": "Tron (TRC20)",
          "networkCode": "TRX",
          "minimumDeposit": 0,
          "depositFee": 0,
          "isReceivable": true,
          "isWithdrawable": true
        },
        {
          "networkName": "Polygon (MATIC)",
          "networkCode": "MATIC",
          "minimumDeposit": 0,
          "depositFee": 0,
          "isReceivable": false,
          "isWithdrawable": true
        }
      ]
    }
  }
}

In this example, you can generate a USDT address on TRX, but not on MATIC.

Deposit availability can change, for example during network maintenance. Check isReceivable each time you show deposit options to your users instead of hard-coding the list.

Use currency and network codes

Always send the currency code and the network code — never the display name.

currency: use the key of the currency object, for example USDT — not Tether.
network: use networkCode, for example TRX — not Tron (TRC20).

{
  "uniqueUserIdentifier": "user-7c0406db-05a2-4832-ab13-776a4a145353",
  "currency": "USDT",
  "network": "TRX"
}

We’ve changed the property name from purpose to uniqueUserIdentifier to highlight its requirement for uniqueness among users. If your current integration uses purpose, you don’t need to make any changes - it is fully backward compatible and will continue to work.

List Deposit Addresses

Use the Get Deposit Addresses endpoint to retrieve a list of deposit addresses you have generated.

Receive Deposits

Once funds are sent to a wallet address, we’ll notify you via a webhook with transaction details, enabling you to process the deposit accordingly.

Sample Deposit Webhook

{
  "hash": "0xe62236173d7427b73782c4d09863f01de418b7a2029841bcabfb35870c8d4f6c",
  "type": "DEPOSIT",
  "currency": "BNB",
  "address": "0x6f44D28c9aD050a101020a34B874Fd1B9Ed56Cdd",
  "amount": 0.3,
  "status": "CONFIRMED",
  "reference": "cbbf9e70-6e79-4513-905c-8dc584fbfee2",
  "transactionId": "8e91df33-077d-4702-9097-25051f21fb74",
  "createdAt": "2024-06-06T12:56:32.076Z",
  "lastUpdated": "2024-06-06T12:56:32.076Z"
}

Only process deposits with a CONFIRMED status.

Key Endpoints

Method	Endpoint	Description
POST	`/addresses/broker`	Create a deposit request by generating a new wallet address
GET	`/addresses/me/broker`	List all deposit addresses associated with your business
GET	`/currencies/networks/active`	Lists supported networks and currencies with fee information

Fees

We do not charge a fee for generating wallets or on deposits.

Getting Started

Features

SDKs

Use Cases

Key Features

Generate Wallet Addresses

Check that a network can receive deposits

Use currency and network codes

List Deposit Addresses

Receive Deposits

Sample Deposit Webhook

Key Endpoints

Fees

​Key Features

​Generate Wallet Addresses

​Check that a network can receive deposits

​Use currency and network codes

​List Deposit Addresses

​Receive Deposits

​Sample Deposit Webhook

​Key Endpoints

​Fees

Key Features

Generate Wallet Addresses

Check that a network can receive deposits

Use currency and network codes

List Deposit Addresses

Receive Deposits

Sample Deposit Webhook

Key Endpoints

Fees