API reference summary
Quick overview of CardPlusPay API endpoints. For full request/response schemas, parameters, and examples, use the interactive API Reference (OpenAPI/Redoc).
Base URL: https://api.cardpluspay.com/v1
Authentication: Header X-API-Key: YOUR_API_KEY
| Method | Endpoint | Purpose |
|---|---|---|
| GET | / | API info, version, resource URLs, documentation and contact links |
| GET | /balance | Account balance (e.g. USD) |
| GET | /catalog | List/filter products (v1 fields: charged_price, product_type, pagination URLs; default per_page 50) |
| GET | /catalog/{category} | Products by merchandising category (not product_type) |
| POST | /orders | Create order (item_code, quantity, optional email; fields required for direct_top_up) |
| POST | /orders/validate-fields | Validate buyer fields before direct top-up purchase |
| POST | /orders/check | Check stock (item_id, quantity); returns min/max/available quantity + price |
| GET | /orders | List orders (per_page, status, sort_by, order) |
| GET | /orders/{id} | Single order details and status (order_id from create response). Poll while pending if you do not use webhooks. |
| — | Outbound webhook | Optional HTTPS POST to your URL when an order is created or becomes terminal. Not an API path you call. See webhooks. |
All responses use the envelope: success, message, data. See Concepts for details. Per-key rate limits typically 100 requests per 60 seconds; HTTP 429 includes data.retry_after — see Security.