HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Create a store credit HOLD transaction

Creates a transaction that represents temporary store credit redemption
meaning, that store credit points are spent on a Sale somewhere outside of X-Series.
When that sale will be imported, X-Series (or a 3rd party integration) should do the following:

  • add a REVERSE transaction for the HOLD, to free the store credit points back for spending
  • add a REDEMPTION transaction to conclude the store credit spending on the X-Series side.

See Create sale's store_credit_hold_id property

🔒 Requires: store_credits:write:redeem

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

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json