Skip to main content
GET
/
v1
/
pvt
/
Rewards
/
{id}
Return an existant reward already redeemed
curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Rewards/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "Id": 123,
  "Customer": {
    "OriginalId": "<string>",
    "PublicId": "<string>",
    "Name": "<string>",
    "Email": "<string>",
    "Phone": "<string>",
    "BirthdayDate": "2023-11-07T05:31:56Z",
    "SignupDate": "2023-11-07T05:31:56Z",
    "Document": "<string>",
    "IsEnrolled": true,
    "ReferralURL": "<string>",
    "WhatsappReferralUrl": "<string>",
    "CurrentTier": {
      "Name": "<string>",
      "Color": "<string>",
      "IconUrl": "<string>"
    },
    "BalanceOfPoints": 123,
    "BalanceCashback": 123
  },
  "ExternalCode": "<string>",
  "CashValue": 123,
  "IsCanceled": true,
  "RedeemDate": "2023-11-07T05:31:56Z",
  "Points": {
    "Id": 123,
    "Points": 123,
    "EventKey": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

​
id
integer<int32>
required

Response

200 - application/json
​
Id
integer<int32>

Unique ID for this redeem

​
Customer
object

Customer that redeemed this reward

​
ExternalCode
string

Unique external code for this redeem. Could be used for integrating with third-party systems

​
CashValue
number<decimal> | null

If it is a Cashback or Value rewards represents the amount in cash (R$) given for the customer

​
IsCanceled
boolean

If true means this reward was cancelled and the points was given back to the customer

​
RedeemDate
string<date-time>

Date the reward was redeemed

​
Points
object

Points record regenerated upon redeeming process