Basic crypto operations

Every request listed on this page requires authorization to be successfully completed.

Create permanent deposit address

POST https://public.api.0xpay.app/merchants/addresses

As said previously, you can generate new deposit addresses with receiving addresses feature. For BEP20 & ERC20 networks: on creation, one wallet address will be generated and assigned for both networks, and monitored for incoming transactions.

Deposit Updates: After a receiving address is created on a dedicated blockchain, 0xpay will notify you about incoming transactions for all the assets supported on this blockchain.

Request Body

{
  "address":  "0x8EB871bbB6F754a04bCa23881A7D25A30aAD3f23",
  "meta":  "some-user-id",
  "blockchain":  "ETHEREUM"
}

Create rotating deposit address

POST https://public.api.0xpay.app/merchants/rotating-addresses

As said previously, you can generate new deposit addresses with receiving addresses feature.

An address will be active until the first incoming transaction is received, or for a specified timeframe (set with duration parameter)

Deposit Updates: After a receiving address is created on a dedicated blockchain, 0xpay will notify you about an incoming transaction for all the assets supported on this blockchain.

Request Body

{
  "meta":  "some-user-id",
  "address":  "0x8EB871bbB6F754a04bCa23881A7D25A30aAD3f23",
  "duration": 16508758624753,
}

Send cryptocurrency

POST https://public.api.0xpay.app/merchants/withdrawals/crypto

Creates an outgoing cryptocurrency transaction. 0xpay API will produce notifications according to status updates on your withdrawal.

Request Body

{
    "id": "123e4567-e89b-12d3-a456-426614174000" //internal ID has been assigned to the tx
}

Withdrawal fee

GET https://public.api.0xpay.app/merchants/withdrawals/crypto/fee

This method is used to get a fee for sending a desired amount of assets (ticker) on a chosen blockchain. Learn how fees work here

Request Body

{
  "value":  "0.1" //decimal fee value
}

Replenishment risk score

GET https://public.api.0xpay.app/merchants/replenishment/crypto/:id/compliance

This method is used to get replenishment risk score by it's id.

We recommend you to check risk score in 5 minutes after transaction is being broadcasted to blockchain.

{
    "url": "https://yourreport.com",
    "signals": {
        "atm": 0,
        "ico": 0,
        "scam": 0,
        "miner": 0,
        "mixer": 0,
        "other": 0,
        "ransom": 0,
        "wallet": 0,
        "payment": 0,
        "exchange": 0,
        "gambling": 0,
        "sanctions": 0,
        "fraud_shop": 0,
        "dark_market": 0,
        "marketplace": 0,
        "dark_service": 0,
        "p2p_exchange": 0,
        "stolen_coins": 0,
        "seized_assets": 0,
        "risky_exchange": 0,
        "smart_contract": 0,
        "illegal_service": 0,
        "liquidity_pools": 0,
        "online_pharmacy": 0,
        "unnamed_service": 0,
        "lending_contract": 0,
        "protocol_privacy": 0,
        "special_measures": 0,
        "illicit_actor_org": 0,
        "merchant_services": 0,
        "child_exploitation": 0,
        "enforcement_action": 0,
        "exchange_fraudulent": 0,
        "exchange_mlrisk_low": 0,
        "terrorism_financing": 0,
        "exchange_mlrisk_high": 0,
        "token_smart_contract": 0,
        "high_risk_jurisdiction": 0,
        "p2p_exchange_mlrisk_low": 0,
        "exchange_mlrisk_moderate": 0,
        "exchange_mlrisk_veryhigh": 0,
        "p2p_exchange_mlrisk_high": 0,
        "infrastructure_as_a_service": 0,
        "decentralized_exchange_contract": 0
    },
    "riskScore": 0,
    "timestamp": 1686991713000
}

Withdrawal risk score

GET https://public.api.0xpay.app/merchants/withdrawals/crypto/:id/compliance

This method is used to get withdrawal risk-score by it's id.

{
    "url": "https://yourreport.com",
    "signals": {
        "atm": 0,
        "ico": 0,
        "scam": 0,
        "miner": 0,
        "mixer": 0,
        "other": 0,
        "ransom": 0,
        "wallet": 0,
        "payment": 0,
        "exchange": 0,
        "gambling": 0,
        "sanctions": 0,
        "fraud_shop": 0,
        "dark_market": 0,
        "marketplace": 0,
        "dark_service": 0,
        "p2p_exchange": 0,
        "stolen_coins": 0,
        "seized_assets": 0,
        "risky_exchange": 0,
        "smart_contract": 0,
        "illegal_service": 0,
        "liquidity_pools": 0,
        "online_pharmacy": 0,
        "unnamed_service": 0,
        "lending_contract": 0,
        "protocol_privacy": 0,
        "special_measures": 0,
        "illicit_actor_org": 0,
        "merchant_services": 0,
        "child_exploitation": 0,
        "enforcement_action": 0,
        "exchange_fraudulent": 0,
        "exchange_mlrisk_low": 0,
        "terrorism_financing": 0,
        "exchange_mlrisk_high": 0,
        "token_smart_contract": 0,
        "high_risk_jurisdiction": 0,
        "p2p_exchange_mlrisk_low": 0,
        "exchange_mlrisk_moderate": 0,
        "exchange_mlrisk_veryhigh": 0,
        "p2p_exchange_mlrisk_high": 0,
        "infrastructure_as_a_service": 0,
        "decentralized_exchange_contract": 0
    },
    "riskScore": 0,
    "timestamp": 1686991713000
}

Available crypto assets

GET https://public.api.0xpay.app/merchants/assets/crypto/

This method is used to fetch all available crypto assets of your merchant. You can learn about available assets here.

//In response, you'll get an Array of all assets with their ticker , name, price, and blockchain network: 
[
    {
        "name": "Bitcoin", 
        "ticker": "BTC",
        "blockchains": [
            "BITCOIN"
        ],
        "price": {
            "value": "29931",
            "ticker": "USD"
        }
    },
    {
        "name": "Ethereum",
        "ticker": "ETH",
        "blockchains": [
            "ETHEREUM"
        ],
        "price": {
            "value": "1797.26",
            "ticker": "USD"
        }
    },
    {
        "name": "BNB",
        "ticker": "BNB",
        "blockchains": [
            "BINANCE_SMART_CHAIN"
        ],
        "price": {
            "value": "301.54",
            "ticker": "USD"
        }
    }
 ]

Last updated