Merchant API

This document describes endpoints related to merchant account management, balances, and statistics.

Get Merchant Balances

Retrieves the current cryptocurrency balances for a merchant, including available and frozen amounts with USD conversions.

Request

GET /v1/merchants/balances

Headers

Name	Required	Description
Content-Type	Yes	Must be application/json
Merchant	Yes	Your merchant ID
Sign	Yes	Request signature (see Authentication)

Example Response

{
    "status": "success",
    "data": {
        "total_balance_usd": "62.2798",
        "total_frozen_balance_usd": "0.0000",
        "total_available_balance_usd": "62.2798",
        "balances": [
            {
                "network": "tron",
                "coin": "usdt",
                "balance": "7.85938000",
                "available_balance": "7.85938000",
                "frozen_balance": "0.00000000",
                "coin_exchange_frozen_balance": "0.00000000",
                "usd_rate": "1.0003677165865",
                "usd_value": "7.8623",
                "frozen_usd_value": "0.0000",
                "coin_exchange_frozen_usd_value": "0.0000",
                "available_usd_value": "7.8623"
            },
            {
                "network": "bsc",
                "coin": "usdt",
                "balance": "4.45500000",
                "available_balance": "4.45500000",
                "frozen_balance": "0.00000000",
                "coin_exchange_frozen_balance": "0.00000000",
                "usd_rate": "1.0003677165865",
                "usd_value": "4.4566",
                "frozen_usd_value": "0.0000",
                "coin_exchange_frozen_usd_value": "0.0000",
                "available_usd_value": "4.4566"
            }
        ]
    }
}

Response Field Descriptions

Field	Type	Description
total_balance_usd	string	Total balance across all coins and networks converted to USD
total_frozen_balance_usd	string	Total frozen balance across all coins and networks converted to USD
total_available_balance_usd	string	Total available balance (total - frozen) across all coins and networks converted to USD
balances	array	Array of balance objects for each coin/network combination
balances[].network	string	Blockchain network (e.g., “tron”, “bsc”)
balances[].coin	string	Cryptocurrency symbol (e.g., “usdt”, “usdc”)
balances[].balance	string	Total balance in human-readable format
balances[].available_balance	string	Available balance in human-readable format (total - frozen)
balances[].frozen_balance	string	Frozen balance in human-readable format (funds that cannot be withdrawn yet)
balances[].coin_exchange_frozen_balance	string	Amount reserved for in-progress exchanges
balances[].usd_rate	string	Current USD exchange rate for this coin
balances[].usd_value	string	Total balance converted to USD
balances[].frozen_usd_value	string	Frozen balance converted to USD
balances[].coin_exchange_frozen_usd_value	string	Exchange-reserved balance converted to USD
balances[].available_usd_value	string	Available balance converted to USD

Notes

• Frozen balances represent funds from recently received deposits that are on hold for 24 hours. This hold period is necessary for Anti-Money Laundering (AML) compliance checks and to prevent fraudulent transactions.
• coin_exchange_frozen_balance reflects funds currently locked by automatic exchange jobs. They are excluded from available_balance until processing completes.
• Available balance is the portion that can be withdrawn immediately (balance - frozen_balance - coin_exchange_frozen_balance).
• USD values are calculated using current exchange rates.
• The response may include zeroed entries for supported coins/networks even when no historical balance exists, allowing frontends to render consistent tables.

Get Merchant Fees

Returns the current fee settings for your merchant account.

Request

GET /v1/merchants/fees

Headers

Name	Required	Description
Content-Type	Yes	Must be application/json
Merchant	Yes	Your merchant ID
Sign	Yes	Request signature (see Authentication)

Example Response

{
    "status": "success",
    "data": {
        "service_fee_percent": "2.5",
        "static_wallet_fee_percent": "1.0",
        "withdrawal_fee_percent": "1.5",
        "pay_withdrawal_service_fee": true,
        "pay_withdrawal_network_fee": true,
        "is_auto_exchange": false,
        "auto_exchange_coin": null,
        "auto_exchange_network": null,
        "auto_exchange_min_usd_amount": null,
        "invoice_underpayment_percent": "1.0000",
        "invoice_underpayment_max_amount": null,
        "invoice_underpayment_max_currency": null,
        "network_fees": [
            {
                "network": "tron",
                "coin": "usdt",
                "network_fee": "1"
            }
        ]
    }
}

Response Field Descriptions

Field	Type	Description
service_fee_percent	string	Fee percentage applied to invoice payments
static_wallet_fee_percent	string	Fee percentage for static wallet deposits
withdrawal_fee_percent	string	Fee percentage for withdrawals
pay_withdrawal_service_fee	boolean	Whether merchant pays the service fee when withdrawing
pay_withdrawal_network_fee	boolean	Whether merchant pays the network fee when withdrawing
is_auto_exchange	boolean	Whether automatic exchange is enabled for new deposits
auto_exchange_coin	string	null	Target coin used for automatic exchanges when enabled
auto_exchange_network	string	null	Target network for automatic exchanges when enabled
auto_exchange_min_usd_amount	string	null	Minimum USD amount required to trigger an automatic exchange
invoice_underpayment_percent	string	Allowed underpayment percentage between 0 and 90 as a decimal. Both 12.2 and 12,2 mean 12.2%
invoice_underpayment_max_amount	string	Maximum underpayment amount in USD (e.g., 1.1 or 1,1 means 1.1 USD)
invoice_underpayment_max_currency	string	Currency of the maximum underpayment amount. Only USD is allowed and it defaults to this value when omitted.
network_fees	array	List of supported coins and their network fees

invoice_underpayment_max_amount may only be provided when invoice_underpayment_percent is included in the request. The currency is always USD and defaults to this value if omitted.