HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Create a store credit transaction

Creates a store-credit transaction to issue, redeem or reverse credit. Use client_id to avoid duplicate transactions; see the idempotency tutorial.

  • ISSUE: 🔒 Requires: store_credits:write:issue scope
  • REDEMPTION or REVERSE: 🔒 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 apply the store transaction to.

Body Params

The store credit transaction details

string
enum
required

The type of the transaction

Allowed:
required
> 0

Number or decimal string, including scientific notation. Null is decoded as zero; ISSUE/REDEMPTION enforce their amount signs.

string | null

Optional idempotency identifier, normally the transaction ID from the client system.
Maximum length is 36 bytes.

string | null

URL-safe base64-encoded eight-byte ID of a HOLD to reverse before applying this REDEMPTION. The amounts must match exactly.

string | null

The notes associated with the transaction.

uuid | null

The ID of the associated sale. Optional for ISSUE and REDEMPTION transactions; required for REVERSE transactions.

uuid

The user id of the person who handled the transaction.

string | null

Optional URL-safe base64-encoded eight-byte transaction reference, not a UUID.

Responses

400

Malformed JSON, invalid type/amount/IDs, conflicting client_id parameters, invalid hold, 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