Skip to main content
POST
/
api
/
v1
/
fees
/
estimate
/
transfer
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/fees/estimate/transfer \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 25
  }'
{
  "transaction_type": "transfer",
  "payment_method": "wallet",
  "fee_enabled": true,
  "fee_breakdown": {
    "transaction_amount": "100.00",
    "application_fee": "1.00",
    "total_fees": "1.00",
    "total_amount_to_pay": "101.00",
    "net_amount": "100.00"
  },
  "message": "Fee estimate calculated."
}
Returns the full fee breakdown for a prospective transfer — application fee, estimated provider fees, the total the payer would pay, and the net amount credited — without moving any money. Show it to users before they confirm.

Request Body

amount
number
required
The transfer amount to estimate, in the application’s base currency. Must be greater than 0.

Response

transaction_type
string
The estimated transaction type.
payment_method
string
The payment method the estimate was computed for.
fee_enabled
boolean
Whether your application fee applies to this transaction type.
fee_breakdown
object
The line items: transaction_amount, application_fee, estimated provider fees, total_fees, total_amount_to_pay, and net_amount.
message
string
Human-readable summary of the estimate.
{
  "transaction_type": "transfer",
  "payment_method": "wallet",
  "fee_enabled": true,
  "fee_breakdown": {
    "transaction_amount": "100.00",
    "application_fee": "1.00",
    "total_fees": "1.00",
    "total_amount_to_pay": "101.00",
    "net_amount": "100.00"
  },
  "message": "Fee estimate calculated."
}
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/fees/estimate/transfer \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 25
  }'