❤ Rest
❤ Https
❤ Request headers
❤ Errors
❤ Method errors
Rest
The Scalapay API is organised around REST. The API attempts to use predictable, resource-oriented URLs and to use HTTP status codes to indicate errors.
Https
The Scalapay API requires all communications to be secured using TLS 1.2 or greater.
Request headers
Clients must send appropriate headers with all the requests.
| Fieldname | Required | Description |
|---|---|---|
| Accept | Yes | POST and PUT requests must declare the content-type as application/json |
| Content-Type | Yes | All requests must accept application/json |
| Authorization | Yes | see here |
Errors
HTTP Status codes
The Scalapay API uses the conventional HTTP status codes to indicate success or failure of an API request.
| HTTP Status Code | Description |
|---|---|
| 200-299 | The request was processed successfully |
| 400-499 | The request was not valid (e.g. a required parameter was missing). |
| 500-599 | The request could not be processed for an unexpected reason. |
Response
Returns a JSON object and an appropriate HTTP status code.
Please note that the human-readable textual messages included within the error object are improved over time. For validation and mapping purposes, please use the error code or HTTP status code values.
| Attribute | Type | Description |
|---|---|---|
| errorCode | string | The type of error returned. E.g.: order_amount_exceeds_maximum_limit |
| errorId | string | A unique error ID |
| message | string | A human-readable message which provides more details about the error. In most cases, these messages can be displayed to the end user. |
| httpStatusCode | integer | The HTTP status code |
{
"errorCode": 400,
"errorId": "error-sktwiapnkhy2ynv8",
"message": "startDate cannot be greater than endDate",
"httpStatusCode": 400
}
Method errors
GET Errors
| HTTP Status Code | errorCode | Description |
|---|---|---|
| 401 Unauthorized | unauthorized | Invalid Merchant API credentials were passed in the Authorization header |
POST and PUT Errors
| HTTP Status Code | errorCode | Description |
|---|---|---|
| 400 Bad Request | invalid_json | The request body contains invalid, improperly formatted JSON or empty body. |
| 401 Unauthorized | unauthorized | Invalid Merchant API credentials were passed in the Authorization header |