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:

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:

To authenticate your request, include the following header:

Authorization: Bearer qhtfs87hjnc12kkos

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

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

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.

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.