BObonifiq
Customer

Retrieve the amount of points of a given customer using a body-based customer identifier.

Changed on
post/v1/pvt/Customer/points

Request

  • Base URL
    https://api.bonifiq.com.br
  • Auth
    HTTP basic

Request body

CustomerIdstring

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.

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

Changes