HitPay Product Guide and API docs.

Create location

curl --request POST \
  --url https://api.hit-pay.com/v1/locations \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '
{
  "name": "Main Store",
  "street": "123 Main St",
  "city": "Singapore",
  "state": "Singapore",
  "country": "SG",
  "postal_code": "123456"
}
'

import requests

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

payload = {
    "name": "Main Store",
    "street": "123 Main St",
    "city": "Singapore",
    "state": "Singapore",
    "country": "SG",
    "postal_code": "123456"
}
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({
    name: 'Main Store',
    street: '123 Main St',
    city: 'Singapore',
    state: 'Singapore',
    country: 'SG',
    postal_code: '123456'
  })
};

fetch('https://api.hit-pay.com/v1/locations', 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/locations",
  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([
    'name' => 'Main Store',
    'street' => '123 Main St',
    'city' => 'Singapore',
    'state' => 'Singapore',
    'country' => 'SG',
    'postal_code' => '123456'
  ]),
  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/locations"

	payload := strings.NewReader("{\n  \"name\": \"Main Store\",\n  \"street\": \"123 Main St\",\n  \"city\": \"Singapore\",\n  \"state\": \"Singapore\",\n  \"country\": \"SG\",\n  \"postal_code\": \"123456\"\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/locations")
  .header("X-BUSINESS-API-KEY", "<x-business-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Main Store\",\n  \"street\": \"123 Main St\",\n  \"city\": \"Singapore\",\n  \"state\": \"Singapore\",\n  \"country\": \"SG\",\n  \"postal_code\": \"123456\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"Main Store\",\n  \"street\": \"123 Main St\",\n  \"city\": \"Singapore\",\n  \"state\": \"Singapore\",\n  \"country\": \"SG\",\n  \"postal_code\": \"123456\"\n}"

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

{
  "id": "9c484458-b2a3-4f49-87ed-ad9ea71b0df3",
  "business_id": "8a1f2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "name": "Main Store",
  "street": "123 Main St",
  "city": "Singapore",
  "state": "Singapore",
  "country": "SG",
  "postal_code": "123456",
  "active": true,
  "pickups": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "errors": "<array>"
}

{
  "message": "<string>",
  "errors": "<array>"
}

{
  "message": "<string>",
  "errors": "<array>"
}

POST

locations

Create location

curl --request POST \
  --url https://api.hit-pay.com/v1/locations \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '
{
  "name": "Main Store",
  "street": "123 Main St",
  "city": "Singapore",
  "state": "Singapore",
  "country": "SG",
  "postal_code": "123456"
}
'

import requests

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

payload = {
    "name": "Main Store",
    "street": "123 Main St",
    "city": "Singapore",
    "state": "Singapore",
    "country": "SG",
    "postal_code": "123456"
}
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({
    name: 'Main Store',
    street: '123 Main St',
    city: 'Singapore',
    state: 'Singapore',
    country: 'SG',
    postal_code: '123456'
  })
};

fetch('https://api.hit-pay.com/v1/locations', 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/locations",
  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([
    'name' => 'Main Store',
    'street' => '123 Main St',
    'city' => 'Singapore',
    'state' => 'Singapore',
    'country' => 'SG',
    'postal_code' => '123456'
  ]),
  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/locations"

	payload := strings.NewReader("{\n  \"name\": \"Main Store\",\n  \"street\": \"123 Main St\",\n  \"city\": \"Singapore\",\n  \"state\": \"Singapore\",\n  \"country\": \"SG\",\n  \"postal_code\": \"123456\"\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/locations")
  .header("X-BUSINESS-API-KEY", "<x-business-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Main Store\",\n  \"street\": \"123 Main St\",\n  \"city\": \"Singapore\",\n  \"state\": \"Singapore\",\n  \"country\": \"SG\",\n  \"postal_code\": \"123456\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"Main Store\",\n  \"street\": \"123 Main St\",\n  \"city\": \"Singapore\",\n  \"state\": \"Singapore\",\n  \"country\": \"SG\",\n  \"postal_code\": \"123456\"\n}"

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

{
  "id": "9c484458-b2a3-4f49-87ed-ad9ea71b0df3",
  "business_id": "8a1f2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "name": "Main Store",
  "street": "123 Main St",
  "city": "Singapore",
  "state": "Singapore",
  "country": "SG",
  "postal_code": "123456",
  "active": true,
  "pickups": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "errors": "<array>"
}

{
  "message": "<string>",
  "errors": "<array>"
}

{
  "message": "<string>",
  "errors": "<array>"
}

Headers

X-BUSINESS-API-KEY

string

required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json

name

string

required

Location name

Maximum string length: 255

Example:

"Main Store"

street

string

required

Street address

Maximum string length: 255

Example:

"123 Main St"

city

string

required

City

Maximum string length: 255

Example:

"Singapore"

state

string

required

State or region

Maximum string length: 255

Example:

"Singapore"

country

string

required

Country code or name

Maximum string length: 255

Example:

"SG"

postal_code

string

required

Postal code

Maximum string length: 16

Example:

"123456"

Response

Location created successfully

string<uuid>

required

Location ID

Example:

"9c484458-b2a3-4f49-87ed-ad9ea71b0df3"

business_id

string<uuid>

required

Business that owns this location

Example:

"8a1f2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"

name

string

required

Name of the location

Example:

"Main Store"

street

string

required

Street address

Example:

"123 Main St"

city

string

required

City

Example:

"Singapore"

state

string

required

State or region

Example:

"Singapore"

country

string

required

Country code or name

Example:

"SG"

postal_code

string

required

Postal code

Example:

"123456"

active

boolean

required

Whether the location is active

Example:

true

pickups

object[]

Pickup configurations linked to this location (empty when not loaded)

created_at

string<date-time>

updated_at

string<date-time>

Last modified on August 6, 2026

API Reference

Create Location

Headers

Body

Response