Entrar

Saldos de acumulación por persona

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

Devuelve el saldo de fidelidad consolidado de un cliente, sumando todas las tarjetas del cliente, sin ventana de fechas. Es el endpoint canónico para leer el saldo actual de un cliente — usa el campo available como el monto disponible para canjear.

Esto es por CLIENTE, todas las campañas sumadas. Para el consolidado de UNA campaña — estatus, cuánto distribuyó de bono y cuánto ya canjearon los clientes (el aprovechamiento) — no es aquí: usa el Reporte de la campaña.

Es un GET y no recibe body. La única entrada es el person (id del cliente) en el path.

Las carteras monetarias devuelven valores en centavos (divide por 100 para obtener el monto en la moneda de la org). Las carteras de puntos (rewardType: point) devuelven la cantidad de puntos.

Campos de la respuesta

Campo Tipo Descripción
total int Todo lo acreditado al cliente (suma de todos los créditos, histórico)
available int Saldo disponible para canjear ahora (tarjetas no expiradas y no canceladas)
expired int Saldo que expiró sin ser canjeado
canceled int Saldo de tarjetas canceladas
used int Saldo ya canjeado
byWallet object Los mismos campos desglosados por cartera (policy), indexado por el id de la cartera
byWallet[id].name string Nombre de la cartera
byWallet[id].rewardType string monetary o point

Try-it values populated from environment ACME (Demo)


Autenticación

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.

Encabezados

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 de ruta

Name Type Description
person * number Customer (person) id in Guper

Respuestas

{
    "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