Overview
Learn how to instantly create gift card orders and receive payout details in a single API call. This method is ideal for real-time fulfillment scenarios where you need immediate access to the gift card.
Key Concepts
- Gift Card: A digital prepaid card with specific value (product + currency + denomination)
- Payout: A unique instance of a gift card with its own access URL and status
- Accessed Payout: Any payout where the URL has been retrieved at least once
Prerequisites
- Generate an API key from the Game Optimiser webapp
- Add API key to request headers:
Authorization: your-api-key
Step-by-Step Guide
-
Initiate Synchronous Order
- Send POST request to
/orders/sync
- Specify product ID, currency, and denomination in request body
- Send POST request to
-
Receive Instant Fulfillment
- API responds within 29 seconds with:
- Order status (success/failure)
- Payout details including:
- Direct access URL
- Expiration timestamp
- Unique payout ID
- API responds within 29 seconds with:
-
Automatic Access Tracking
- The payout is immediately marked as "accessed"
- Subsequent calls to get latest unaccessed payout will not return this card
When to Use
- Real-time gift card delivery
- Single card purchases
- Scenarios requiring immediate success/failure confirmation
Important Notes
- Your account balance is deducted immediately on success
- Payout URLs should be treated as sensitive single-use credentials
- Failed orders automatically refund your balance