Skip to content

Crypto withdrawals#

Withdrawal endpoint#

Make a withdrawal request using the API V.2 endpoint (see the withdrawal initiation with API page for the full OpenAPI specification):

POST https://api.xgateway.tech/api/v2/withdrawal

Required Payload#

To initiate a withdrawal in any Crypto currency, please provide the following parameters in the withdrawal request

Withdrawal currency must be specified using the unique currency code from the supported currencies list (see the Currency column there). Cryptocurrencies with the same currency symbol can be deployed on different networks and under different contracts. Use network-specific currency codes, such as pUSDC for a Polygon-based asset, to avoid ambiguity.

Parameter Mandatory Description
amount true String representation of requested amount.
applicationId false Application ID in case the application is used
customerId true Customer id in the merchant system
orderId false Invoice id in the merchant system. If provided, used as an idempotency key.
currency true String representation of the requested currency.
address true Customer's crypto address to withdraw
Payload example
{
    "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
    "currency": "ETH",
    "amount": "0.1",
    "customerId": "test_customer_id"
}

Ensure that no additional parameters, except those specified above, are passed into the withdrawal request.