Skip to main content
POST

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Body

application/json

The request body for fee estimation.

estimate_fees
object[]
required

A list of token IDs and amounts for which fees will be calculated.

fee_type
enum<string>

The fee type. Possible values include:

  • Order: Fees for order processing.
  • Refund: Fees for refund processing.
  • CryptoSettlement: This fee type is deprecated. Please use CryptoPayout instead.
  • OffRampSettlement: This fee type is deprecated. Please use OffRampPayout instead.
  • CryptoPayout: Fees for crypto payouts.
  • CryptoPayoutBridge: Fees for crypto payouts with cross-chain bridging.
  • OffRampPayout: Fees for fiat off-ramp payouts.
Available options:
Order,
Refund,
CryptoSettlement,
OffRampSettlement,
CryptoPayout,
CryptoPayoutBridge,
OffRampPayout
Example:

"Order"

recipient_token_id
string

The token ID that the recipient will receive. Required only when fee_type is CryptoPayoutBridge.

transfer_via_va
boolean

For OffRamp payout, whether the payout is transferred to a registered bank account via a virtual account (VA) or directly.

  • true: The payout is transferred to a registered bank account via a VA (virtual account).
  • false: The payout is transferred directly to a registered bank account.
Example:

false

bank_account_id
string<uuid>

The bank account ID, which you can retrieve by calling List counterparty entries.

Example:

"123e4567-e89b-12d3-a456-426614174003"

Response

The request was successful.

data
object[]

A list of estimated fees for the requested operations.

otc_fixed_fee
string

The fixed OTC fee amount for the payout.

This fee is charged in addition to the percentage-based OTC fee calculated using otc_fee.fee_rate.

Example:

"10.00"