Cancel an existing reward using the OriginalKey

curl --request DELETE \
  --url https://api.bonifiq.com.br/v1/pvt/POS/rewards \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "OriginalKey": "<string>"
}
'

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "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>"
    }
  },
  "HasError": true
}

DELETE

pvt

POS

rewards

Cancel an existing reward using the OriginalKey

curl --request DELETE \
  --url https://api.bonifiq.com.br/v1/pvt/POS/rewards \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "OriginalKey": "<string>"
}
'

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "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>"
    }
  },
  "HasError": true
}

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Body

application/json

OriginalKey

string

The same OriginalKey used upon redeeming

Response

200 - application/json

ErrorMessage

string | null

Error message or description

ErrorCode

integer<int32> | null

Optional error code, if available

Result

object

Show child attributes

Result.Id

integer<int32>

Unique ID for this redeem

Result.Customer

object

Customer that redeemed this reward

Show child attributes

Result.Customer.OriginalId

string

This is the Id in the client store.

Result.Customer.PublicId

string | null

Bonifiq Plubic Id

Result.Customer.Name

string

Customer name.

Result.Customer.Email

string

Customer email.

Result.Customer.Phone

string | null

Customer Contact Phone.

Result.Customer.BirthdayDate

string<date-time> | null

Customer Birthdate.

Date when the customer made the register on client store.

Result.Customer.Document

string | null

Some document number from the customer, accepts any string.

Result.Customer.IsEnrolled

boolean

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

Result.Customer.ReferralURL

string | null

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

Result.Customer.WhatsappReferralUrl

string | null

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

Result.Customer.CurrentTier

object

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

Show child attributes

Result.Customer.CurrentTier.Name

string

Result.Customer.CurrentTier.Color

string

Result.Customer.CurrentTier.IconUrl

string

Result.ExternalCode

string

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

Result.CashValue

number<decimal> | null

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

Result.IsCanceled

boolean

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

Result.RedeemDate

string<date-time>

Date the reward was redeemed

Result.Points

object

Points record regenerated upon redeeming process

Show child attributes

Result.Points.Id

integer<int32>

Unique ID of the generated point

Result.Points.Points

integer<int32>

How many points was used

Result.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

Result.Points.EventKey

string

Unique key for this record. Used to preventing duplication

HasError

boolean

If true the request had an error.

This method can be used to redeem a reward in behalf of a customer.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

Cancel an existing reward using the OriginalKey

Authorizations

Body

Response