Commission pre-calculation

This method calculates the estimated fee for a payout transaction based on the provided parameters. It allows clients to preview the fee before making a payout, providing additional options for collecting fees from users and planning expenses.

With this method, you can calculate the transaction fee and:

  • Pass the entire fee to the user.

  • Pass only the fixed fee to the user.

  • Pass only the percentage fee to the user.

feeType
Description

SERVICE

In the response to the pre-calculation for payments, in the "feeReceiver" data, the "amount" will include all transaction fees paid by the user. The "fee" parameter will contain the total amount of fees for this transaction.

FIX

In the fee calculation response, the "amount" parameter in the "feeReceiver" data will include the fixed transaction fee paid by the user.

The "fee" parameter will contain the total fee for this transaction, and the "fixedFee" parameter will contain the fee the user will pay.

PERCENT

In the fee calculation response, the "amount" parameter in the "feeReceiver" data will include the percentage transaction fee paid by the user.

The fee parameter will contain the total fee for the transaction, and the "percentFee" parameter will contain the fee the user will pay.

Pre-calculate payout commission payout via API

1

To shift the commission to the user, select one of the values "feeType" ​​from the table above, send a request with the payout amount, payout currency and opType of "WITHDRAWAL" - extended-fee

2

In response you will receive a calculation of the commission in the amount of the payout and on top of the payout amount:

  • If you want to receive a calculation where the entire commission will be included in the payout amount or partially paid by the user, look in the "feeReceiver" parameters;

  • If in the calculation you want to get where the commission amount will be calculated on top of the payment amount, look at the "feeSender" parameters, to create a payment sum up the "amount" and "fee" parameters.

Request example:

Body parameters
Type
Field
Description

baseAmount

number

required

Payout amount for commission calculation

currency

string

required

The currency in which the payment will be made

opType

string

required

To make pre-calculate payout , you must select the type - "WITHDRAWAL"

feeType

string

required

Commission type to be passed on to the user: - FIX - PERCENT - SERVICE

{
  "timestamp": 1,
  "payload": {
    "items": [
      {
        "baseAmount": 1000,
        "currency": "USDT",
        "opType": "WITHDRAWAL",
        "feeType": "SERVICE"
      }
    ]
  }
}-

Response example 200 OK:

Body parameters
Type
Field
Description

feeReceiver/"amount"

number

required

The amount that the recipient's address will receive

feeReceiver/"fee"

number

required

The sum of all fees for the transaction.

feeReceiver/"fixedFee"

number

required

Fixed commission per transaction.

feeReceiver/"percentFee"

number

required

Percentage commission for the transaction.

feeSender/"amount"

number

required

The amount that the recipient's address will receive

feeSender/"fee"

number

required

The sum of all fees for the transaction.

feeSender/"fixedFee"

number

required

Fixed commission per transaction.

feeSender/"percentFee"

number

required

Percentage commission for the transaction.

{
    "items": [
        {
            "amount": 1000.00,
            "currency": "USDT",
            "opType": "WITHDRAWAL",
            "feeReceiver": {
                "amount": 934.58,
                "fee": 65.42,
                "fixedFee": 18.00,
                "percentFee": 47.42
            },
            "feeSender": {
                "amount": 1000.00,
                "fee": 70.00,
                "fixedFee": 18.00,
                "percentFee": 52.00
            }
        }
    ]
}

Last updated