HitPay Product Guide and API docs.

Get all card readers

curl --request GET \
  --url https://api.hit-pay.com/v1/readers \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'

const options = {method: 'GET', headers: {'X-BUSINESS-API-KEY': '<x-business-api-key>'}};

fetch('https://api.hit-pay.com/v1/readers', 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/readers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'

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

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "device_type": "<string>",
      "details": {
        "title": "<string>",
        "image": "<string>"
      },
      "data": {
        "id": "<string>",
        "serial_number": "<string>"
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<unknown>",
    "next": "<unknown>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "links": [
      {
        "label": "<string>",
        "active": true,
        "url": "<string>"
      }
    ],
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

GET

readers

Get all card readers

curl --request GET \
  --url https://api.hit-pay.com/v1/readers \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'

const options = {method: 'GET', headers: {'X-BUSINESS-API-KEY': '<x-business-api-key>'}};

fetch('https://api.hit-pay.com/v1/readers', 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/readers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'

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

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "device_type": "<string>",
      "details": {
        "title": "<string>",
        "image": "<string>"
      },
      "data": {
        "id": "<string>",
        "serial_number": "<string>"
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<unknown>",
    "next": "<unknown>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "links": [
      {
        "label": "<string>",
        "active": true,
        "url": "<string>"
      }
    ],
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

Headers

X-BUSINESS-API-KEY

string

required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Query Parameters

limit

number

default:10

The number of items in page.

Required range: x <= 100

page

number

default:1

Response

200 - application/json

200

data

object[]

required

Show child attributes

links

object

required

Show child attributes

API Reference

List Terminals

Headers

Query Parameters

Response