---
title: "Redeem a reward for the customer given on the request body"
method: POST
path: "/v1/pvt/RewardConfigurations/{id}/redeem"
tags: ["RewardConfigurations"]
---

# Redeem a reward for the customer given on the request body

`POST /v1/pvt/RewardConfigurations/{id}/redeem`

## Path parameters

- `id` integer, required

## Request body

- RedeemRewardRequest — Reward Redeem Request model
  - `CustomerId` string — ID of the customer requesting the reward redeem. its the ID from the client store.
  - `Customer` ExternalApiCustomerIdentifierRequest — Optional customer identifiers used when the tenant configuration changes which value is used as the customer's OriginalId.
    - `Document` string, nullable — Customer document. Required when `Checkout.CustomerOriginalIdSource` is set to `document`. The value is normalized to digits only before the customer lookup.
    - `Email` string, nullable — Customer e-mail. Required when `Checkout.CustomerOriginalIdSource` is set to `email`.

## Response `200`

- BaseApiListResultOfApiRewardConfiguration
  - `Items` object[]
    - `Id` integer
    - `Points` integer
    - `RewardType` 0 | 1 | 2 | 3 | 4 — 0 = PercentDiscountCoupon 1 = ValueDiscountCoupon 2 = FreightDiscountCoupon 3 = PointToCashback 4 = Customized
    - `IsActive` boolean
    - `Value` number
    - `PreTitle` string, nullable
    - `Title` string, nullable
    - `Description` string, nullable
    - `LongDescription` string, nullable
    - `HasValidDate` boolean
    - `ValidDateStart` string, date-time, nullable
    - `ValidDateEnd` string, date-time, nullable
    - `HasSameCustomerUsageLimit` boolean
    - `SameCustomerUsageLimit` integer
    - `HasGlobalUsageLimit` boolean
    - `GlobalUsageLimit` integer
    - `CustomTitle` string, nullable
    - `UsageInstructions` string, nullable
    - `CustomIconUrl` string, nullable
    - `SendClientRedeemNotification` boolean
    - `ClientEmailsNotification` string[]
    - `SendCustomerRedeemNotification` boolean
    - `CustomerEmailConfigurationId` integer, nullable
    - `CustomerEmailConfiguration` ApiCustomerEmailConfiguration
      - `Id` integer
      - `EmailBody` string
      - `Subject` string
      - `IsActive` boolean
      - `Type` 0 | 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 29 — 0 = EarnPurchasePoints 1 = EarnBirthdayPoints 2 = EarnSignupPoints 3 = RedeemPoints 5 = EarnReviewPoints 6 = NotifyExpirablePoints 7 = PointsToUse 8 = CouponsToUse 9 = ReferralCommunicationPoints 10 = RewardCustomRedeemNotification 11 = CustomerPointChangeNotification 12 = CustomerTierUpgradeNotification 13 = CustomerTierDowngradeNotification 14 = SentOTPToCustomer 15 = EarnSocialMediaFollowFacebook 16 = EarnSocialMediaFollowInstagram 17 = EarnQuizPoints 18 = EarnCustomObjectivePoints 19 = InactiveAffiliate 20 = InactiveAffiliateProjectAffiliate 21 = EarnSocialMediaFollowLinkedin 22 = EarnSocialMediaFollowTikTok 23 = ReactivationCampaignStart 24 = ReactivationCampaignEnd 25 = Participation 26 = EarnFitnessPoints 29 = AccelerationCampaign
      - `Variables` object[], nullable
        - `Name` string
        - `Value` string
        - `Description` string
      - `Title` string, nullable
      - `Description` string, nullable
      - `Group` 0 | 1 — 0 = Earnpoints 1 = Others
      - `SubType` integer, nullable
      - `HideLogoIsActive` boolean
      - `ChangeBackgroundColorIsActive` boolean
      - `ProductsRecommendationIsActive` boolean
      - `EmailBackgroundColor` string, nullable
      - `CustomCssIsActive` boolean
      - `CustomCss` string, nullable
      - `ObjectiveLinkedType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — 0 = Purchase 1 = Signup 2 = Birthday 3 = Review 4 = Referral 5 = SocialMediaFollowInstagram 6 = SocialMediaFollowFacebook 7 = Quiz 8 = Custom 9 = SocialMediaFollowLinkedin 10 = SocialMediaFollowTikTok 11 = Participation 12 = Fitness
      - `PreHeader` string, nullable
    - `CodePrefix` string, nullable
    - `CouponCodeLength` integer, nullable
    - `CumulativeDiscount` boolean
    - `MinimalValue` number, nullable
    - `ValidDays` integer, nullable
    - `CashbackMaxPurchaseValue` number, nullable
    - `MinimumPercentPurchase` number, double, nullable
    - `ManualCouponGeneration` boolean
    - `PreGeneratedCouponLists` object[], nullable
      - `Id` integer
      - `ListName` string
      - `ValidDateStart` string, date-time, nullable
      - `ValidDateEnd` string, date-time, nullable
      - `PreGeneratedCoupons` object[], nullable
        - `Id` integer
        - `OriginalId` string — This is the Id in the third party system.
        - `CouponCode` string
        - `CreatedDate` string, date-time
        - `IsAssigned` boolean
        - `CouponType` 0 | 1 | 2 | 3 | 4 — 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others
        - `CouponValue` number
        - `ValidDateStart` string, date-time, nullable
        - `ValidDateEnd` string, date-time, nullable
        - `CouponId` integer, nullable
        - `PreGeneratedCouponListId` integer
      - `IsInternalList` boolean
      - `CouponsType` 0 | 1 | 2 | 3 | 4 — 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others
      - `CouponsValue` number
      - `CouponCount` integer
      - `UsedCoupons` integer
      - `ReferralObjectiveId` integer, nullable
    - `Tiers` object[]
      - `Id` integer
      - `Name` string
      - `Color` string
      - `IconUrl` string
      - `IsActive` boolean
      - `IsBase` boolean
      - `Order` integer
      - `CustomerCount` integer
      - `Identifier` string
      - `Caption` string
    - `AvailableCashback` number, nullable
    - `TiersCountInformation` string, nullable
    - `CashbackPercentage` number, nullable
    - `WebTitle` string, nullable
    - `IsCashbackInformativeOnly` boolean
    - `CashbackInformativeText` string, nullable
    - `CashbackRules` string, nullable
    - `CashbackBalance` number, nullable
    - `PointBalance` integer, nullable
    - `CashbackPointValue` number, nullable
    - `CashbackAmount` number, nullable
    - `MaxCashbackForCurrentPurchase` number, nullable
    - `Enabled` boolean
    - `DisabledReason` string, nullable
    - `NoPointCost` boolean
    - `RequiredToAddMoreText` string, nullable
    - `ShouldUseCustomInstruction` boolean
    - `ShouldExpireCouponsWhenNotAvailableInPlatform` boolean
    - `RewardChannel` 0 | 1 — 0 = Online 1 = Offline
    - `ProductCollections` string[], nullable
    - `WidgetIconActive` boolean
    - `WidgetIcon` string, nullable
    - `LandingPageIconActive` boolean
    - `LandingPageIcon` string, nullable
    - `ValidOnlyProductCollections` string[], nullable
    - `AllowProductCollection` boolean
    - `ProductCollectionSelection` 0 | 1 — 0 = DenyCollections 1 = AllowCollections
    - `HasProductCollection` boolean
    - `EnableVtexCashbackCollectionSalesChannelRestriction` boolean
    - `VtexCashbackCollectionSalesChannelPairs` string[], nullable
    - `VtexCashbackCollectionSalesChannelSelection` 0 | 1 — 0 = DenyCollections 1 = AllowCollections
    - `HasVtexCashbackCollectionSalesChannelRestriction` boolean
    - `Rules` ApiRewardConfigurationRules
      - `RewardDescription` string, nullable
      - `NonCumulativePromotion` string, nullable
      - `MaximumPurchaseCashback` string, nullable
      - `MinimalPurchaseRequirement` string, nullable
      - `CouponValidityDays` string, nullable
      - `CouponEmailConfirmation` string, nullable
  - `TotalItemCount` integer
  - `PageSize` integer
  - `PageNumber` integer
  - `HasNextPage` boolean

---

[API](https://skmtc.net/bonifiq/apis/bonifiq-private-apis.md) · [All operations](https://skmtc.net/bonifiq/apis/bonifiq-private-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bonifiq/bonifiq-private-apis/revisions/070a57eeffdc/schema)