Entrar

Saldos de acumulación

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

Devuelve los saldos de fidelidad de la organización agregados por una ventana de fechas. Las tarjetas se filtran por su fecha de creación (createAt) entre dateStart y dateEnd.

Es un GET y no recibe body. Ambas fechas son path params obligatorios (YYYY-MM-DD).

Para leer el saldo actual de un solo cliente, usa Saldos de acumulación por persona — ese suma todas las tarjetas del cliente, sin ventana de fechas.

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 en tarjetas creadas en la ventana (suma de todos los créditos)
available int Saldo aún disponible para canjear (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
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)

Respuestas

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