Skip to main content
POST
Estimate Payout Fee

Authorizations

X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Headers

Api-Version
enum<string>
default:2024-12-01
required

AxisFi API contract version

Available options:
2024-12-01

Body

application/json

Payout fee estimation request. Provide exactly one of source_amount and target_amount.

quote_id
string
required

Quote ID

Maximum string length: 64
Example:

"quote_f91fafe4b4fb463c8d0b04a90fece464"

payout_details
object
required

Payout routing details used to select the payout fee

source_amount
number | null

Source currency amount. Provide either source_amount or target_amount, but not both.

Required range: 0.01 < x < 100000000
Example:

1000

target_amount
number | null

Target currency amount. Provide either source_amount or target_amount, but not both.

Required range: 0.01 < x < 100000000
Example:

990

Response

Operation Successful

Payout fee estimation response

quote_id
string

Quote ID

Example:

"quote_f91fafe4b4fb463c8d0b04a90fece464"

source_amount
number

Total amount deducted in the source currency

Example:

1000

target_amount
number

Net amount received in the target currency

Example:

990

exchange_rate
number

Customer exchange rate

Example:

1.005

exchange_fee
number

Exchange fee in the source currency

Example:

2.5

payout_fee
number

Payout fee in the source currency

Example:

5

payout_fee_currency
string

Currency of payout_fee

Example:

"USDT"

valid_to
string<date-time>

Quote expiration time

remaining_seconds
integer<int64>

Remaining seconds before expiration

Example:

180