POST
/
v1
/
transfers
/
estimate
Estimate transfer fees
curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/transfers/estimate \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "beneficiary_id": "9e3320ed-a47b-495b-8e60-e1b1347eb3e8",
  "source_currency": "sgd",
  "source_amount": 100
}'
{
  "source_amount": 100,
  "source_amount_fees": 0,
  "source_currency": "sgd",
  "exchange_rate": "1",
  "fx_pair": "sgdsgd",
  "payment_amount": 100,
  "payment_amount_fees": 0,
  "payment_currency": "sgd",
  "fee_payer": "beneficiary",
  "fee_currency": "sgd"
}

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json
​
beneficiary_id
string
required

The Beneficiary id

Examples:

"9ad4789a-c864-48a6-a657-7fdfc57ba1fc"

​
source_currency
string
required

The supported currency.

Example:

"sgd"

​
source_amount
number

The amount to be transferred. Only required if 'payment_amount' is not set.

Required range: x >= 1
Example:

112.42

​
payment_amount
number

The amount to be transferred. Only required if 'source_amount' is not set.

Required range: x >= 1
Example:

10000.5

Response

200

​
source_amount
number
required
​
source_amount_fees
number
required
​
source_currency
string
required
​
exchange_rate
string
required
​
payment_amount
number
required
​
payment_amount_fees
number
required
​
fx_pair
string
​
fee_payer
enum<string>
Available options:
payer,
beneficiary
​
fee_currency
string