Skip to main content
GET
Retrieve the amount of points of a given customer

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

id
string
required

Id from the client`s store, usually email address

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