Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Store Credits

Create a store credit HOLD transaction

Creates a tranaction that represents temporary store credit redemption That redemption should be reverted later AND may get followed by a REDEMPTION

post/store_credits/{customerId}/hold

Path parameters

customerIdstring uuid required

The customer id to create a hold for.

Request body

amountnumber double required

The amount of the transaction.

client_idstring

The client id is a unique transaction identifier. See StoreCreditTransactionParams

Response

A HOLD Transaction successfully created for a 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"
}