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>"
    }
  },
  "ExternalCode": "<string>",
  "CashValue": 123,
  "IsCanceled": true,
  "RedeemDate": "2023-11-07T05:31:56Z",
  "Points": {
    "Id": 123,
    "Points": 123,
    "Type": 0,
    "EventKey": "<string>"
  }
}

GET

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>"
    }
  },
  "ExternalCode": "<string>",
  "CashValue": 123,
  "IsCanceled": true,
  "RedeemDate": "2023-11-07T05:31:56Z",
  "Points": {
    "Id": 123,
    "Points": 123,
    "Type": 0,
    "EventKey": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Path Parameters

integer<int32>

required

Response

200 - application/json

integer<int32>

Unique ID for this redeem

Customer

object

Customer that redeemed this reward

Show child attributes

Customer.OriginalId

string

This is the Id in the client store.

Customer.PublicId

string | null

Bonifiq Plubic Id

Customer.Name

string

Customer name.

Customer.Email

string

Customer email.

Customer.Phone

string | null

Customer Contact Phone.

Customer.BirthdayDate

string<date-time> | null

Customer Birthdate.

Date when the customer made the register on client store.

Customer.Document

string | null

Some document number from the customer, accepts any string.

Customer.IsEnrolled

boolean

If true the customer is participating on the points plan from the store.

Customer.ReferralURL

string | null

Customer`s Referral URL. Will be null if the Referral Objective is not active.

Customer.WhatsappReferralUrl

string | null

Customer`s Referral URL for sharing in Whatsapp. Will be null if Referral Objective is not active

Customer.CurrentTier

object

If the customer is in a Tier returns it. Otherwise returns null

Show child attributes

Customer.CurrentTier.Name

string

Customer.CurrentTier.Color

string

Customer.CurrentTier.IconUrl

string

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

Show child attributes

Points.Id

integer<int32>

Unique ID of the generated point

Points.Points

integer<int32>

How many points was used

Points.Type

enum<integer>

Type of the point. Could be any of:

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

13,

14,

15,

16

Points.EventKey

string

Unique key for this record. Used to preventing duplication

Redeem a reward for the customer given on the request body Cancel an existing reward. By canceling the customer will have their points back. The reward will be in the canceled state.

⌘I

API Privada

API Pública

Endpoint Examples

Return an existant reward already redeemed

Authorizations

Path Parameters

Response