Orders Overview
Create, track, and manage digital product orders with real-time status and voucher delivery
Orders Overview
The Orders API enables complete order lifecycle management for digital products, from creation through fulfillment with secure voucher delivery.
Order Ecosystem
Order Creation Initiate purchases for gift cards, mobile top-ups, and digital services with multi-currency support and real-time inventory validation.
Order Tracking Monitor order status from placement through delivery with detailed transaction history and status updates.
Voucher Delivery Secure delivery of digital vouchers with encrypted codes, PINs, and redemption instructions upon successful order completion.
API Documentation
Create Order API
Submit new orders for digital products with customer information and payment processing.
Key Operations:
- Submit order with product selection
- Provide customer information
- Specify payment method
- Receive order confirmation
→ Create Order API Documentation
List Orders API
Search and filter order history with comprehensive pagination and filtering options.
Key Operations:
- View order history with pagination
- Filter by status, product, or date
- Access order summaries
- Monitor order pipeline
→ List Orders API Documentation
Get Order Details API
Retrieve complete order information including decrypted voucher codes for delivered orders.
Key Operations:
- Get detailed order information
- Access decrypted voucher codes
- View delivery status
- Track fulfillment progress
→ Get Order Details API Documentation
Quick Start
- Authenticate - Get your access token via the Authentication API
- Browse Products - Use the Products API to find products
- Calculate Pricing - Use the Charges API to get pricing
- Create Order - Submit order using the Create Order API
- Track Status - Monitor orders with List Orders API
- Deliver Vouchers - Retrieve codes via Get Order Details API
Order Status Flow
Pending
Order has been placed and is awaiting processing. Payment validation is complete.
Processing
Order is actively being processed. Voucher codes are being generated.
Delivered
Order has been successfully completed. Voucher codes are available and can be retrieved via the order details endpoint.
Failed or Cancelled
Order could not be completed due to payment failure, inventory issues, or cancellation. No vouchers were generated.
Order Status Values
Primary Status
| Status | Description | Vouchers Available |
|---|---|---|
PLACED | Order has been placed | No |
PENDING | Order placed, awaiting processing | No |
DELIVERED | Order completed successfully | Yes |
PARTIALLY_DELIVERED | Some items delivered | Partial |
CANCELLED | Order was cancelled | No |
FAILED | Order processing failed | No |
Sub Status
Orders also have a detailed sub-status that provides more granular information about processing:
| Sub Status | Description |
|---|---|
PARTIAL | Partial completion of order items |
INITIAL | Initial state after order creation |
REFUNDED | Order has been refunded |
COMPLETED | Order fully completed |
NOT_REFUNDED | Failed order not yet refunded |
RECONCILED | Order reconciled with vendor |
PROCESSING | Order is being processed |
VENDOR_ORDER_PENDING | Waiting for vendor order creation |
VENDOR_ORDER_CREATED | Vendor order has been created |
VENDOR_VOUCHER_FETCHED | Vouchers fetched from vendor |
GV_LINK_PENDING | Gift voucher link creation pending |
GV_LINK_CLAIMED | Gift voucher link has been claimed |
GV_LINK_UNCLAIMED | Gift voucher link not yet claimed |
BULK_LIMIT_EXCEEDED | Bulk order limit exceeded |
Additional Order Enums
Delivery Mode
| Mode | Description |
|---|---|
ONLINE | Voucher delivered online/digitally |
OFFLINE | Voucher delivered offline/physically |
ONLINE_OR_OFFLINE | Supports both delivery modes |
NA | Not applicable |
Delivery Type
| Type | Description |
|---|---|
REALTIME | Immediate delivery upon order completion |
DELAYED | Delivery scheduled for later time |
Classification
| Type | Description |
|---|---|
OPEN_LOOP | Can be used at multiple merchants |
CLOSED_LOOP | Can only be used at specific merchant |
SEMI_OPEN | Limited to merchant group/category |
SEMI_CLOSE | Restricted but broader than closed loop |
Link Type
| Type | Description |
|---|---|
PRIVATE | Private voucher link (restricted access) |
PROTECTED | Protected voucher link (password/auth required) |
Inventory Status
| Status | Description |
|---|---|
AVAILABLE | Inventory available for allocation |
ALLOCATED | Inventory allocated to order |
DELIVERED | Inventory delivered to customer |
COMPLETED | Inventory fulfillment completed |
BLOCKED | Inventory blocked from use |
REVOKED | Inventory revoked/cancelled |
Recharge Status
| Status | Description |
|---|---|
PENDING | Recharge request pending |
DELIVERED | Recharge delivered successfully |
FAILED | Recharge failed |
CANCELLED | Recharge cancelled |
RECHARGED | Recharge completed |
Security Features
Encryption
All sensitive voucher data is encrypted at rest using AES-256 encryption:
- Card/voucher numbers
- PIN codes
- Reference numbers
- Redemption URLs
Access Control
- JWT authentication required for all endpoints
- Client-specific order visibility
- Audit logging for all order operations
Data Protection
- Vouchers only decrypted when order is delivered
- Secure transmission over HTTPS
- PCI compliance for payment card data
Common Integration Patterns
Validate Product Availability
Before creating an order, verify the product is available for the desired denomination and quantity using the Product Availability API. This prevents order failures due to availability issues.
Calculate Total Cost
Use the Charges API to calculate the exact cost including discounts, fees, and taxes. Display this transparent pricing to customers before order creation.
Create Order
Submit the order with customer details and payment information. The order will be validated and processed asynchronously. Store the returned order ID for tracking.
Poll for Completion
Check the order status periodically using the Get Order Details endpoint. When status changes to "delivered", voucher codes become available.
Retrieve Vouchers
Once delivered, fetch the complete order details to access decrypted voucher codes, PINs, and redemption instructions. Deliver these securely to your customer.
Best Practices
- Idempotency - Include unique reference codes to prevent duplicate orders
- Error Handling - Implement robust retry logic for transient failures
- Status Monitoring - Poll order status at reasonable intervals (e.g., every 30 seconds)
- Secure Storage - Never log or store decrypted voucher codes
- Customer Communication - Send status updates via email/SMS during processing
Next Steps
- Create Orders - Submit new orders
- List Orders - View order history
- Get Order Details - Retrieve vouchers
- Authentication - Secure API access