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
}'
from hostpay import HostPay
client = HostPay(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
estimate = client.fees.estimate_transfer(amount=25)
print(estimate["fee_breakdown"]["total_fees"])
import { HostPay } from "@hostpay/sdk";
const client = new HostPay({ apiKey: "YOUR_API_KEY", secretKey: "YOUR_SECRET_KEY" });
const estimate = await client.fees.estimateTransfer({ amount: 25 });
console.log(estimate.fee_breakdown.total_fees);
{
"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."
}
{
"detail": "Invalid credentials"
}
{
"detail": "Input should be greater than 0"
}
Fees
Estimate Transfer Fees
Preview the fees for a wallet-to-wallet transfer before creating it.
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
}'
from hostpay import HostPay
client = HostPay(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
estimate = client.fees.estimate_transfer(amount=25)
print(estimate["fee_breakdown"]["total_fees"])
import { HostPay } from "@hostpay/sdk";
const client = new HostPay({ apiKey: "YOUR_API_KEY", secretKey: "YOUR_SECRET_KEY" });
const estimate = await client.fees.estimateTransfer({ amount: 25 });
console.log(estimate.fee_breakdown.total_fees);
{
"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."
}
{
"detail": "Invalid credentials"
}
{
"detail": "Input should be greater than 0"
}
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
number
required
The transfer amount to estimate, in the application’s base currency. Must be greater than 0.
Response
string
The estimated transaction type.
string
The payment method the estimate was computed for.
boolean
Whether your application fee applies to this transaction type.
object
The line items:
transaction_amount, application_fee, estimated provider fees, total_fees, total_amount_to_pay, and net_amount.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."
}
{
"detail": "Invalid credentials"
}
{
"detail": "Input should be greater than 0"
}
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
}'
from hostpay import HostPay
client = HostPay(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
estimate = client.fees.estimate_transfer(amount=25)
print(estimate["fee_breakdown"]["total_fees"])
import { HostPay } from "@hostpay/sdk";
const client = new HostPay({ apiKey: "YOUR_API_KEY", secretKey: "YOUR_SECRET_KEY" });
const estimate = await client.fees.estimateTransfer({ amount: 25 });
console.log(estimate.fee_breakdown.total_fees);