Entrar

Saldos de acúmulo

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

Retorna os saldos de fidelidade da organização agregados por uma janela de data. Os cards são filtrados pela data de criação (createAt) entre dateStart e dateEnd.

É um GET e não recebe body. As duas datas são path params obrigatórios (YYYY-MM-DD).

Para ler o saldo atual de um único cliente, use Saldos de acúmulo por pessoa — esse soma todos os cards do cliente, sem janela de data.

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 creditado nos cards criados na janela (soma de todos os créditos)
available int Saldo ainda disponível para resgate (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
dateStart * string Start of the window, filters cards by createAt (YYYY-MM-DD)
dateEnd * string End of the window, filters cards by createAt (YYYY-MM-DD)

Respostas

{
    "total": 1284500,
    "available": 642100,
    "expired": 310200,
    "canceled": 12000,
    "used": 320200,
    "byWallet": {
        "12": {
            "name": "Cashback",
            "rewardType": "monetary",
            "total": 1284500,
            "available": 642100,
            "expired": 310200,
            "canceled": 12000,
            "used": 320200
        }
    }
}
Copied to clipboard