Synqpay API

Synqpay API is based on JSON-RPC 2.0 specification. A software application must connect to s device to interact with the Synqpay service.

JSON-RPC is a stateless, lightweight remote procedure call (RPC) protocol that defines several data structures and the rules for processing them. It is transport agnostic, meaning the concepts can be used within the same process, over sockets, HTTP, or in various message-passing environments. It uses JSON (RFC 4627) as the data format.

JSON-RPC endpoints

Currently, Synqpay's implementation supports JSON-RPC 2.0 over an HTTP or TCP connection or an Android SDK that communicates over IPC with the Synqpay Service.

Authorization

If you are a remote client (using HTTP/TCP), you must authenticate each method with an API key provided through a pairing process. The API Key is delivered outside the JSON-RPC payload. For more information, please see the document on each transport method.

JSON-RPC implementation

• Batch is not supported in this implementation.
• the expected type for id is string.

Info

All strings in the API are encoded in UTF-8. Hebrew/Arabic strings are in logical (reading) order.

Data

A Data value (for example, byte arrays, bytecode arrays) must be:

• Hex encoded
• "0x" prefixed
• expressed using two hex digits per byte

All Data values are big-endian and represented in a string

Examples

Value	Valid	Reason
0x	true	interpreted as empty data
0x0	false	each byte must be represented using two hex digits
0x00	true	interpreted as a single zero byte
0x1a	true	interpreted as data value 26
0x001a00	true	interpreted as data value 6656
0x0f0f0	false	each byte must be represented using two hex digits
001a00	false	values must be prefixed

Datetime

All date-time strings are represented in RFC-3339 format.

Responses include date-time strings with timezone offset.

Request parameters can be either UTC offset date-time or UTC datetime

Example

October 6th, 2024 22:53:11 (+689ms) Tel-Aviv Standard Time:

UTC: 2024-10-06T19:53:11.689Z

Tel-Aviv Standard time with UTC offset: 2024-10-06T22:53:11.689+03:00