Sign in

Redeem: Settle

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

Settles a redeem reservation — converts a reserved hold into a final redeemed debit on the customer's balance. Called after the order is confirmed by the payment/POS layer.

The {hash} is the transaction id, not a card id: one call settles every card held by that reservation.

Note the response shape: the status is the key inside redeem, not a value — {"redeem": {"rescued": 1500}}, where the number is the amount in cents.

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 of the reservation to settle.

Responses

{
    "organization": "acme",
    "person":       184532,
    "redeem":       { "rescued": 1500 },
    "dateTime":     "2026-08-27T18:13:25-03:00"
}

Related

Copied to clipboard