Skip to main content
POST
/
v1
/
pvt
/
RewardConfigurations
/
{id}
/
redeem
Redeem a reward for the customer given on the request body
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/RewardConfigurations/{id}/redeem \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CustomerId": "<string>"
}
'
{
  "Items": [
    {
      "Id": 123,
      "Points": 123,
      "RewardType": 0,
      "IsActive": true,
      "Value": 123,
      "PreTitle": "<string>",
      "Title": "<string>",
      "Description": "<string>",
      "LongDescription": "<string>",
      "HasValidDate": true,
      "ValidDateStart": "2023-11-07T05:31:56Z",
      "ValidDateEnd": "2023-11-07T05:31:56Z",
      "HasSameCustomerUsageLimit": true,
      "SameCustomerUsageLimit": 123,
      "HasGlobalUsageLimit": true,
      "GlobalUsageLimit": 123,
      "CustomTitle": "<string>",
      "UsageInstructions": "<string>",
      "CustomIconUrl": "<string>",
      "SendClientRedeemNotification": true,
      "ClientEmailsNotification": [
        "<string>"
      ],
      "SendCustomerRedeemNotification": true,
      "CustomerEmailConfigurationId": 123,
      "CustomerEmailConfiguration": {
        "Id": 123,
        "EmailBody": "<string>",
        "Subject": "<string>",
        "IsActive": true,
        "Type": 0,
        "Variables": [
          {
            "Name": "<string>",
            "Value": "<string>",
            "Description": "<string>"
          }
        ],
        "Title": "<string>",
        "Description": "<string>",
        "Group": 0,
        "SubType": 123,
        "HideLogoIsActive": true,
        "ChangeBackgroundColorIsActive": true,
        "ProductsRecommendationIsActive": true,
        "EmailBackgroundColor": "<string>",
        "ObjectiveLinkedType": 0,
        "PreHeader": "<string>"
      },
      "CodePrefix": "<string>",
      "CumulativeDiscount": true,
      "MinimalValue": 123,
      "ValidDays": 123,
      "CashbackMaxPurchaseValue": 123,
      "MinimumPercentPurchase": 123,
      "ManualCouponGeneration": true,
      "PreGeneratedCouponLists": [
        {
          "Id": 123,
          "ListName": "<string>",
          "PreGeneratedCoupons": [
            {
              "Id": 123,
              "OriginalId": "<string>",
              "CouponCode": "<string>",
              "CreatedDate": "2023-11-07T05:31:56Z",
              "IsAssigned": true,
              "CouponType": 0,
              "CouponValue": 123,
              "ValidDateStart": "2023-11-07T05:31:56Z",
              "ValidDateEnd": "2023-11-07T05:31:56Z",
              "CouponId": 123,
              "PreGeneratedCouponListId": 123
            }
          ],
          "IsInternalList": true,
          "CouponsType": 0,
          "CouponsValue": 123,
          "CouponCount": 123,
          "UsedCoupons": 123,
          "ReferralObjectiveId": 123
        }
      ],
      "Tiers": [
        {
          "Id": 123,
          "Name": "<string>",
          "Color": "<string>",
          "IconUrl": "<string>",
          "IsActive": true,
          "IsBase": true,
          "Order": 123,
          "CustomerCount": 123,
          "Identifier": "<string>",
          "Caption": "<string>"
        }
      ],
      "AvailableCashback": 123,
      "TiersCountInformation": "<string>",
      "IsCashbackInformativeOnly": true,
      "CashbackInformativeText": "<string>",
      "CashbackRules": "<string>",
      "CashbackBalance": 123,
      "PointBalance": 123,
      "CashbackPointValue": 123,
      "CashbackAmount": 123,
      "MaxCashbackForCurrentPurchase": 123,
      "Enabled": true,
      "DisabledReason": "<string>",
      "NoPointCost": true,
      "RequiredToAddMoreText": "<string>",
      "ShouldUseCustomInstruction": true,
      "ShouldExpireCouponsWhenNotAvailableInPlatform": true,
      "RewardChannel": 0,
      "ProductCollections": [
        "<string>"
      ],
      "WidgetIconActive": true,
      "WidgetIcon": "<string>",
      "LandingPageIconActive": true,
      "LandingPageIcon": "<string>",
      "ValidOnlyProductCollections": [
        "<string>"
      ],
      "AllowProductCollection": true,
      "ProductCollectionSelection": 0,
      "HasProductCollection": true,
      "Rules": {
        "RewardDescription": "<string>",
        "NonCumulativePromotion": "<string>",
        "MaximumPurchaseCashback": "<string>",
        "MinimalPurchaseRequirement": "<string>",
        "CouponValidityDays": "<string>",
        "CouponEmailConfirmation": "<string>"
      }
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true
}

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

id
integer<int32>
required

Body

application/json

Reward Redeem Request model

CustomerId
string

ID of the customer requesting the reward redeem. its the ID from the client store.

Response

200 - application/json
Items
object[]
TotalItemCount
integer<int32>
PageSize
integer<int32>
PageNumber
integer<int32>
HasNextPage
boolean