Sign in

v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Withdraw

Create withdraw request with specific withdraw amount (fee not included)

The endpoint has the similar logic as /main-account/withdraw, but with the only difference: amount that is specified will not include fee (it will be calculated to make target withdraw amount equal to the specified amount).

Example:

  • When creating a base withdraw with amount = 100 USD, the receiver receives 100 USD minus the fee, and the balance decreases by 100 USD.
  • When using this endpoint with amount = 100 USD, the receiver receives 100 USD, and the balance decreases by 100 USD plus the fee.
<Warning> Rate limit: 1000 requests/10 sec. </Warning> <Note> The API does not cache the response. </Note>
post/api/v4/main-account/withdraw-pay

Request body

tickerstring required

Currencies ticker. Example: BTC ⚠️ Currencies ticker must have "can_deposit" status equal to "true". Use Asset Status endpoint to know more about currency.

amountstring required

Withdraw amount (including fee). To add the fee to the specified amount, use the /main-account/withdraw-pay request

addressstring required

Target address (wallet address for cryptocurrencies, identifier/card token for fiat currencies)

memostring

Required if currency is memoable. See memo for details.

uniqueIdstring required

Unique transaction identifier. Any string up to 255 characters; not validated as a UUID. ⚠️ Generate a new unique ID for each withdrawal request.

providerstring

Fiat currency provider. Example: VISAMASTER ⚠️ Currency provider should be taken from Asset Status endpoint response. Required if currency is fiat.

networkstring

Cryptocurrency network. Available for multinetwork currencies. Example: OMNI ⚠️ Currency network should be taken from Asset Status endpoint response. Default for USDT is ERC20

partialEnableboolean

Optional parameter for FIAT withdrawals with increased Maximum Limit if set as "true". To use this parameter, the application must support "Partially successful" withdrawal status and latest updates in deposit/withdrawal history.

customerIpstring

End-customer IP address forwarded to the fiat provider for antifraud checks before the withdrawal is processed. ⚠️ Required if currency ticker is USD or EUR with VISAMASTER provider.

beneficiaryobject

Beneficiary information data. Required if currency ticker is one of: UAH_IBAN, USD_VISAMASTER, EUR_VISAMASTER, USD, EUR

travelRuleobject

Travel Rule information data. Required if currency is crypto and the account is from EEA

requeststring required

Request signature

nonceinteger required

Unique request identifier

Example request

{
  "ticker": "ETH",
  "amount": "0.9",
  "address": "0x0964A6B8F794A4B8d61b62652dB27ddC9844FB4c",
  "memo": "48565488244493",
  "uniqueId": "24529041",
  "provider": "VISAMASTER",
  "network": "ERC20",
  "customerIp": "203.0.113.42",
  "request": "{{request}}",
  "nonce": 1594297865000
}

Response

Validation succeeded and withdraw creation process is started. Check the request status by uniqueId in deposit/withdraw history.

{"stackTrail":"paths:/api/v4/main-account/withdraw-pay:post:responses:201:content:application/json:schema:items","oasType":"schema","type":"unknown"}