Getting a commission for making a withdrawal

The method allows you to get data on the commission that will be debited during the withdrawal

Getting a commission for making a withdrawal

post

/api-gateway/withdrawal-fee-token

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

advancedBalanceIdstringrequired

Identifier of the advance balance from which the commission will be paid

Example: 1503cf18-597f-447f-b172-112dfe377e1b

addressIdstringrequired

Identifier of the address from which you want to withdraw

Example: 42a54680-0511-4aa0-ba46-5cf1b7de1fd3

amountstringrequired

Amount you want to withdraw

Example: 200

nativeboolean

Deduct the gas fee (network fee) from the native balance of the address (available for payment addresses, PAY_OUT type)

feeInAmountboolean

(Relevant for withdrawing coins) Deduct the network commission from the withdrawal amount or from the payer's funds. By default, the network commission is deducted from the withdrawal amount.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/withdrawal-fee-token' \
  --header 'Content-Type: application/json' \
  --data '{"advancedBalanceId":"1503cf18-597f-447f-b172-112dfe377e1b","addressId":"42a54680-0511-4aa0-ba46-5cf1b7de1fd3","amount":"200"}'

200

200

{
  "success": true,
  "response": {
    "blockchainFeeCurrencyUSDRate": "12.764",
    "blockchainFeeCurrency": "USDT",
    "withdrawalCurrencyUSDRate": "12.764",
    "blockchainFee": "8.88",
    "blockchainFeeUSD": "8.88",
    "serviceFee": "1.2",
    "serviceFeeUSD": "1.2",
    "withdrawalMin": "2.0000",
    "token": "U2FsdGVkX18zwuJHC+JzLQLOeFMPozM2diobszws+xbhUjrQ9nmxW0R7FWHWETqc1Z2VFpvftm/pMiQ27CUmbDl7mTNmcPZmZViPc3b7kdZuToWPQl+xuabnnkHCB3WpS4vDP0D/bu9fgOsKswzivs220+CORn1sM44k0eY9CsM=",
    "until": "2024-12-26T08:21:33.206Z",
    "blockchainFeeSource": "advanced_balance"
  }
}