Skip to main content
POST
Retrieve the amount of points of a given customer using a body-based customer identifier.

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Body

application/json

Customer identifier data. CustomerId remains required. When Checkout.CustomerOriginalIdSource is configured as document or email, lookup uses Customer.Document or Customer.Email respectively.

Request used by private endpoints that identify the customer in the body.

CustomerId
string

Legacy customer identifier used by the merchant platform. This field remains required. When Checkout.CustomerOriginalIdSource is configured as document or email, BonifiQ ignores this value for lookup and uses the configured Customer field instead.

Customer
object | null

Customer identifiers used when Checkout.CustomerOriginalIdSource is configured as document or email.

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