Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Store Credits

Create a store credit transaction

Creates a new store credit transaction. The type determines what sort of transaction it is.

  • "REDEMPTION" - Use this type when you want to redeem a certain amount from the store credit balance. The amount MUST be negative. If you want to add an amount to the balance use the "ISSUE" type. 🔒 Requires: store_credits:write:redeem
  • "ISSUE" - Use this type when you issue store credit to a customer. 🔒 Requires: store_credits:write:issue
  • "REVERSE" - Use this type when voiding an earlier ISSUE or REDEMPTION transaction. 🔒 Requires: store_credits:write:redeem

If the customer account does not have enough credit to honour a REDEMPTION 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. When creating an REVERSE operation, client_id must be equal to client_id of a reversed operation. See the tutorial for more information.

post/store_credits/{customerId}/transactions

Path parameters

customerIdstring uuid required

The customer id to apply the store transaction to.

Request body

amountnumber double required

The amount of the transaction.

client_idstring required

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

notesstring

The notes associated with the transaction.

type'ISSUE' | 'REDEMPTION' | 'REVERSE' required

The type of the transaction

user_idstring uuid

The user id of the person who handled the transaction.

Response

A transaction successfully created for the customer

amountnumber double

The amount of the transaction

client_idstring

An operation idempotency identifier. The client must provide this and normally it should be the transaction id from the client system. An operation and it's reverse operation must have the same client_id

created_atstring date-time

The date time the transaction was created.

idstring

transaction unique identifier (base64 encoded)

notesstring

The notes associated with the transaction.

sale_idstring uuid

The sale id the transaction is associated with. This should be null for transactions initiated outside of Lightspeed Retail. If it is a sale id, it will be in UUID format.

type'ISSUE' | 'REDEMPTION' | 'REVERSE'

The type of the transaction

user_idstring uuid

The user id of the person who performed the transaction (during a sale or a manual issue)

Example response

{
  "created_at": "2026-01-02T15:04:05Z"
}