Exchange + Withdrawal

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

Feature currently in beta

Estimate Crypto Exchange+Withdrawal

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

You can use this endpoint to estimate your withdrawal with exchange for later creation

Query Parameters

Name	Type	Description
ticker*	string	Ticker for withdrawal. Example: You want to spend (exchange) USDT and make a withdrawal in BTC (ticker value). Find values using #list-all-supported-crypto-assets
spendTicker*	string	Ticker you want to spend (exchange) from your balance. Find values using #list-all-supported-crypto-assets or #list-all-supported-fiat-assets
amount*	string	Amount you want to spend or withdraw. For more details look at side field in this request.
side*	string	"spend" or "withdraw". Impacts amount field. When you want to withdraw the exact amount – specify the "withdraw" side. When you want to spend (exchange) an exact amount specify "exchange"
blockchain*	string	available values you can find here ("API value" column)

200: OK Exchange estimate calculated

In response, you'll get details for your upcoming exchange:

{
    "withdraw": {
        "ticker": "USDT", //ticker you want to withdraw after exchange
        "amount": "1493.32" //amount you want to withdraw
        "fee": "123" //withdraw fee, included in withdraw.amount
    },
    "spend": {
        "ticker": "ETH", //ticker you want to spend
        "amount": "1" //amount you want to spend from your balance
    },
    "exchange": {
      "amount": "0.9", // amount to be exchanged
      "fee": "0.1" //exchange fee, included in spend.amount
    },
    "price": {
        "value": "1534.00000000", //actual price of the pair                                
        "pair": [
            "ETH",        //1 ETH == 1534 USDT
            "USDT"
        ]
    },
}

400: Bad Request Description of error codes

//List of Error codes with descriptions
//0 – Order validation error
//1 – Ticker pair not allowed
//2 – Withdraw amount too low
//3 – Not enough liquidity
{
    "code": 1,
    "description": "Ticker pair not allowed"
}

Create Crypto Exchange+Withdrawal

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

This endpoint is used to create exchange withdrawal. Before sending this request, you should first estimate your exchange+withdrawal using the endpoint.

Status Notifications: After the Success response, 0xpay API will produce notifications according to status updates on your exchange.

Request Body

Name	Type	Description
ticker*	string	Ticker for withdrawal. Example: You want to spend (exchange) USDT and make a withdrawal in BTC (ticker value). Find values using #list-all-supported-crypto-assets
amount*	string	Amount you want to spend or withdraw. For more details look at side field in this request.
side*	string	"spend" or "withdraw". Impacts amount field. When you want to withdraw the exact amount – specify the "withdraw" side. When you want to spend (exchange) an exact amount specify "exchange"
fee*	string	withdrawal fee
price*	string	actual price of the pairs
localId	string	if was specified error will be thrown if not unique, can be useful on your side to avoid the double-spend issue
meta	string	metadata that you can define and catch it back later with notification
blockchain*	string	available values you can find here ("API value" column)
to*	string	destination of withdrawal
spendTicker*	String	Ticker you want to spend (exchange) from your balance. Find values using #list-all-supported-crypto-assets or #list-all-supported-fiat-assets
exchangeFee*	string	fee for exchange operation

200: OK Exchange + Withdrawal has been created successfully

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

Estimate Fiat Exchange+Withdrawal

GET https://public.api.0xpay.app/merchants/exchange/withdrawals/fiat/estimate

You can use this endpoint to estimate your withdrawal with exchange for later creation

Query Parameters

Name	Type	Description
ticker*	string	Ticker for withdrawal. Example: You want to spend (exchange) USDT and make a withdrawal in BTC (ticker value). Find values using #list-all-supported-fiat-assets
spendTicker*	string	Ticker you want to spend (exchange) from your balance. Find values using #list-all-supported-crypto-assets or #list-all-supported-fiat-assets
amount*	string	Amount you want to spend or withdraw. For more details look at side field in this request.
side*	string	"spend" or "withdraw". Impacts amount field. When you want to withdraw the exact amount – specify the "withdraw" side. When you want to spend (exchange) an exact amount specify "exchange"
blockchain*	string	available values you can find here ("API value" column)

200: OK Exchange estimate calculated

In response, you'll get details for your upcoming exchange:

{
    "withdraw": {
        "ticker": "UAH", //ticker you want to withdraw after exchange
        "amount": "32" //amount you want to withdraw
        "fee": "10.20213" //withdraw fee, included in withdraw.amount
    },
    "spend": {
        "ticker": "USDT", //ticker you want to spend
        "amount": "1" //amount you want to spend from your balance
    },
    "exchange": {
      "amount": "0.9", // amount to be exchanged
      "fee": "0.1" //exchange fee, included in spend.amount
    },
    "price": {
        "value": "32.000", //actual price of the pair                                
        "pair": [
            "USDT",        //1 USDT == 32 UAH
            "UAH"
        ]
    },
}

400: Bad Request Description of error codes

//List of Error codes with descriptions
//0 – Order validation error
//1 – Ticker pair not allowed
//2 – Withdraw amount too low
//3 – Not enough liquidity
{
    "code": 1,
    "description": "Ticker pair not allowed"
}

Create Fiat Exchange+Withdrawal

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

This endpoint is used to create exchange withdrawal. Before sending this request, you should first estimate your exchange+withdrawal using the endpoint.

Status Notifications: After the Success response, 0xpay API will produce notifications according to status updates on your exchange.

Request Body

Name	Type	Description
ticker*	string	Ticker for withdrawal. Example: You want to spend (exchange) USDT and make a withdrawal in UAH (ticker value). Find values using #list-all-supported-fiat-assets request
amount*	string	Amount you want to spend or withdraw. For more details look at side field in this request.
side*	string	"spend" or "withdraw". Impacts amount field. When you want to withdraw the exact amount – specify the "withdraw" side. When you want to spend (exchange) an exact amount specify "exchange"
fee*	string	withdrawal fee
price*	string	actual price of the pairs
localId	string	if was specified error will be thrown if not unique, can be useful on your side to avoid the double-spend issue
meta	string	metadata that you can define and catch it back later with notification
to*	string	credit card number (destination of withdrawal)
spendTicker*	String	Ticker you want to spend (exchange) from your balance. Find values using #list-all-supported-crypto-assets or #list-all-supported-fiat-assets
exchangeFee*	string	fee for exchange operation

200: OK Exchange + Withdrawal has been created successfully

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