🔒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

Authorizations

Body

businessIdstring · uuidrequired

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

clientWithdrawalIdstringrequired

Withdrawal identifier provided by the merchant.

recipientAddressstringrequired

Wallet address of the recipient.

destinationTagstring

XLM/XRP destination tag.

networkstring · enum

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.

These are the following networks supported for each currency.

Options: BCH, BTC, LTC, XLM, XRP, ETH, BSC, SOL, TRX

withdrawCurrencystring · enumrequired

Cryptocurrency that will be withdrawn.

Options: BCH, BTC, ETH, LINK, LTC, SOL, USDC, XLM, XRP

displayCurrencystring · enumrequired

Fiat currency.

Options: AED, ARS, AUD, BDT, BGN, BRL, CAD, CHF, CLP, CNY, CZK, DKK, EUR, GBP, HKD, HRK, HUF, IDR, ILS, INR, ISK, JPY, KES, KRW, MXN, MYR, NGN, NOK, NZD, PEN, PHP, PLN, QAR, RON, RUB, SEK, SGD, THB, TRY, USD, VND, ZAR

targetAmountPolicystring · enumrequired

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

Options: CRYPTO, FIAT

targetAmountstringrequired

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

withdrawalAccountstring · enum · default: the organisation's default setting

Specifies which balance account should be charged for the withdrawal.

Options: CRYPTO, FIAT

blockchainFeePaidBystring · enum · default: the business' default setting

Specifies who pays the blockchain fee for the withdrawal.

Options: USER, MERCHANT

travelRuleBeneficiaryone of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/withdrawals' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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",
    "travelRuleBeneficiary": {
      "entityType": "NATURAL_PERSON",
      "personalIdentityName": "Person Name",
      "nationalIdentifier": "123",
      "nationalIdentifierType": "LEIX",
      "nameIdentifierType": "LEGL"
    }
  }'

201

202

201

Initiate with display amount.

Initiate with deposit amount.

Initiate with display amount.

{
  "withdrawId": "5724d752-6084-3822-9590-a6ccdf91f603",
  "clientWithdrawId": "test-withdrawal-23-12-19-2",
  "recipientAddress": "0x5CF631Db2eB6be3eecB5E9fD0f31a19AC0F4C504",
  "network": "BSC",
  "initiatedBy": "[e-mail]",
  "status": "PENDING",
  "displayCurrency": "EUR",
  "estimatedDisplayAmount": "21",
  "displayServiceFee": "0.25",
  "withdrawCurrency": "USDC",
  "estimatedWithdrawAmount": "23.01742298",
  "settlementCurrency": "EUR",
  "settlementDeductedAmount": "21.25",
  "settlementServiceFee": "0.25",
  "uniformCurrency": "EUR",
  "uniformAmount": "21",
  "uniformServiceFee": "0.25",
  "createdAt": 1702999367
}

Withdrawal request created successfully.

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"
 }

More details about the fields required as part of the travelRuleBeneficiary data can be found under National Identifier Types info page and Name Identifier Types info page

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