HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Create gift card

post
https://{domain_prefix}.retail.lightspeed.app/api/2.0/gift_cards

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create gift card parameters

The parameters taken by the create gift card API.

double
required

The amount to be loaded onto the gift card.

string
required

The number of the gift card.

uuid

The ID of the user creating the gift card.

string

The expiry date time of the gift card.

string

The timezone of the date times for the gift card.

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?