API Reference

Create a gift card transaction

post
https://{domain_prefix}.retail.lightspeed.app/api/2026-04/gift_cards//transactions

Creates a new gift card transaction on the specified gift card. The request body requires the type, amount, and client_id fields. The type determines what sort of transaction it is.

  • "REDEEMING" - Use this type when you want to redeem a certain amount from the gift card balance. The amount MUST be negative. If you want to add an amount to the balance use the "RELOADING" type.
  • "RELOADING" - Use this type when you load a new amount onto a gift card.

If the gift card does not have enough credit to honour the transaction a 422 HTTP status code will be returned.

Idempotency

Please populate the client_id field with a unique transaction identifier, to ensure that the transaction is safe from double-submit problems. See the tutorial for more information.

🔒 Requires: gift_cards:write:redeem scope

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

The number of the gift card to add the transaction to.

Body Params

Create gift card transaction parameters

The parameters for creating a new gift card transaction.

string
required

The transaction amount. Must be negative for REDEEMING transactions and positive for RELOADING transactions.

string
required

A unique transaction identifier for idempotency. The client must provide this and is normally the transaction id from the client system.

string

Optional new expiry date for the gift card in YYYY-MM-DD format. Can be used to extend the gift card's expiry when reloading.

string

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.

string
enum
required

The type of the transaction.

Allowed:
string

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

Responses

Updated 15 days ago

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

Updated 15 days ago