API Overview

Important Note:

We’re migrating and enhancing our API documentation from the Legacy API Reference site. If you need to access the legacy documentation, please visit: https://boarding.clearent.net/api-docs/ The legacy site is still being maintained and updated for now, but it will be retired in the future.

The Xplor Pay API is a RESTful web service that provides a standardized interface for payment processing operations. All endpoints are designed following REST principles to ensure consistency and ease of integration.

Supported Data Format

All of our RESTful API endpoints support JSON (JavaScript Object Notation) for both request and response data.

HTTP Methods

Depending on the capabilities of each endpoint, you may have one or more supported HTTP methods:

• GET: Retrieve data or information

• POST: Create new resources or submit data

• PUT: Update existing resources completely

• DELETE: Remove resources

Security Requirements

• Transport layer security All API endpoints require HTTPS with Transport Layer Security (TLS) version 1.2 or higher. Requests using earlier TLS versions are blocked by our firewall. Ensure your client environment or browser supports TLS 1.2 or above.

• Authentication headers Authentication requirements vary by API product:

  • AccessKey header:

  Only required for the Boarding API, Reporting API, and Disputes API. For these APIs, include the HTTP header AccessKey with the secret access key issued by Xplor Pay. Requests without a valid access key are rejected.

  • API Key:

  For all other APIs, use the API key authentication method.