API Reference

Create a store credit HOLD transaction

post
https://{domain_prefix}.retail.lightspeed.app/api/2026-07/store_credits//hold

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

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

The customer id to create a hold for.

Body Params
double
required

The amount of the transaction.

string

The client id is a unique transaction identifier. See StoreCreditTransactionParams

Responses

Updated 5 days 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 days ago

Did this page help you?