Sign in

Reward Direct: Consume

PUT https://{organization}.myguper.com/api/loyalty/reward

Debits points from a customer's reward balance against an order payload. Computes the value as total_item / pointsDivisor * pointsDividend against the resolved policy, then executes the redeem on the matching cards (FIFO by expiration).

Returns the cards that were touched plus the actual debited value.

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.

Request body

Content-Type: application/json

{
    "interface": "generic",
    "storeId": "1",
    "client": 47,
    "value": 96390                                              // cents
}

Responses

Copied to clipboard