Create Remitter

Register a new remitter for payout transfers

POST /v1/remitters

Create new remitter

cURL

curl --request POST \
  --url https://api.hit-pay.com/v1/remitters \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '
{
  "entity_type": "individual",
  "full_name": "Saul Schumm",
  "id_number": "A1748247986",
  "id_type": "national_id",
  "date_of_birth": "1990-01-01",
  "place_of_birth": "Singapore",
  "nationality": "sg",
  "contact_number": "[phone]",
  "email": "[e-mail]",
  "address": {
    "street_address": "123 Orchard Rd",
    "city": "Singapore ",
    "state": "Singapore",
    "postal_code": "238888",
    "country": "sg"
  },
  "company_name": "Ebert, Zulauf and Daugherty"
}
'

import requests

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

payload = {
    "entity_type": "individual",
    "full_name": "Saul Schumm",
    "id_number": "A1748247986",
    "id_type": "national_id",
    "date_of_birth": "1990-01-01",
    "place_of_birth": "Singapore",
    "nationality": "sg",
    "contact_number": "[phone]",
    "email": "[e-mail]",
    "address": {
        "street_address": "123 Orchard Rd",
        "city": "Singapore ",
        "state": "Singapore",
        "postal_code": "238888",
        "country": "sg"
    },
    "company_name": "Ebert, Zulauf and Daugherty"
}
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({
    entity_type: 'individual',
    full_name: 'Saul Schumm',
    id_number: 'A1748247986',
    id_type: 'national_id',
    date_of_birth: '1990-01-01',
    place_of_birth: 'Singapore',
    nationality: 'sg',
    contact_number: '[phone]',
    email: '[e-mail]',
    address: {
      street_address: '123 Orchard Rd',
      city: 'Singapore ',
      state: 'Singapore',
      postal_code: '238888',
      country: 'sg'
    },
    company_name: 'Ebert, Zulauf and Daugherty'
  })
};

fetch('https://api.hit-pay.com/v1/remitters', 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/remitters",
  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([
    'entity_type' => 'individual',
    'full_name' => 'Saul Schumm',
    'id_number' => 'A1748247986',
    'id_type' => 'national_id',
    'date_of_birth' => '1990-01-01',
    'place_of_birth' => 'Singapore',
    'nationality' => 'sg',
    'contact_number' => '[phone]',
    'email' => '[e-mail]',
    'address' => [
        'street_address' => '123 Orchard Rd',
        'city' => 'Singapore ',
        'state' => 'Singapore',
        'postal_code' => '238888',
        'country' => 'sg'
    ],
    'company_name' => 'Ebert, Zulauf and Daugherty'
  ]),
  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/remitters"

	payload := strings.NewReader("{\n  \"entity_type\": \"individual\",\n  \"full_name\": \"Saul Schumm\",\n  \"id_number\": \"A1748247986\",\n  \"id_type\": \"national_id\",\n  \"date_of_birth\": \"1990-01-01\",\n  \"place_of_birth\": \"Singapore\",\n  \"nationality\": \"sg\",\n  \"contact_number\": \"[phone]\",\n  \"email\": \"[e-mail]\",\n  \"address\": {\n    \"street_address\": \"123 Orchard Rd\",\n    \"city\": \"Singapore \",\n    \"state\": \"Singapore\",\n    \"postal_code\": \"238888\",\n    \"country\": \"sg\"\n  },\n  \"company_name\": \"Ebert, Zulauf and Daugherty\"\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/remitters")
  .header("X-BUSINESS-API-KEY", "<x-business-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity_type\": \"individual\",\n  \"full_name\": \"Saul Schumm\",\n  \"id_number\": \"A1748247986\",\n  \"id_type\": \"national_id\",\n  \"date_of_birth\": \"1990-01-01\",\n  \"place_of_birth\": \"Singapore\",\n  \"nationality\": \"sg\",\n  \"contact_number\": \"[phone]\",\n  \"email\": \"[e-mail]\",\n  \"address\": {\n    \"street_address\": \"123 Orchard Rd\",\n    \"city\": \"Singapore \",\n    \"state\": \"Singapore\",\n    \"postal_code\": \"238888\",\n    \"country\": \"sg\"\n  },\n  \"company_name\": \"Ebert, Zulauf and Daugherty\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"entity_type\": \"individual\",\n  \"full_name\": \"Saul Schumm\",\n  \"id_number\": \"A1748247986\",\n  \"id_type\": \"national_id\",\n  \"date_of_birth\": \"1990-01-01\",\n  \"place_of_birth\": \"Singapore\",\n  \"nationality\": \"sg\",\n  \"contact_number\": \"[phone]\",\n  \"email\": \"[e-mail]\",\n  \"address\": {\n    \"street_address\": \"123 Orchard Rd\",\n    \"city\": \"Singapore \",\n    \"state\": \"Singapore\",\n    \"postal_code\": \"238888\",\n    \"country\": \"sg\"\n  },\n  \"company_name\": \"Ebert, Zulauf and Daugherty\"\n}"

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

201

{
  "id": "9f0092ca-4b7d-4e33-b503-9dd27b0807ba",
  "status": "pending",
  "entity_type": "individual",
  "full_name": "Hilda Ferry",
  "id_number": "A1748248115",
  "id_type": "national_id",
  "date_of_birth": "1990-01-01",
  "place_of_birth": "Singapore",
  "nationality": "sg",
  "contact_number": "[phone]",
  "email": "[e-mail]",
  "address": {
    "street_address": "123 Orchard Rd",
    "city": "Singapore",
    "state": "Singapore",
    "postal_code": "238888",
    "country": "sg"
  },
  "company_name": "Abernathy Inc",
  "created_by": {
    "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
    "display_name": "TestingSG",
    "first_name": "QA",
    "last_name": "SG"
  },
  "created_at": "2025-05-26T16:28:35+08:00",
  "updated_at": "2025-05-26T16:28:35+08:00"
}

{
  "message": "The entity type field is required. (and 10 more errors)",
  "errors": {
    "entity_type": [
      "The entity type field is required."
    ],
    "full_name": [
      "The full name field is required."
    ],
    "id_number": [
      "The id number field is required."
    ],
    "id_type": [
      "The id type field is required."
    ],
    "date_of_birth": [
      "The date of birth field is required."
    ],
    "address": [
      "The address field is required."
    ],
    "address.street_address": [
      "The address.street address field is required."
    ],
    "address.city": [
      "The address.city field is required."
    ],
    "address.state": [
      "The address.state field is required."
    ],
    "address.postal_code": [
      "The address.postal code field is required."
    ],
    "address.country": [
      "The address.country field is required."
    ]
  }
}

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json

entity_type · enum<string> · required

Available options: individual, company

full_name · string · required

date_of_birth · string · required

Example:

"1990-01-01"

nationality · string · required

Example:

"sg"

contact_number · string · required

Example:

"[phone]"

address · object · required

Show child attributes

id_number · string

id_type · enum<string>

Available options: national_id, passport, driving_license

place_of_birth · string

Example:

"Singapore"

email · string<email>

company_name · string

It's required if entity_type is company.

Response

201

application/json

201

id · string · required

status · string · required

entity_type · enum<string> · required

Available options: individual, company

full_name · string · required

id_number · string · required

id_type · enum<string> · required

Available options: national_id, passport, driving_license

date_of_birth · string · required

place_of_birth · string · required

nationality · string · required

contact_number · string · required

email · string · required

address · object · required

Show child attributes

company_name · string · required

created_by · object · required

Show child attributes

created_at · string · required

updated_at · string · required