Skip to main content
POST
/
v1
/
pvt
/
Customer
/
{id}
/
points
Add or remove points from a customer
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Customer/{id}/points \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Points": 123,
  "OperationType": 0,
  "Reason": "<string>",
  "ChangeKey": "<string>"
}
'
{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "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>",
    "Error": "<string>"
  },
  "HasError": true
}

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

id
string
required

Body

application/json

Point changing information

Change Points from a customer. Either E-mail or CustomerId are required

Points
integer<int32>

Amount of points to add or remove from customer. If adding it must be positive. If removing it must be negative

OperationType
enum<integer>

Either is adding or removing points from customer

Available options:
0,
1
Reason
string

Information regarding why these points are being add/removed. Internal information only. Required.

ChangeKey
string

This is a unique key for this add/remove point removal. If you try to use the same key more than once it will result in error

Response

200 - application/json
ErrorMessage
string | null

Error message or description

ErrorCode
integer<int32> | null

Optional error code, if available

Result
object

Customer Points Response Model Returns points customer have and an error if any

HasError
boolean

If true the request had an error.