---
title: "Retrieve the amount of points of a given customer"
method: GET
path: "/v1/pub/Customer/{id}/points"
tags: ["Customer"]
---

# Retrieve the amount of points of a given customer

`GET /v1/pub/Customer/{id}/points`

## Path parameters

- `id` string, required

## Response `200`

- CustomerPointsResponse — Customer Points Response Model
  - `CustomerExists` boolean — If True the customer was found on the Bonifiq DB
  - `InternalId` string — ID for this customer on the Bonifiq DB
  - `PointsBalance` integer — Amount of points for this customer.
  - `PointsToExpire` CustomerPointsToExpire[]
    - `Points` integer — Amount of Points
    - `Cashback` number, nullable — Cashback value represented by the expiring points
    - `When` string, date-time — Expiration Date of the points
  - `CashbackBalance` number — When the cashback reward is active it returns the amount (in R$) of cashback the customer have Returns 0 when the cashback is inactive
  - `RedeemKey` string, nullable — Returns a key for this given point change
  - `PointHistory` PointDetailItem[] — A detailed list of point transactions for the customer.
    - `Id` integer — The unique identifier for the point transaction.
    - `IsCanceled` boolean — Indicates whether this history item was canceled.
    - `DateReceived` string, date-time — The date when the points were received or redeemed.
    - `ExpirationDate` string, date-time, nullable — The calculated expiration date for these points.
    - `Amount` integer — The amount of points in this transaction (positive for received, negative for redeemed).
    - `CashbackAmount` number, nullable — The amount of cashback associated with this transaction, if applicable.
    - `BranchId` string, nullable — The ID of the branch associated with the point transaction (if applicable, e.g., from an order).
    - `BranchName` string, nullable — The name of the branch associated with the point transaction (if applicable, e.g., from an order).
    - `OrderOrigin` 0 | 1 | 2 | 3 | 4
    - `OrderOriginDescription` string, nullable — Human-readable description for the order origin when the point comes from a purchase order.
    - `PointType` integer, nullable — The type of the point transaction (e.g., Purchase, Signup, Birthday, etc.).
    - `PointTypeDescription` string, nullable — Human-readable description of the point type.
    - `OrderValue` number, nullable
    - `OrderId` string, nullable
  - `Name` string

---

[API](https://skmtc.net/bonifiq/apis/bonifiq-public-apis.md) · [All operations](https://skmtc.net/bonifiq/apis/bonifiq-public-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bonifiq/bonifiq-public-apis/revisions/8d1f2698a854/schema)