HomeGuidesRecipesAPI ReferenceChangelog
Log In
Guides
These docs are for v2.1.7. Click to read the latest docs for v2.2.2.

How to configure fees

This guide is designed to provide full visibility on how to configure fees via the Unblock API. We would like to guarantee a clear and detailed overview of the fees associated with our services, ensuring transparency and ease of understanding. Whether you are exploring our offerings for the first time or are a long-standing client, this guide will help you navigate our fee structure with confidence and clarity.

How to configure the fee values

The following APIs can be used to configure the value of the charges:

<https://docs.getunblock.com/reference/patch_merchant-fees> Allows to set up fee value for all users' transactions.

<https://docs.getunblock.com/reference/patch_user-fees> Allows to set up fee value per user uuid.

Only Merchant's fees are subject to configuration using defined endpoints. Unblock's fees are always charged independent of the transaction amount.

Fee value always comes as a decimals and should reflect the % (Example: fee_value: 0.01is a 1% fee)

It's allow to set up an amount with maximum two decimal places, when you will try to set up lower value you will receive an error: _“minimum_fee must be a number conforming to the specified constraints“.

The fee configuration can be specified per input_currency, output_currency and associated direction.

There are two types of fee: "fee_op_type": "add" and "fee_op_type": "subtract"

Add Fee Type

It allows you to increase the fee value per each transaction or for a specific customer. Your user will pay extra for each transaction, if you apply "fee_op_type": "add". The extra amount that is charged is, of course, owed to you by Unblock.

Subtract Fee Type

📘

This feature is NOT active by default for Merchants

To activate the feature, please get in touch with Unblock team.

It allows you to decrease fee value per each transaction or for a specific customer. Your user will pay less for each transaction, if you apply "fee_op_type": "subtract".

subtract fee type indicates the process of debt execution versus Unblock, which means that the amount that was not charged to the user, will be charged to you, the merchant. Each month the difference in charges will be collected in invoices.

By default this option is disabled. When you will try to change the fee type to "subtract" we will return a 400 with error message: In order to enable negative fees please contact unblock operation team.

Minimum Fee

If the minimum_fee parameter is set, the merchant fee to be applied to a transaction with the associated parameters will be the maximum value between the minimum fee and the merchant fee calculated on transaction processing.

You can set up the minimum_fee parameter as a FIXED value. By default the minimum_fee value = 0

Only Merchant's fees are subject to configure minimum_feevalue. Unblock's fees are always charged independent of the transaction amount.

The minimum_fee currency will be reflected by the input_currency as all the other fees.

Examples:

  • If you configure a minimum_fee of 2 where the direction is OFFRAMP and input_currency is USD, that means each USDC/USDT offramp transaction will have a minimum fee of 2 USDC/USDT.
  • If you configure a minimum_fee of 1 where the input_currencyis EUR, that means that every EUR Onramp and every EUR-backed stablecoin Offramp (like agEUR) will have a minimum fee of 1 EUR

Maximum Fee

📘

This feature is active by default for all Merchants and can't be changed

The maximum fee limitation will not let you to set up fees value higher then Unblock fee value in the cases where fee_op_type is subtract.

The maximum fee value configuration is specified for each property configuration, counting input_currency, output_currency and direction.

When you enter a fee amount that exceeds the maximum amount, we will return 400 with error message: Value exceeds the maximum limit for the subtracted fee.