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

POSThttps://ocp.onchainpay.io/api-gateway/withdrawal-fee-token

Header parameters

Body

application/json

advancedBalanceId*string

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

Example: "882f4ed6-82c8-43c3-8dd6-d755cee5f1af"

addressId*string

Identifier of the address from which you want to withdraw

Example: "7504dcc8-e87e-4dce-862f-0a9b765bfbda"

amount*string

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.

Response

200

Body

application/json

success*boolean

Request success indicator

response*RequestFeeResponse (object)

Commission request body

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/withdrawal-fee-token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "advancedBalanceId": "882f4ed6-82c8-43c3-8dd6-d755cee5f1af",
      "addressId": "7504dcc8-e87e-4dce-862f-0a9b765bfbda",
      "amount": "200"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "blockchainFeeCurrencyUSDRate": "12.764",
    "blockchainFeeCurrency": "USDT",
    "withdrawalCurrencyUSDRate": "12.764",
    "blockchainFeeSource": "advanced_balance",
    "blockchainFee": "8.88",
    "blockchainFeeUSD": "8.88",
    "serviceFee": "1.2",
    "serviceFeeUSD": "1.2",
    "withdrawalMin": "2.0000",
    "token": "U2FsdGVkX1/HInxRRDw862yq99ADZYMCzRCzZHxJdtdmbrSG6gCu57o+o0uNC3F+TSdU3b/YEoa8TinqJQn50XezX0GJilDlQrKRYqRu3AGjqjK3YUQCnx84P+tKO/sMJmx6XAyqC9FYSV4XikgSPTIb3B/PbLPf2eXUnGDUhHc=",
    "until": "2024-11-07T12:41:09.817Z"
  }
}