Estimate Transfer Fees

Calculate estimated payout fees before initiating a transfer

POST /v1/transfers/estimate

Estimate transfer fees

cURL

curl --request POST \
  --url https://api.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
}
'

import requests

url = "https://api.hit-pay.com/v1/transfers/estimate"

payload = {
    "beneficiary_id": "9e3320ed-a47b-495b-8e60-e1b1347eb3e8",
    "source_currency": "sgd",
    "source_amount": 100
}
headers = {
    "X-BUSINESS-API-KEY": "<x-business-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-BUSINESS-API-KEY': '<x-business-api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    beneficiary_id: '9e3320ed-a47b-495b-8e60-e1b1347eb3e8',
    source_currency: 'sgd',
    source_amount: 100
  })
};

fetch('https://api.hit-pay.com/v1/transfers/estimate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hit-pay.com/v1/transfers/estimate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'beneficiary_id' => '9e3320ed-a47b-495b-8e60-e1b1347eb3e8',
    'source_currency' => 'sgd',
    'source_amount' => 100
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-BUSINESS-API-KEY: <x-business-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hit-pay.com/v1/transfers/estimate"

	payload := strings.NewReader("{\n  \"beneficiary_id\": \"9e3320ed-a47b-495b-8e60-e1b1347eb3e8\",\n  \"source_currency\": \"sgd\",\n  \"source_amount\": 100\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hit-pay.com/v1/transfers/estimate")
  .header("X-BUSINESS-API-KEY", "<x-business-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"beneficiary_id\": \"9e3320ed-a47b-495b-8e60-e1b1347eb3e8\",\n  \"source_currency\": \"sgd\",\n  \"source_amount\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hit-pay.com/v1/transfers/estimate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"beneficiary_id\": \"9e3320ed-a47b-495b-8e60-e1b1347eb3e8\",\n  \"source_currency\": \"sgd\",\n  \"source_amount\": 100\n}"

response = http.request(request)
puts response.read_body

200

{
  "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"
}

{
  "message": "The beneficiary id field is required. (and 3 more errors)",
  "errors": {
    "beneficiary_id": [
      "The beneficiary id field is required."
    ],
    "source_currency": [
      "The source currency field is required."
    ],
    "source_amount": [
      "The source amount field is required when payment amount is not present."
    ],
    "payment_amount": [
      "The payment amount field is required when source amount is not present."
    ]
  }
}

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json

beneficiary_id · string · required

The Beneficiary id

Example:

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

source_currency · string · required

The supported currency.

Example:

"sgd"

source_amount · number<double>

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

Required range: x >= 1

Example:

112.42

payment_amount · number<double>

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

Required range: x >= 1

Example:

10000.5

Response

200

application/json

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