🔒Request crypto withdrawal

Request crypto withdrawal

post

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)

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuth

AuthorizationstringRequired

^FRX-API api-key=[^,]+,signature=[^,]+,timestamp=[\d]+$

Body

application/json

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.

destinationTagstringOptional

XLM/XRP destination tag.

networkstring · enumOptional

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.

Currency	Network
BTC	BTC
BCH	BCH
ETH	ETH, BSC
LINK	ETH
LTC	LTC
SOL	SOL
USDC	ETH, BSC, SOL
USDT	ETH, BSC, SOL, TRX
XLM	XLM
XRP	XRP

Possible values:

withdrawCurrencystring · enumRequired

Cryptocurrency that will be withdrawn.

Possible values:

displayCurrencystring · enumRequired

Fiat currency.

Possible values:

targetAmountPolicystring · enumRequired

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

Possible values:

targetAmountstringRequired

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

withdrawalAccountstring · enumOptionalDeprecated

Deprecated. Use settlementCurrency instead. Specifies which balance account should be charged for the withdrawal.

Default: the organisation's default settingPossible values:

settlementCurrencystring · enumOptional

Specifies which currency balance should be charged for the withdrawal.

Default: the organisation's default settingPossible values:

blockchainFeePaidBystring · enumOptional

Specifies who pays the blockchain fee for the withdrawal.

Default: the business' default settingPossible values:

travelRuleBeneficiaryone ofOptional

or

Responses

201

Withdrawal request created successfully.

application/json

withdrawIdstring · uuidRequired

clientWithdrawIdstringRequired

Withdrawal identifier provided by the merchant.

recipientAddressstringRequired

Wallet address of the recipient.

recipientTagstringOptional

XLM/XRP destination tag.

networkstring · enumRequired

Network on which this withdrawal was initiated.

Possible values:

initiatedBystringRequired

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.

statusstring · enumRequiredPossible values:

displayCurrencystring · enumRequired

Fiat currency.

Possible values:

estimatedDisplayAmountstringRequired

Amount in displayCurrency requested for this withdrawal.

displayServiceFeestringOptional

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

displayRateDepegLossAmountstringOptional

Loss incurred from the pegging of withdrawal and display currencies market rate in displayCurrency.

withdrawCurrencystring · enumRequired

Cryptocurrency to be withdrawn.

Possible values:

estimatedWithdrawAmountstringRequired

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

settlementCurrencystring · enumRequired

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

Possible values:

settlementDeductedAmountstringRequired

Amount debited from the merchant's balance in settlementCurrency.

settlementServiceFeestringRequired

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

settlementRateDepegLossAmountstringOptional

Loss incurred from the pegging of withdrawal and display currencies market rate in settlementCurrency.

uniformCurrencystringRequired

Always EUR.

uniformAmountstringRequired

Amount in uniformCurrency requested for this withdrawal.

uniformServiceFeestringOptional

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

uniformRateDepegLossAmountstringOptional

Loss incurred from the pegging of withdrawal and display currencies market rate in uniformCurrency.

createdAtinteger · int64Required

UNIX seconds at which the withdrawal was requested.

202

Withdrawal requested and pending approval.

application/json

post

/api/v1/withdrawals

HTTPcURLJavaScriptPython

POST /api/v1/withdrawals HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 488

{
  "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",
  "settlementCurrency": "EUR",
  "travelRuleBeneficiary": {
    "entityType": "NATURAL_PERSON",
    "personalIdentityName": "Person Name",
    "nameIdentifierType": "LEGL",
    "nationalIdentifier": "123",
    "nationalIdentifierType": "LEIX"
  }
}

Initiate with display amount.Initiate with deposit amount.

{
  "withdrawId": "5724d752-6084-3822-9590-a6ccdf91f603",
  "clientWithdrawId": "test-withdrawal-23-12-19-2",
  "recipientAddress": "0x5CF631Db2eB6be3eecB5E9fD0f31a19AC0F4C504",
  "network": "BSC",
  "initiatedBy": "[email protected]",
  "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
}