API Reference

Create a store credit transaction

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

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.
  • "ISSUE" - Use this type when you issue store credit to a customer.
  • "REVERSE" - Use this type when voiding an earlier ISSUE or REDEMPTION transaction.

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. See the tutorial for more information.

🔒 Requires: store_credits:write:issue customers:read scopes

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

The customer id to apply the store transaction to.

Body Params

The store credit transaction details

double
required

The amount of the transaction.

string
required

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

string

The notes associated with the transaction.

string
required

The store credit customer id

string
enum
required

The type of the transaction

Allowed:
uuid

The user id of the person who handled the transaction.

Responses

Updated 3 months 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 3 months ago