Skip to content

HTTP

Synqpay API with JSON-RPC can operate over HTTP on the device's local network. The service is served on port 8000, and the endpoint is /synqpay.

Info

The endpoint uses the POST method only!

Authorization

All API methods must be authenticated using an API key in the header api-key. The API key is obtained through a pairing process.

Hebrew / Arabic support

The Synqpay API supports UTF-8 encoding for all characters, including Hebrew and Arabic. It is highly recommended that each request include the header Content-Type: application/json; charset=utf-8.

Status Code

Synqpay HTTP server supports the following status codes.

Status Code Description
200 All JSON-RPC calls, regardless of success or error
401 Unauthorized access. Missing or invalid api-key (No response body)
404 Wrong endpoint

Examples

cURL

Run the following command in your terminal, replacing <DEVICE-IP> and <API-KEY> with your actual device IP and API key:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl http://<DEVICE-IP>:8000/synqpay \
-X POST
-H 'api-key: <API-KEY>' \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{
    "jsonrpc": "2.0",
    "method": "getDeviceInfo",
    "id": "1234",
    "params": null
}'

Info

In Windows Powershell, quotations in curl commands can behave differently than expected. We recommend using Postman on Windows systems.

Postman

Call the JSON-RPC methods using Postman.

Click Run in Postman to fork the collection and make requests.

Run In Postman

Info

This collection includes an environment that needs to be activated and filled before executing methods. Ensure you fill in your device-ip and device-sn in the selected environment.

Warning

If the pairing process with Postman is performed, the device-key is filled automatically after authorization succeeds. If the pairing process was done outside Postman, the device-key must be manually filled out in the environment.