Request processing scenarios

Old Dashboard receives HTTP POST requests with data sent in the JSON format.

All requests are processed synchronously, the HTTP response to the request contains the required information.

Basic URLs

The primary URL for requests is https://data.ecommpay.com.

Request are executed through the HTTP 1.1 protocol using TLS 1.2.

Request format

Each request is sent to a separate URL, depending on the type of request. URLs and request parameters are listed in the Data API section.

The request version is specified in the request URL. For example, a request path for account balances would look like

v1/balance/get

Restrictions on the values in the parameters are given in the requests in the Data API.

Each request is signed to ensure data security. For more information, see Signature generation and verification.

Response format

For each request Old Dashboard synchronously sends an HTTP POST response. The data is transmitted in the JSON format in the response body.

Old Dashboard uses HTTP codes to indicate success or failure to receive an API request and to ensure its validity. In general, code 200 indicates that the request was received and the data from the request passed the basic validation, the codes in the 4xx range indicate an error in the supplied data (for example, a required parameter was not passed in the request), and code 500 indicates a failure in Old Dashboard.

Note: The set of parameters that is sent in responses may be changed without prior notice. In this case, you should ignore the added parameters.

Response codes

Table 1.
Response code Description
200 OK

The response is successfully fulfilled. The request body contains the requested data.

400 Bad Request

The request cannot be processed by the server because of a data validation error: required parameters were not passed or the signature is invalid. The response body contains the error status of receiving the request and the refined error data.

401 Authorization Required

Incorrect authorization details. The response body contains the error status of receiving the request and the refined error data.

500 Internal Error

The request cannot be processed due to server error. The response body contains the error status of receiving the request and the refined error data.

Errors

If an error can be processed and determined, Old Dashboard returns an error message in the response body.

Parameter Description
name Fixed value error
code Code of the HTTP header
message Detailed error message (if applicable)
status Fixed value false