Sign in

v4

latestOpenAPI 3.0.02026-07-31811,0021.1 MB
Customer

Retrieve the amount of points of a given customer

get/v1/pvt/Customer/{id}/points

Path parameters

idstring required

Id from the client`s store, usually email address

Response

CustomerExistsboolean

If True the customer was found on the Bonifiq DB

InternalIdstring

ID for this customer on the Bonifiq DB

PointsBalanceinteger

Amount of points for this customer.

CashbackBalancenumber

When the cashback reward is active it returns the amount (in R$) of cashback the customer have Returns 0 when the cashback is inactive

RedeemKeystring nullable

Returns a key for this given point change

Namestring
All 81 operations