Create a gift card | FluxStore Docs

POST/api/v1/gift-cards

Create a new gift card. The redemption code is generated server-side and is shown ONCE. See the response example below.

The redemption code is the only field of the create response that is ever exposed by the API. Subsequent reads (GET /gift-cards/{id}) do not include it. Save it now or you will have to delete and recreate the card.

Requires the GiftCards:Edit permission.

Body

amountnumberrequired

Initial value of the gift card.

applicationScopestringrequired

What the card can be redeemed against.

Values:: storecategorypackage

categoryIdsstring[]· uuid

Required when scope is category.

packageIdsstring[]· uuid

Required when scope is package.

recipientNamestring

Recipient name (for the gift card display).

recipientEmailstring· email

Recipient email.

messagestring

Personalized message.

expiresAtstring· date-time

Optional expiry timestamp.

POST/api/v1/gift-cards


curl -X POST \
  -H "X-Api-Key: flx_XXXX_XXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 25.00,
    "applicationScope": "store",
    "recipientName": "John",
    "recipientEmail": "[email protected]",
    "message": "Happy Birthday!",
    "expiresAt": "2027-01-01T00:00:00Z"
  }' \
  https://api.fluxstore.net/api/v1/gift-cards

200OK


{
  "success": true,
  "data": {
    "id": "gc_a1b2c3...",
    "code": "GIFT-XXXX-YYYY-ZZZZ",
    "amount": 25.00,
    "balance": 25.00,
    "status": "active"
  }
}