🔒Request crypto withdrawal

Request crypto withdrawal

An endpoint for initiating cryptocurrency withdrawals. The amount can be selected either in fiat or crypto which is defined by the targetAmountPolicy. When FIAT is selected as policy the resulting amount of the withdrawal in crypto will be calculated according to the fiat amount passed in targetAmount field. When CRYPTO is selected as policy the resulting amount of the withdrawal will be exactly the same as the amount passed in targetAmount field (subject to a negligible difference due to market conditions i.e. market step size)

POST/api/v1/withdrawals

Authorization

ApiKeyAuth

Body

application/json

businessId*string (uuid)

ID of the business from which the withdrawal should be executed.

clientWithdrawalId*string

Withdrawal identifier provided by the merchant.

recipientAddress*string

Wallet address of the recipient.

destinationTagstring

XLM/XRP destination tag.

networkenum

Specifies the network that should be used in this withdrawal.

For ERC20 Tokens you can choose between ETH, TRX and BSC as values for the network field. ETH stands for Ethereum network. This will be set as the default value when none is provided. TRX stands for TRON network. Before executing any withdrawals through this network, please make sure your address supports it. BSC stands for Binance Smart Chain. Before executing any withdrawals through this network, please make sure your address supports it.

BCHBTCLTCXLMXRPETHBSCSOLTRX

withdrawCurrency*enum

Cryptocurrency that will be withdrawn.

BCHBNBBTCETHLINKLTCSOLTRXUSDCXLMXRP

displayCurrency*enum

Fiat currency.

AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR

targetAmountPolicy*enum

Specifies if the targetAmount will be requested in fiat or crypto.

CRYPTOFIAT

targetAmount*string

The requested amount to be withdrawn in fiat or crypto, depending on the provided targetAmountPolicy.

withdrawalAccountenum

Specifies which balance account should be charged for the withdrawal.

CRYPTOFIAT

blockchainFeePaidByenum

Specifies who pays the blockchain fee for the withdrawal.

USERMERCHANT

Response

201202

Withdrawal request created successfully.

Body

application/json

withdrawId*string (uuid)

clientWithdrawId*string

Withdrawal identifier provided by the merchant.

recipientAddress*string

Wallet address of the recipient.

recipientTagstring

XLM/XRP destination tag.

network*enum

Network on which this withdrawal was initiated.

BCHBTCLTCXLMXRPETHBSCSOLTRX

initiatedBy*string

Initiator of the withdrawal request. When initiated from the Dashboard, the dashboard user's email is stored. When initiated from API, the backend URL is stored.

status*enum

PENDINGCOMPLETEDFAILEDBLOCKED

displayCurrency*enum

Fiat currency.

AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR

estimatedDisplayAmount*string

Amount in displayCurrency requested for this withdrawal.

displayServiceFeestring

Amount debited for fees from the merchant's balance in displayCurrency.

withdrawCurrency*enum

Cryptocurrency to be withdrawn.

BCHBNBBTCETHLINKLTCSOLTRXUSDCXLMXRP

estimatedWithdrawAmount*string

Estimated amount for this withdrawal. Can be different than actualWithdrawAmount.

settlementCurrency*enum

Currency in which the merchant's account was debited. Can be either fiat or cryptocurrency.

BTCUSDCEURGBPUSD

settlementDeductedAmount*string

Amount debited from the merchant's balance in settlementCurrency.

settlementServiceFee*string

Amount debited for fees from the merchant's balance in settlementCurrency.

uniformCurrency*string

Always EUR.

uniformAmount*string

Amount in uniformCurrency requested for this withdrawal.

uniformServiceFeestring

Amount debited for fees from the merchant's balance in uniformCurrency.

createdAt*integer (int64)

UNIX seconds at which the withdrawal was requested.

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/withdrawals', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "businessId": "407710f4-de33-454b-a47f-dda792e272c8",
      "clientWithdrawalId": "test-withdrawal-23-12-19-2",
      "recipientAddress": "0x5CF631Db2eB6be3eecB5E9fD0f31a19AC0F4C504",
      "network": "BSC",
      "withdrawCurrency": "USDC",
      "displayCurrency": "EUR",
      "targetAmount": "21",
      "targetAmountPolicy": "FIAT",
      "withdrawalAccount": "FIAT"
    }),
});
const data = await response.json();

Response

201202

{
  "withdrawId": "123e4567-e89b-12d3-a456-426614174000",
  "clientWithdrawId": "text",
  "recipientAddress": "text",
  "recipientTag": "text",
  "network": "BCH",
  "initiatedBy": "text",
  "status": "PENDING",
  "displayCurrency": "AED",
  "estimatedDisplayAmount": "text",
  "displayServiceFee": "text",
  "withdrawCurrency": "BCH",
  "estimatedWithdrawAmount": "text",
  "settlementCurrency": "BTC",
  "settlementDeductedAmount": "text",
  "settlementServiceFee": "text",
  "uniformCurrency": "text",
  "uniformAmount": "text",
  "uniformServiceFee": "text"
}

Crypto withdrawal where an additional approval is required

In some cases, a crypto withdrawal might require additional approvals before being send out. This will also alter the response status code to 202 and body when a crypto withdrawal is initiated and it will look as seen below:

{
 "clientLabel" : "withdrawal-id-test-1",
 "withdrawalId" : "6f2ff05e-1c06-392a-8346-bd07d8540828"
 }

List of currencies and their supported withdrawal networks

Currency	Supported networks
BTC	BTC
BCH	BCH
ETH	ETH, BSC
LINK	ETH
LTC	LTC
USDC	ETH, BSC, SOL
XLM	XLM
XRP	XRP
SOL	SOL