Overview

The RoxPay API is organized around REST. It uses standard HTTP verbs, returns JSON responses, and uses Bearer token authentication.

Making Your First Request

Once you have your API token (see Authentication), you can make your first request:

curl -X GET https://app.roxpay.eu/api/v4/info/payment-providers \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response Format

All responses follow a consistent structure:

{
  "Message": "Operation completed successfully.",
  "StatusCode": 200,
  "Result": true
}

For list endpoints, results are paginated:

{
  "Message": "Transactions retrieved.",
  "StatusCode": 200,
  "Result": true,
  "Data": [...],
  "TotalCount": 142,
  "Page": 1,
  "PageSize": 20
}

Rate Limits

API requests are rate-limited per company. If you exceed the limit, you'll receive a 429 Too Many Requests response. Check the Retry-After header for when to retry.

Versioning

The current API version is v4. Previous versions (v2, v2.1, v3) remain available but are not recommended for new integrations.