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

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

Request body for receiving commission

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

nativebooleanOptional

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

feeInAmountbooleanOptional

(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

objectOptional

Successful response

post

HTTPcURLJavaScriptPython

POST /api-gateway/withdrawal-fee-token HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "advancedBalanceId": "1503cf18-597f-447f-b172-112dfe377e1b",
  "addressId": "42a54680-0511-4aa0-ba46-5cf1b7de1fd3",
  "amount": "200",
  "native": true,
  "feeInAmount": true
}

200Success

{
  "success": true,
  "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": "U2FsdGVkX18zwuJHC+JzLQLOeFMPozM2diobszws+xbhUjrQ9nmxW0R7FWHWETqc1Z2VFpvftm/pMiQ27CUmbDl7mTNmcPZmZViPc3b7kdZuToWPQl+xuabnnkHCB3WpS4vDP0D/bu9fgOsKswzivs220+CORn1sM44k0eY9CsM=",
    "until": "2024-12-26T08:21:33.206Z"
  }
}