How to use our API?

The SysPay REST API is a simple programmatic interface that allows the merchant, to access or process data on the SysPay platform.

You can find a list of all available Merchant API methods here.

All webservice requests should be sent over a secured HTTPS connection to the base URL https://app.syspay.com (Live platform) or https://app-sandbox.syspay.com/ (Sandbox platform). For each webservice the URL path and the required parameter formats are defined here.

Currently, the latest version of the Merchant API is v2.

All request arguments should be sent in the body, formatted as a JSON document. The API assumes that all data in requests is UTF-8 encoded. As an security measure, SysPay will only allow Live requests to be performed from specific authorized IP-addresses (if provided).

The webservice always responds with a UTF-8 encoded JSON message and a specific HTTP status code. The status code indicates that the request was successfully processed (2xx) or not ([45]xx). If there was an error, the response will contain a section with error information. For further details, check out the full list of all possible errors. If there was no error, the response will contain the information you requested.