Entrar

Saldos de acúmulo por pessoa

GET https://{organization}.myguper.com/api/loyalty/report/rewardBalances/person/{person}

Retorna o saldo de fidelidade consolidado de um cliente, somando todos os cards do cliente, sem janela de data. É o endpoint canônico para ler o saldo atual de um cliente — use o campo available como o valor disponível para resgate.

Isto é por CLIENTE, todas as campanhas somadas. Para o consolidado de UMA campanha — status, quanto ela distribuiu de bônus e quanto os clientes já resgataram (o aproveitamento) — não é aqui: use o Relatório da campanha.

É um GET e não recebe body. A única entrada é o person (id do cliente) no path.

Carteiras monetárias retornam valores em centavos (divida por 100 para obter o valor na moeda da org). Carteiras de pontos (rewardType: point) retornam a quantidade de pontos.

Campos da resposta

Campo Tipo Descrição
total int Tudo já creditado ao cliente (soma de todos os créditos, histórico)
available int Saldo disponível para resgate agora (cards não expirados e não cancelados)
expired int Saldo que expirou sem ser resgatado
canceled int Saldo de cards cancelados
used int Saldo já resgatado
byWallet object Os mesmos campos quebrados por carteira (policy), chaveado pelo id da carteira
byWallet[id].name string Nome da carteira
byWallet[id].rewardType string monetary ou point

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
person * number Customer (person) id in Guper

Respostas

{
    "total": 306943,
    "available": 111541,
    "expired": 88938,
    "canceled": 0,
    "used": 106464,
    "byWallet": {
        "12": {
            "name": "Cashback",
            "rewardType": "monetary",
            "total": 306943,
            "available": 111541,
            "expired": 88938,
            "canceled": 0,
            "used": 106464
        }
    }
}
Copied to clipboard