HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Create a store credit HOLD transaction

Temporarily holds a customer's store credit for a sale outside X-Series. When the sale is imported, reverse the hold and create a redemption.

See Create sale's store_credit_hold_id property.

🔒 Requires: store_credits:write:redeem scope

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
required
> 0

Strictly positive number or decimal string, including scientific notation.

string
length ≤ 36

The client id is a unique transaction identifier. See StoreCreditTransactionParams

Responses

403

Access is forbidden.

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