Entrar

Resgate: Reservar

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

Reserva o valor de redeemable de uma promessa de reward calculada previamente (o hash/confirmToken retornado pelo Acúmulo por pedido). A reserva entra em waitSettlement e segura os pontos no saldo do cliente até a confirmação do pedido (reserved → cancelled ou redeemed via Settle).

Try-it values populated from environment ACME (Demo)


Autenticação

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.

Cabeçalhos

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.

Parâmetros do caminho

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

Corpo da requisição

Content-Type: application/json

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

Respostas

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

Relacionados

Copied to clipboard