Sign in

Redeem: Reserve

POST https://{organization}.myguper.com/api/loyalty/redeem/reserve/{hash}

Reserves the redeemable amount tied to a previously calculated reward promise (the hash/confirmToken returned by Reward by Order). The reservation enters waitSettlement and points are held against the customer's balance until the order is confirmed (reserved → cancelled or redeemed via Settle).

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header. Endpoints that support a Public mode (e.g. acúmulo and resgate previews) accept the same request without the header — Private mode adds customer data and a confirmation token to the response.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper. Omit only on endpoints that explicitly support a Public mode.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Path parameters

Name Type Description
hash * string Confirmation token returned by Reward by Order.

Request body

Content-Type: application/json

{
    "refId": "<refId>",                                         // optional
    "reserve": 0,                                               // optional, cents
    "couponCode": "<couponCode>"                                // optional
}

Responses

{
    "organization": "acme",
    "person":       184532,
    "redeem":       { "reserved": 1500 },
    "dateTime":     "2026-08-27T18:12:31-03:00"
}

Related

Copied to clipboard