---
title: "on a Given ID, returns the Rewards configuration if found."
method: GET
path: "/v1/pvt/RewardConfigurations/{id}"
tags: ["RewardConfigurations"]
---

# on a Given ID, returns the Rewards configuration if found.

`GET /v1/pvt/RewardConfigurations/{id}`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/RewardConfigurations/{id}`
- Auth: HTTP basic

## Path parameters

- `id` integer, required

## Response `200`

- BaseExternalApiResponseOfApiRewardConfiguration: Standard response envelope used by the External API.
  - `ErrorMessage` string, nullable: Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect `Result`, `Code` and `Severity` first.
  - `ErrorCode` integer, nullable: Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use `ApiResponseErrorDescription`.
  - `Result` ApiRewardConfiguration
    - `Id` integer
    - `Points` integer
    - `RewardType` 0 | 1 | 2 | 3 | 4 | 5: 0 = PercentDiscountCoupon 1 = ValueDiscountCoupon 2 = FreightDiscountCoupon 3 = PointToCashback 4 = Customized 5 = ProductDiscount
    - `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
    - `CashbackName` string, 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
    - `ProductDiscount` ApiRewardConfigurationProduct
      - `Id` integer
      - `RewardConfigurationId` integer
      - `ProductId` integer, nullable
      - `OnlineExternalProductId` string, nullable
      - `OfflineExternalProductId` string, nullable
      - `DisplayName` string, nullable
      - `IsActive` boolean
      - `DiscountMode` 0 | 1 | 2 | 3: 0 = PercentDiscount 1 = FixedFinalPrice 2 = FreeGift 3 = FixedDiscountAmount
      - `DiscountValue` number
      - `MaxUnitsPerRedeem` integer, nullable
      - `OnlineUsageLimit` integer, nullable
      - `OfflineUsageLimit` integer, nullable
  - `Code` string, nullable: Endpoint-specific business code formatted as a two-digit string, such as `03` or `07`. This field is available for success, warning and error outcomes.
  - `CodeName` string, nullable: Symbolic enum name associated with `Code`, such as `CheckoutNotFound`.
  - `Severity` 0 | 1 | 2: 0 = Success 1 = Warning 2 = Error
  - `HasWarning` boolean: Convenience flag that is `true` when `Severity` is `Warning`. Warnings are valid `200 OK` business outcomes and should not be handled as transport or validation errors.
  - `HasError` boolean: Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as `false`.

## Changes

- **2026-10-21** `0c4b2427903c`: 1 warning, 1 info
  - added the new `5.00` enum value to the `Result/oneOf[#/components/schemas/ApiRewardConfiguration]/allOf[subschema #2]/RewardType` response property for the response status `200`
  - added the optional property `Result/oneOf[#/components/schemas/ApiRewardConfiguration]/allOf[subschema #2]/ProductDiscount` to the response with the `200` status
- **2026-09-12** `0492a8200489`: 1 info
  - added the optional property `Result/oneOf[#/components/schemas/ApiRewardConfiguration]/allOf[subschema #2]/CashbackName` to the response with the `200` status
- **2026-08-14** `070a57eeffdc`: 2 info
  - added the optional property `Result/oneOf[#/components/schemas/ApiRewardConfiguration]/allOf[subschema #2]/CustomerEmailConfiguration/oneOf[#/components/schemas/ApiCustomerEmailConfiguration]/allOf[subschema #2]/CustomCss` to the response with the `200` status
  - added the optional property `Result/oneOf[#/components/schemas/ApiRewardConfiguration]/allOf[subschema #2]/CustomerEmailConfiguration/oneOf[#/components/schemas/ApiCustomerEmailConfiguration]/allOf[subschema #2]/CustomCssIsActive` to the response with the `200` status
- …earlier changes not shown

[Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/RewardConfigurations/:id/get.md)

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)