Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lux-core.io/llms.txt

Use this file to discover all available pages before exploring further.

​
API Reference

This section provides detailed documentation for all LuxCore API endpoints.

​
Base URL

https://api.lux-core.io/api/v1
API v2 HMAC payment creation is available at: 
https://api.lux-core.io/api/v2

​
Authentication

API v1 endpoints require an API key in the X-API-Key header: 
curl -H "X-API-Key: qp_test_sk_your_api_key" https://api.lux-core.io/api/v1/payments

​
Endpoints

​
Payments

MethodEndpointDescription
POST/paymentsCreate a new payment
POST/payments on the API v2 base URLCreate a new payment with HMAC authentication for API v2 merchants
GET/paymentsList payments
GET/payments/{id}Get payment by ID
POST/payments/{id}/cancelCancel a payment
GET/payments/methodsGet available payment methods
POST/payments/methods/validateValidate a payment method

​
Webhooks

MethodEndpointDescription
POST/webhooksCreate a webhook
GET/webhooksList webhooks
GET/webhooks/{id}Get webhook by ID
PUT/webhooks/{id}Update webhook
DELETE/webhooks/{id}Delete webhook
POST/webhooks/{id}/testSend test event
PUT/webhooks/{id}/enableEnable webhook
PUT/webhooks/{id}/disableDisable webhook
GET/webhooks/{id}/eventsGet webhook events
POST/webhooks/{id}/retryRetry failed events

​
Balance

MethodEndpointDescription
GET/balanceGet balance by currency
GET/balance/allGet all balances
GET/merchants/{id}/balanceGet merchant balance
GET/merchants/{id}/balance/allGet all merchant balances

​
Tickets

MethodEndpointDescription
POST/ticketsCreate a support ticket
GET/ticketsList tickets
GET/tickets/{id}Get ticket details
POST/tickets/{id}/closeClose a ticket
POST/tickets/{id}/reopenReopen a ticket
POST/tickets/{id}/commentsAdd a comment
GET/tickets/{id}/commentsList comments
POST/tickets/{id}/upload-urlGenerate attachment upload URL
GET/tickets/{id}/attachments/{attachmentId}Download ticket attachment
GET/tickets/{id}/comments/{commentId}/attachments/{attachmentId}Download comment attachment

​
Common Parameters

​
Pagination

List endpoints support pagination:
ParameterTypeDefaultDescription
limitinteger20Results per page (max 100)
offsetinteger0Number of results to skip

​
Filtering

Most list endpoints support filtering by common fields:
ParameterTypeDescription
statusstringFilter by status
created_at_fromISO 8601Start date
created_at_toISO 8601End date

​
Response Format

​
Success Response

{
  "success": true,
  "data": { ... },
  "total": 100,
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total_pages": 5
  }
}

​
Error Response

Business logic errors include error_code and timestamp: 
{
  "statusCode": 400,
  "message": "Payment cannot be cancelled in current status: cancelled",
  "error_code": "PAYMENT_ALREADY_PROCESSED",
  "timestamp": "2025-01-28T10:00:00.000Z"
}
Validation errors return an array of messages with error field: 
{
  "statusCode": 400,
  "message": ["amount must not be less than 1", "merchant_reference must be a string"],
  "error": "Bad Request"
}

​
Rate Limits

Endpoint TypeLimit
Payment creation5000 requests/minute (burst: 500/10sec)
Standard endpoints100 requests/minute
Rate limit headers are included in responses: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1737452100

​
OpenAPI Specification

Download the OpenAPI specification for use with code generators and API clients:

Download OpenAPI Spec

OpenAPI 3.0 JSON specification

​
Interactive Documentation

The API also provides interactive documentation:
  • ReDoc: https://api.lux-core.io/api/v1/docs
  • OpenAPI JSON: https://api.lux-core.io/api/v1/openapi.json