v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB

Gift Cards

Create gift card

Creates and activates a new gift card. The gift card will be created with one transaction with status "ACTIVATION" which contains the initial balance of the gift card.

🔒 Requires: gift_cards:write:issue scope

post/gift_cards

Request body

amountstring required

The initial balance to be loaded onto the gift card. Represented as a string for precision (e.g. "100.00").

expires_atstring

The expiry date of the gift card in YYYY-MM-DD format. If omitted, the expiry will be calculated based on the validity period configured in the Lightspeed Retail UI, or will be null if expiry is not enabled.

numberstring required

The unique number to assign to the gift card.

time_zonestring

The timezone to use when interpreting the expires_at date (e.g. "Pacific/Auckland"). See the list of tz database time zones for valid values.

user_idstring

The ID of the user creating the gift card. If omitted, the authenticated user will be used.

Example request

{
  "amount": "10.00"
}

Response

Gift card successfully created.