Giftcard API
Giftcards are claims on locked value, not free-form codes. Creation, purchase, redemption, and merchant redemption all depend on escrow-backed funds and fraud controls.
Endpoints
| Endpoint | Method | Auth | Headers | Notes |
|---|---|---|---|---|
List or create giftcards/giftcards/api/giftcards/Create a user or merchant giftcard and lock value in escrow. |
POST | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Status lifecycle: created, active, redeemed, expired, cancelled, refunded Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Giftcard status/giftcards/api/giftcards/status/{code}/Resolve a giftcard by code and return its masked state. |
GET | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Redeem giftcard/giftcards/api/redeem-giftcard/Redeem a giftcard into an EgaCard wallet. |
POST | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Webhooks: giftcard.redeemed, wallet.credited Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Redeem merchant giftcard/business/api/v1/public/giftcards/redeem/Merchant-signed redemption flow for external platforms. |
POST | Merchant HMAC Authenticated caller |
X-EGACARD-API-KEY: <merchant-public-key>X-EGACARD-SIGNATURE: <hmac-signature>X-EGACARD-TIMESTAMP: <unix-timestamp>X-EGACARD-IDEMPOTENCY-KEY: <unique-request-key> |
Idempotency: Required Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |