Skip to main content
GET
/
v1
/
pub
/
Customer
/
{id}
/
points
Retrieve the amount of points of a given customer
curl --request GET \
  --url https://api.bonifiq.com.br/v1/pub/Customer/{id}/points \
  --header 'X-BQ-ApiToken: <api-key>'
{
  "CustomerExists": true,
  "InternalId": "<string>",
  "PointsBalance": 123,
  "PointsToExpire": [
    {
      "Points": 123,
      "When": "2023-11-07T05:31:56Z"
    }
  ],
  "CashbackBalance": 123,
  "RedeemKey": "<string>",
  "PointHistory": [
    {
      "Id": 123,
      "DateReceived": "2023-11-07T05:31:56Z",
      "ExpirationDate": "2023-11-07T05:31:56Z",
      "Amount": 123,
      "CashbackAmount": 123,
      "BranchId": "<string>",
      "BranchName": "<string>"
    }
  ],
  "Name": "<string>"
}

Authorizations

X-BQ-ApiToken
string
header
required

API Tokeen

Path Parameters

id
string
required

Id from the client`s store

Response

200 - application/json

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

Amount of points for this customer.

PointsToExpire
object[]
CashbackBalance
number<decimal>

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

Returns a key for this given point change

PointHistory
object[]

A detailed list of point transactions for the customer.

Name
string