HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Reverse a store credit HOLD transaction

Creates a transaction reverting a HOLD operation. Might be used when:

  • a customer decided not to use store credit for their sale/order
  • a customer discarded/forgot/lost their sale/order
  • a customer successfully imported a sale and must convert the HOLD operation into the REDEMPTION operation

🔒 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 of the hold owner

Body Params
string

id of a previous HOLD transaction

Responses
200

The hold transaction was reverted succesfully

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