Create Transfer

Initiate a payout transfer to a registered beneficiary

POST /v1/transfers

Create a new transfer

cURL

curl --request POST \
  --url https://api.hit-pay.com/v1/transfers \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '
{
  "beneficiary_id": "9e64eb6c-90dd-45e0-afaf-bd9fa0253674",
  "source_currency": "sgd",
  "source_amount": 112.42,
  "payment_amount": 10000.5,
  "remitter": {
    "entity_type": "company",
    "full_name": "Test Sender",
    "id_number": "FB123456",
    "id_type": "passport",
    "date_of_birth": "1990-10-28",
    "place_of_birth": "Singapore",
    "nationality": "sg",
    "contact_number": "[phone]",
    "email": "[e-mail]",
    "address": {
      "street_address": "1 Keong Saik Road",
      "city": "Singapore",
      "state": "Singapore",
      "postal_code": "089109",
      "country": "sg"
    },
    "company_name": "HitPay"
  }
}
'

import requests

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

payload = {
    "beneficiary_id": "9e64eb6c-90dd-45e0-afaf-bd9fa0253674",
    "source_currency": "sgd",
    "source_amount": 112.42,
    "payment_amount": 10000.5,
    "remitter": {
        "entity_type": "company",
        "full_name": "Test Sender",
        "id_number": "FB123456",
        "id_type": "passport",
        "date_of_birth": "1990-10-28",
        "place_of_birth": "Singapore",
        "nationality": "sg",
        "contact_number": "[phone]",
        "email": "[e-mail]",
        "address": {
            "street_address": "1 Keong Saik Road",
            "city": "Singapore",
            "state": "Singapore",
            "postal_code": "089109",
            "country": "sg"
        },
        "company_name": "HitPay"
    }
}
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: '9e64eb6c-90dd-45e0-afaf-bd9fa0253674',
    source_currency: 'sgd',
    source_amount: 112.42,
    payment_amount: 10000.5,
    remitter: {
      entity_type: 'company',
      full_name: 'Test Sender',
      id_number: 'FB123456',
      id_type: 'passport',
      date_of_birth: '1990-10-28',
      place_of_birth: 'Singapore',
      nationality: 'sg',
      contact_number: '[phone]',
      email: '[e-mail]',
      address: {
        street_address: '1 Keong Saik Road',
        city: 'Singapore',
        state: 'Singapore',
        postal_code: '089109',
        country: 'sg'
      },
      company_name: 'HitPay'
    }
  })
};

fetch('https://api.hit-pay.com/v1/transfers', 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",
  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' => '9e64eb6c-90dd-45e0-afaf-bd9fa0253674',
    'source_currency' => 'sgd',
    'source_amount' => 112.42,
    'payment_amount' => 10000.5,
    'remitter' => [
        'entity_type' => 'company',
        'full_name' => 'Test Sender',
        'id_number' => 'FB123456',
        'id_type' => 'passport',
        'date_of_birth' => '1990-10-28',
        'place_of_birth' => 'Singapore',
        'nationality' => 'sg',
        'contact_number' => '[phone]',
        'email' => '[e-mail]',
        'address' => [
                'street_address' => '1 Keong Saik Road',
                'city' => 'Singapore',
                'state' => 'Singapore',
                'postal_code' => '089109',
                'country' => 'sg'
        ],
        'company_name' => 'HitPay'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"beneficiary_id\": \"9e64eb6c-90dd-45e0-afaf-bd9fa0253674\",\n  \"source_currency\": \"sgd\",\n  \"source_amount\": 112.42,\n  \"payment_amount\": 10000.5,\n  \"remitter\": {\n    \"entity_type\": \"company\",\n    \"full_name\": \"Test Sender\",\n    \"id_number\": \"FB123456\",\n    \"id_type\": \"passport\",\n    \"date_of_birth\": \"1990-10-28\",\n    \"place_of_birth\": \"Singapore\",\n    \"nationality\": \"sg\",\n    \"contact_number\": \"[phone]\",\n    \"email\": \"[e-mail]\",\n    \"address\": {\n      \"street_address\": \"1 Keong Saik Road\",\n      \"city\": \"Singapore\",\n      \"state\": \"Singapore\",\n      \"postal_code\": \"089109\",\n      \"country\": \"sg\"\n    },\n    \"company_name\": \"HitPay\"\n  }\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")
  .header("X-BUSINESS-API-KEY", "<x-business-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"beneficiary_id\": \"9e64eb6c-90dd-45e0-afaf-bd9fa0253674\",\n  \"source_currency\": \"sgd\",\n  \"source_amount\": 112.42,\n  \"payment_amount\": 10000.5,\n  \"remitter\": {\n    \"entity_type\": \"company\",\n    \"full_name\": \"Test Sender\",\n    \"id_number\": \"FB123456\",\n    \"id_type\": \"passport\",\n    \"date_of_birth\": \"1990-10-28\",\n    \"place_of_birth\": \"Singapore\",\n    \"nationality\": \"sg\",\n    \"contact_number\": \"[phone]\",\n    \"email\": \"[e-mail]\",\n    \"address\": {\n      \"street_address\": \"1 Keong Saik Road\",\n      \"city\": \"Singapore\",\n      \"state\": \"Singapore\",\n      \"postal_code\": \"089109\",\n      \"country\": \"sg\"\n    },\n    \"company_name\": \"HitPay\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"9e64eb6c-90dd-45e0-afaf-bd9fa0253674\",\n  \"source_currency\": \"sgd\",\n  \"source_amount\": 112.42,\n  \"payment_amount\": 10000.5,\n  \"remitter\": {\n    \"entity_type\": \"company\",\n    \"full_name\": \"Test Sender\",\n    \"id_number\": \"FB123456\",\n    \"id_type\": \"passport\",\n    \"date_of_birth\": \"1990-10-28\",\n    \"place_of_birth\": \"Singapore\",\n    \"nationality\": \"sg\",\n    \"contact_number\": \"[phone]\",\n    \"email\": \"[e-mail]\",\n    \"address\": {\n      \"street_address\": \"1 Keong Saik Road\",\n      \"city\": \"Singapore\",\n      \"state\": \"Singapore\",\n      \"postal_code\": \"089109\",\n      \"country\": \"sg\"\n    },\n    \"company_name\": \"HitPay\"\n  }\n}"

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

201

{
  "id": "9e64f9b8-0039-4bc1-bb98-be1c88212a7e",
  "beneficiary": {
    "id": "9e64eb6c-90dd-45e0-afaf-bd9fa0253674",
    "status": "approved",
    "country": "bd",
    "currency": "bdt",
    "transfer_method": "local",
    "holder_name": "SHAH ALAM HERA",
    "holder_type": "individual",
    "account_number": "1503201781283001",
    "bank_name": "BRAC Bank Ltd.",
    "bank_id": "brc-20",
    "email": null,
    "bank_routing_number": "060261726",
    "created_at": "2025-03-10T07:27:16+08:00",
    "updated_at": "2025-03-10T07:27:18+08:00"
  },
  "payment_currency": "bdt",
  "payment_amount": 10000.5,
  "source_currency": "sgd",
  "source_amount": 112.42,
  "exchange_rate": "88.949505",
  "fee": {
    "amount": 0,
    "currency": "sgd",
    "paid_by": "payer"
  },
  "status": "scheduled",
  "created_at": "2025-03-10T08:07:15+08:00"
}

{
  "message": "The beneficiary id field is required when beneficiary is not present. (and 4 more errors)",
  "errors": {
    "beneficiary_id": [
      "The beneficiary id field is required when beneficiary is not present."
    ],
    "beneficiary": [
      "The beneficiary field is required when beneficiary id is not present."
    ],
    "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 · object

The beneficiary information. Only required if 'beneficiary_id' is not set. The payload depends on the country and payment method. Please refer Create Beneficiary for addtional fields

Show child attributes

beneficiary_id · string<uuid>

The Beneficiary id. Only required if 'beneficiary' is not set.

source_currency · string

It is beneficiary bank account 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

remitter_id · string

The remitter id. Only pass either remitter or remitter_id.

Example:

"9b294222-3a53-427f-9393-95dc6d63ee6c"

remitter · object

The remitter information. Only pass either remitter or remitter_id.

Show child attributes

remark · string

Transfer note for internal use only

Maximum string length: 120

reference · string

The reference for the transfer

Maximum string length: 120

Response

201

application/json

201

id · string · required

beneficiary · object · required

Show child attributes

payment_currency · string · required

payment_amount · number · required

source_currency · string · required

source_amount · number · required

exchange_rate · string · required

fee · object · required

Show child attributes

status · enum<string> · required

Available options: scheduled, processing, paid, failed, canceled

created_at · string · required