HTTPS Security

All communications with the Scalapay API are secured using TLS 1.2 or later. This ensures that data transmitted between your application and our API is encrypted and secure.

Endpoints

You can interact with the Scalapay API by sending requests to the following endpoints:

Environment	URL
Production	https://api.scalapay.com
Sandbox	https://integration.api.scalapay.com

Note:

Integration & Testing: Use the Sandbox environment during integration. This environment supports Fake Cards, allowing you to simulate complete transaction flows without incurring charges.
Production: When your integration is complete and you are ready to go live, switch to the Production endpoint.

Authentication

The Scalapay API uses Bearer token authentication. Every API endpoint requires your secret API key to be included as a bearer token in the Authorization header. If authentication fails, the API returns a "401 Unauthorized" response.

Example:

Secret API Key
qhtfs87hjnc12kkos

To authenticate your request, include the following header:

Authorization: Bearer qhtfs87hjnc12kkos

Ensure that there is exactly one space between Bearer and your secret key.

📘
Scalapay provides separate API keys for the Sandbox and Production environments.
Remember that you have two different API keys, usually prefixed with “sp_”: one for the Sandbox (test environment) and one for Production (live environment). Use the Sandbox API key (for requests to the integration sandbox) during development/testing, then switch to your Production API key (from the Merchant Portal) when making live calls to the production API. Using the wrong key for an environment will result in authentication errors.

Errors

The Scalapay API uses standard HTTP status codes to indicate the result of your requests. When an error occurs, a JSON response is returned with detailed information.

HTTP Status Codes

HTTP Status Code	Description
2XX	The request was successful.
4XX	The request was invalid (e.g., missing required parameters or invalid data).
5XX	The request failed due to an unexpected error on our side.

Error Response Structure

Error responses provide detailed information to help diagnose issues. Although the human-readable message may be updated over time, you should rely on the error code and HTTP status code for error handling.

Attribute	Type	Description
errorCode	string	A specific error code identifying the error type (e.g., `order_amount_exceeds_maximum_limit`).
errorId	string	A unique identifier for the error instance.
message	string	A human-readable description of the error. This message may be updated over time, so use the error code for validation.
httpStatusCode	integer	The HTTP status code associated with the error.

Example Error Response:

{
    "errorCode": "400",
    "errorId": "error-sktwiapnkhy2ynv8",
    "message": "startDate cannot be greater than endDate",
    "httpStatusCode": 400
}

For further troubleshooting, refer to our API documentation or contact Scalapay support.