HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Reverse a store credit HOLD transaction

Reverses a store-credit hold, making the held credit available again.

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

Body Params
string
required
length ≥ 1

URL-safe base64-encoded eight-byte ID of the previous HOLD transaction.

Responses
200

The hold was reversed or had already been reversed; no response body.

400

Malformed/missing reference ID, invalid/non-HOLD transaction, or disabled store credit.

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