Deposit Endpoints¶

This section covers API endpoints related to deposits. Deposit operations allow users to add cryptocurrencies and fiat currencies to their platform balance by receiving funds from external sources. Different cryptocurrency networks and fiat payment methods have specific conditions, fees, and reference requirements.

Get Personal Deposit Methods¶

Returns deposit methods available to the authenticated user, considering their segments. It also represents the user's deposit limits and fees.

GET /deposit-methods

Required Permissions¶

• allow_deposit

Rate Limit¶

30 requests per minute

Query Parameters¶

Response Fields¶

Returns list of objects:

Response Example¶

[
  {
    "code": "USDTTRC20",
    "name": "USDT Tron",
    "method_type": "crypto",
    "currency": "USDT",
    "coin": "USDTTRC20",
    "network": "TRX",
    "contract_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
    "min_amount": "0.00000001",
    "max_amount": null,
    "fee_percent": "0.00000000",
    "fee_percent_min": null,
    "fee_percent_max": null,
    "fee_absolute": "0.00000000",
    "required_confirmations": 0,
    "is_enabled": true,
    "spend_precision": 8,
    "receive_precision": 8
  },
  {
    "code": "USDTERC20",
    "name": "USDT Ethereum",
    "method_type": "crypto",
    "currency": "USDT",
    "coin": "USDTERC20",
    "network": "ETH",
    "contract_address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
    "min_amount": "0.00000001",
    "max_amount": null,
    "fee_percent": "0.00000000",
    "fee_percent_min": null,
    "fee_percent_max": null,
    "fee_absolute": "0.00000000",
    "required_confirmations": 0,
    "is_enabled": true,
    "spend_precision": 8,
    "receive_precision": 8
  },
  {
    "code": "BTC",
    "name": "BTC Bitcoin",
    "method_type": "crypto",
    "currency": "BTC",
    "coin": "BTC",
    "network": "BTC",
    "contract_address": null,
    "min_amount": "0.00000001",
    "max_amount": null,
    "fee_percent": "0.00000000",
    "fee_percent_min": null,
    "fee_percent_max": null,
    "fee_absolute": "0.00000000",
    "required_confirmations": 0,
    "is_enabled": true,
    "spend_precision": 8,
    "receive_precision": 8
  }
]

Generate Deposit Address¶

Generates a new deposit address for a specific currency and method.

POST /deposit/generate_address

Required Permissions¶

• allow_deposit

Rate Limit¶

600 requests per minute

Request Parameters¶

Notes¶

Deposit address does not bound to specific deposit method or coin or even blockchain network. That is means that you can deposit for example USDCERC20 to POL deposit address and deposit will be successfully processed. So always check which assed is deposited in deposit object.

Example Request¶

{
  "currency": "BTC",
  "method": "BTC",
  "callback_url": "https://example.com/callbacks/deposits",
  "custom_id": "my-deposit-address-123"
}

Example Response¶

{
  "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "tag": null,
  "network": "bitcoin",
  "currency": "BTC"
}

For currencies that require a tag/memo (like XRP, XLM, EOS):

{
  "address": "rLW9gnQo7BQhU6igk5keqYnH3TVrCxGRzm",
  "tag": "123456",
  "network": "ripple",
  "currency": "XRP"
}

Full example response:

{
  "currency": "USDT",
  "method": "USDTERC20",
  "callback_url": "https://example.com/test_callback",
  "custom_id": "1121212",
  "address": "0x1f5CE5FBFe3E9af3971dD833D26BA9b5C936f7bE",
  "tag": null,
  "label": null,
  "received_amount_usdt": "0.00000000",
  "received_count": 0,
  "received_count_success": 0,
  "assigned_at": "2025-09-04T13:06:40.622038Z"
}

Response Fields¶

List Deposits¶

Returns a list of deposits.

GET /deposit

Required Permissions¶

• allow_deposit

Rate Limit¶

600 requests per minute

Query Parameters¶

Response¶

The API uses a standard offset-based pagination system with limit and offset parameters. The response is a direct array of deposit objects without pagination metadata wrapper.

[
  {
    "code": "DEP123456",
    "custom_id": "my-deposit-123",
    "callback_url": "https://example.com/callbacks/deposits",
    "created_at": "2023-01-15T14:30:15Z",
    "updated_at": "2023-01-15T14:35:20Z",
    "done_at": "2023-01-15T14:35:20Z",
    "method": "BTC",
    "network": "bitcoin",
    "contract": null,
    "status": "success",
    "reason_code": null,
    "reason_message": null,
    "currency": "BTC",
    "coin": "BTC",
    "amount": "0.05000000",
    "fee_amount": "0.00000000",
    "actual_confirmations": 3,
    "required_confirmations": 2,
    "txid": "7b5968e39e0d4c980a234931b8a2fd21e804eb7e9f7eb5af75b3d89e2972ad3d",
    "attributes": {
      "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
    }
  }
  // More deposits...
]

Response Fields¶

Pagination¶

The API uses simple offset-based pagination with limit and offset parameters. Offset is limited for maximum 10000, if you set more - error will be returned. The default limit is 100, and the maximum limit is 200. The response is a direct list of deposit objects without pagination metadata wrapper. If you need to fetch more than 200 deposits, you should use the start_at and end_at parameters to fetch deposits in smaller date ranges. List is sorted by creation date in descending order.

Deposit Status Values¶

Confirmation Status¶

Note that not only actual_confirmations need to be higher than required_confirmations to mark the deposit as success. But we also do additional checks on the deposit such as AML screening. If the deposit is marked as pending or quarantine, it means that the deposit is still in the process of being confirmed.

Get Deposit Details¶

Returns details of a specific deposit.

GET /deposit/{code}

Required Permissions¶

• allow_deposit

Rate Limit¶

600 requests per minute

Path Parameters¶

Response¶

Same as a single deposit object from the list endpoint.

Callback Notifications¶

If a callback_url was provided when generating the deposit address, the system will send POST requests to this URL when the deposit status changes.

Important Note: You may not receive callbacks for every intermediate status change or field update if changes occur very rapidly. When operations transition through multiple states quickly, intermediate callbacks may be skipped. However, you will always receive callbacks for the final states of operations. Design your callback handling to be idempotent and not dependent on receiving every single state transition.

Currently, callbacks are not signed. The signature mechanism for callbacks is planned for a future update. You should validate callback data by making an authenticated API request to verify the deposit status.

Callback Payload¶

The callback payload contains the same data as the deposit details response, with essential fields for status updates:

{
  "code": "DEP123456",
  "custom_id": "my-deposit-123",
  "created_at": "2023-01-15T14:30:15Z",
  "updated_at": "2023-01-15T14:35:20Z",
  "done_at": "2023-01-15T14:35:20Z",
  "status": "success",
  "reason_code": null,
  "reason_message": null,
  "currency": "BTC",
  "amount": "0.05000000",
  "fee_amount": "0.00000000",
  "txid": "7b5968e39e0d4c980a234931b8a2fd21e804eb7e9f7eb5af75b3d89e2972ad3d",
  "attributes": {
    "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
  }
}

Securing Callbacks¶

Since callbacks are not currently signed, you should implement these security measures:

1. Whitelist IPs: Accept callbacks only from the service's IP addresses. Contact support to get the list of server IPs.
2. Verify Data: Always make an authenticated API request to /deposit/{code} to verify the status and details of any deposit after receiving a callback.
3. Use HTTPS: Ensure your callback URL uses HTTPS to encrypt the data in transit.

Common Use Cases¶

• Generating deposit addresses: Create addresses for user deposits
• Monitoring deposits: Track the status of incoming deposits
• Reconciling deposits: Verify that deposits have been correctly credited to your account