---
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`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pub/Customer/{id}/points`
- Auth: API key in header `X-BQ-ApiToken`

## 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 to expire, ordered by expiration date. A batch with no expiration date of its own gets an estimated date, which may not happen.
    - `Points` integer: Amount of Points
    - `Cashback` number, nullable: Cashback value represented by the expiring points
    - `When` string, date-time: Expiration Date of the points
  - `NextPointsToExpire` CustomerPointsToExpire: Customer Points to expire Model
    - `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
  - `PendingOrders` CustomerPendingOrderResponse[]: Most recent orders still waiting to receive purchase points, with the estimated points and cashback. The estimate may change until the points are granted.
    - `OrderId` string, nullable: Order id from the client's store.
    - `OrderDate` string, date-time: Order date informed by the integration.
    - `OrderValue` number: Order amount considered for point calculation.
    - `PendingPoints` integer: Estimated points to be granted for this order.
    - `PendingCashback` number, nullable: Estimated cashback equivalent for this order when cashback is active. Otherwise null.
  - `Name` string

## Changes

- **2026-10-20** `f2efc122015c`: 1 info
  - added the optional property `NextPointsToExpire` to the response with the `200` status
- **2026-10-06** `5ad32c30a32d`: 1 info
  - added the optional property `PendingOrders` to the response with the `200` status
- **2026-07-21** `68467b3da966`: 2 info
  - added the optional property `PointHistory/items/OrderId` to the response with the `200` status
  - added the optional property `PointHistory/items/OrderValue` to the response with the `200` status

[Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-public-apis/changes/v1/pub/Customer/:id/points/get.md)

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-public-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-public-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-public-apis/revisions/9de22a81f454?raw)