FAQs
Common questions about integrating with the RewardOS API.
Orders
Section titled “Orders”1. What are the possible responses when placing an order?
Section titled “1. What are the possible responses when placing an order?”| Status | Description | Your Action |
|---|---|---|
SUCCESS |
Vouchers returned instantly | Display vouchers |
FAILED |
Order failed | Show error; new referenceId |
PROCESSING |
Generation in progress | Webhook or poll Get Order |
2. What should be done on timeout?
Section titled “2. What should be done on timeout?”Call /v1/partners/orders/by-reference/{referenceId}:
- 404 — order was not created; safe to retry with the same referenceId
- Any other response — order exists; process by status
3. How do I ensure idempotency?
Section titled “3. How do I ensure idempotency?”The referenceId is the idempotency key. It guarantees one order per id.
Brands
Section titled “Brands”4. How are product changes communicated?
Section titled “4. How are product changes communicated?”Subscribe to the Brand Updated webhook. Typical fields in the payload:
{ "id": "brand_id", "denominationType": "FIXED", "status": "ACTIVE", "denominations": [100, 1000, 5000], "amountRestrictions": { "minOrderAmount": 100, "maxOrderAmount": 5000, "minVoucherAmount": 100, "maxVoucherAmount": 5000 }}5. Should I show INACTIVE brands?
Section titled “5. Should I show INACTIVE brands?”No. Filter to ACTIVE for any user-facing catalog.
Auth & Ops
Section titled “Auth & Ops”6. How long do tokens last?
Section titled “6. How long do tokens last?”Typically expiresInSecs ≈ 3600. Cache and refresh before expiry; re-auth on 401.
7. Who do I contact for support?
Section titled “7. Who do I contact for support?”contact@rewardos.in — include environment, clientId (never the secret), and X-REQUEST-ID.