Skip to main content
POST
Create Withdrawal Fee

Authorizations

Authorization
string
header
required

B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow:

  • clientCredentials allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication.

Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token.

Every request must be accompianed by an Authorization header with a value that follows the following schema: Bearer ACCESS_TOKEN

Body

application/json
currency
string
required

Currency to estimate the fee for. It needs to be the same currency as the one used later for the withdrawal. The fee in the response will be expressed in this currency.

network
string
required

The blockchain network in which the withdrawal fee needs to be estimated, passed as the network's enum member name (e.g. "ETHEREUM", not "ethereum"). The later withdrawal must be performed in the same network.

address
string

Destination address of the later withdrawal. Optional; only HYPERCORE prices anything off it. With an address, the activation fee is charged only if HyperCore has never seen that address, and the withdrawal must then go to that same address. Without one, the activation fee is always charged on HYPERCORE, since it cannot be ruled out.

Response

201 - application/json

Created

id
string<uuid>

UUID used as the withdrawal fee identifier.

gas_price
string<decimal> | null

Estimated network gas price for this fee, expressed in the requested currency. Returned as "0" whenever the account subsidizes gas for this currency/network.

activation_fee
string<decimal>

One-off fee HYPERCORE charges the first transfer to an address that has never received funds, expressed in the requested currency. "0" on every other network, and on HYPERCORE when the address is already active. It is charged on top of the amount and is not subsidized with the gas.

expires_at
string<date-time> | null

ISO DateTime indicating expiration date of the withdrawal fee. The fee can no longer be used to perform a withdrawal after this date.

currency
string

Currency the fee was estimated for.

network_name
string | null

Blockchain network the fee was estimated for.

address
string | null

Destination address the fee was priced for, or null if none was sent. A withdrawal using this fee must go to this address.