> ## Documentation Index > Fetch the complete documentation index at: https://developers.bonifiq.com.br/llms.txt > Use this file to discover all available pages before exploring further. # on a Given ID, returns the Rewards configuration if found. ## OpenAPI ````yaml https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/RewardConfigurations/{id} openapi: 3.0.0 info: title: BonifiQ Private APIs description: >- # Introduction This is the BonifiQ Private APIs documentation. With these endpoints you can interact with BonifiQ systems and enhance your program points. # Limitations These endpoints are intended to be used in backend communication so they are not CORS-compatible and cannot be used by in-browser frontend libraries (such as React, Angular, Vue, jQuery, etc) If are required to call BonifiQ API from a browser, please refer to our [Public APIs](https://api.bonifiq.com.br/apidocs/public) # Authentication These Private APis use the [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) scheme. You need both an API Token (Username) and API Key (Password) to use with it You can generate this key pair in BonifiQ admin panel, at the "API Keys" menu. # How to use this page ## Making calls You can simulate, test and make calls to API from this Swagger page. To do that: - Click on the **Authorize** button - Inform the Username (API Token) and Passwoird (API Key) and click on **Authorize** - From the list bellow, choose an API call and click on **Try it out** - Inform the required parameters (if any) and click on **Execute** ## Verifying requests and responses bodies In every API Call there is an explanation of what each field means, theirs types and accepted values for all Requests and Responses. To view this information, just go to any API Call bellow and in the Responses section, click on the Schema. version: 1.0.0 servers: - url: https://api.bonifiq.com.br security: [] tags: - name: POS description: >- Flow methods to integrate BonifiQ with a POS system. Check the Flow Documentation link on the right externalDocs: description: Flow Documentation url: >- https://suporte.bonifiq.com.br/support/solutions/articles/159000319538-integrar-com-pdv - name: Checkout description: Operations related to checkout cashback redeem, refresh and removal - name: Customization description: Retrieve customizations for the loyalty program - name: Rewards description: Interact with rewards already redeemed paths: /v1/pvt/RewardConfigurations/{id}: get: tags: - RewardConfigurations summary: on a Given ID, returns the Rewards configuration if found. operationId: RewardConfigurations_GetConfig parameters: - name: id in: path required: true schema: type: integer format: int32 x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/BaseExternalApiResponseOfApiRewardConfiguration security: - Basic Authentication: [] components: schemas: BaseExternalApiResponseOfApiRewardConfiguration: type: object description: Standard response envelope used by the External API. additionalProperties: false properties: ErrorMessage: type: string description: >- Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect `Result`, `Code` and `Severity` first. nullable: true ErrorCode: type: integer description: >- Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use `ApiResponseErrorDescription`. format: int32 nullable: true Result: description: Business payload returned by the endpoint. nullable: true oneOf: - $ref: '#/components/schemas/ApiRewardConfiguration' Code: type: string description: >- 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. nullable: true CodeName: type: string description: >- Symbolic enum name associated with `Code`, such as `CheckoutNotFound`. nullable: true Severity: description: >- Final severity of the response. `Success` means the action completed as expected, `Warning` means the request was valid but the business outcome is informational or non-ideal, and `Error` means the request should be treated as a failure. oneOf: - $ref: '#/components/schemas/ExternalApiResponseSeverity' HasWarning: type: boolean description: >- 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: type: boolean description: >- 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`. ApiRewardConfiguration: allOf: - $ref: '#/components/schemas/BaseApiEntity' - type: object additionalProperties: false properties: Points: type: integer format: int32 RewardType: $ref: '#/components/schemas/RewardType' IsActive: type: boolean Value: type: number format: decimal PreTitle: type: string nullable: true Title: type: string nullable: true Description: type: string nullable: true LongDescription: type: string nullable: true HasValidDate: type: boolean ValidDateStart: type: string format: date-time nullable: true ValidDateEnd: type: string format: date-time nullable: true HasSameCustomerUsageLimit: type: boolean SameCustomerUsageLimit: type: integer format: int32 HasGlobalUsageLimit: type: boolean GlobalUsageLimit: type: integer format: int32 CustomTitle: type: string nullable: true UsageInstructions: type: string nullable: true CustomIconUrl: type: string nullable: true SendClientRedeemNotification: type: boolean ClientEmailsNotification: type: array xml: wrapped: true items: type: string xml: name: string SendCustomerRedeemNotification: type: boolean CustomerEmailConfigurationId: type: integer format: int32 nullable: true CustomerEmailConfiguration: nullable: true oneOf: - $ref: '#/components/schemas/ApiCustomerEmailConfiguration' CodePrefix: type: string nullable: true CouponCodeLength: type: integer format: int32 nullable: true CumulativeDiscount: type: boolean MinimalValue: type: number format: decimal nullable: true ValidDays: type: integer format: int32 nullable: true CashbackMaxPurchaseValue: type: number format: decimal nullable: true MinimumPercentPurchase: type: number format: double nullable: true ManualCouponGeneration: type: boolean PreGeneratedCouponLists: type: array nullable: true xml: wrapped: true items: xml: name: ApiPreGeneratedCouponList oneOf: - $ref: '#/components/schemas/ApiPreGeneratedCouponList' Tiers: type: array xml: wrapped: true items: xml: name: ApiTier oneOf: - $ref: '#/components/schemas/ApiTier' AvailableCashback: type: number format: decimal nullable: true TiersCountInformation: type: string nullable: true CashbackPercentage: type: number format: decimal nullable: true WebTitle: type: string nullable: true IsCashbackInformativeOnly: type: boolean CashbackInformativeText: type: string nullable: true CashbackRules: type: string nullable: true CashbackBalance: type: number format: decimal nullable: true PointBalance: type: integer format: int32 nullable: true CashbackPointValue: type: number format: decimal nullable: true CashbackAmount: type: number format: decimal nullable: true MaxCashbackForCurrentPurchase: type: number format: decimal nullable: true Enabled: type: boolean DisabledReason: type: string nullable: true NoPointCost: type: boolean RequiredToAddMoreText: type: string nullable: true ShouldUseCustomInstruction: type: boolean ShouldExpireCouponsWhenNotAvailableInPlatform: type: boolean RewardChannel: nullable: true oneOf: - $ref: '#/components/schemas/RewardChannel' ProductCollections: type: array nullable: true xml: wrapped: true items: type: string xml: name: string WidgetIconActive: type: boolean WidgetIcon: type: string nullable: true LandingPageIconActive: type: boolean LandingPageIcon: type: string nullable: true ValidOnlyProductCollections: type: array nullable: true xml: wrapped: true items: type: string xml: name: string AllowProductCollection: type: boolean ProductCollectionSelection: $ref: '#/components/schemas/ProductCollectionSelection' HasProductCollection: type: boolean Rules: nullable: true oneOf: - $ref: '#/components/schemas/ApiRewardConfigurationRules' ExternalApiResponseSeverity: type: integer description: |- 0 = Success 1 = Warning 2 = Error x-enumNames: - Success - Warning - Error enum: - 0 - 1 - 2 BaseApiEntity: type: object x-abstract: true additionalProperties: false properties: Id: type: integer format: int32 RewardType: type: integer description: |- 0 = PercentDiscountCoupon 1 = ValueDiscountCoupon 2 = FreightDiscountCoupon 3 = PointToCashback 4 = Customized x-enumNames: - PercentDiscountCoupon - ValueDiscountCoupon - FreightDiscountCoupon - PointToCashback - Customized enum: - 0 - 1 - 2 - 3 - 4 ApiCustomerEmailConfiguration: allOf: - $ref: '#/components/schemas/BaseApiEntity' - type: object additionalProperties: false properties: EmailBody: type: string Subject: type: string IsActive: type: boolean Type: $ref: '#/components/schemas/CustomerCommunicationType' Variables: type: array nullable: true xml: wrapped: true items: xml: name: EmailConfigurationVariable oneOf: - $ref: '#/components/schemas/EmailConfigurationVariable' Title: type: string nullable: true Description: type: string nullable: true Group: $ref: '#/components/schemas/CustomerEmailGroup' SubType: type: integer format: int32 nullable: true HideLogoIsActive: type: boolean ChangeBackgroundColorIsActive: type: boolean ProductsRecommendationIsActive: type: boolean EmailBackgroundColor: type: string nullable: true ObjectiveLinkedType: nullable: true oneOf: - $ref: '#/components/schemas/ObjectiveType' PreHeader: type: string nullable: true ApiPreGeneratedCouponList: allOf: - $ref: '#/components/schemas/BaseApiEntity' - type: object additionalProperties: false properties: ListName: type: string ValidDateStart: type: string format: date-time nullable: true ValidDateEnd: type: string format: date-time nullable: true PreGeneratedCoupons: type: array nullable: true xml: wrapped: true items: xml: name: ApiPreGeneratedCoupon oneOf: - $ref: '#/components/schemas/ApiPreGeneratedCoupon' IsInternalList: type: boolean CouponsType: nullable: true oneOf: - $ref: '#/components/schemas/CouponType' CouponsValue: type: number format: decimal CouponCount: type: integer format: int32 UsedCoupons: type: integer format: int32 ReferralObjectiveId: type: integer format: int32 nullable: true ApiTier: allOf: - $ref: '#/components/schemas/BaseApiEntity' - type: object additionalProperties: false properties: Name: type: string Color: type: string IconUrl: type: string IsActive: type: boolean IsBase: type: boolean Order: type: integer format: int32 CustomerCount: type: integer format: int32 Identifier: type: string Caption: type: string RewardChannel: type: integer description: |- 0 = Online 1 = Offline x-enumNames: - Online - Offline enum: - 0 - 1 ProductCollectionSelection: type: integer description: |- 0 = DenyCollections 1 = AllowCollections x-enumNames: - DenyCollections - AllowCollections enum: - 0 - 1 ApiRewardConfigurationRules: type: object additionalProperties: false properties: RewardDescription: type: string nullable: true NonCumulativePromotion: type: string nullable: true MaximumPurchaseCashback: type: string nullable: true MinimalPurchaseRequirement: type: string nullable: true CouponValidityDays: type: string nullable: true CouponEmailConfirmation: type: string nullable: true CustomerCommunicationType: type: integer description: |- 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 x-enumNames: - EarnPurchasePoints - EarnBirthdayPoints - EarnSignupPoints - RedeemPoints - EarnReviewPoints - NotifyExpirablePoints - PointsToUse - CouponsToUse - ReferralCommunicationPoints - RewardCustomRedeemNotification - CustomerPointChangeNotification - CustomerTierUpgradeNotification - CustomerTierDowngradeNotification - SentOTPToCustomer - EarnSocialMediaFollowFacebook - EarnSocialMediaFollowInstagram - EarnQuizPoints - EarnCustomObjectivePoints - InactiveAffiliate - InactiveAffiliateProjectAffiliate - EarnSocialMediaFollowLinkedin - EarnSocialMediaFollowTikTok - ReactivationCampaignStart - ReactivationCampaignEnd - Participation enum: - 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 EmailConfigurationVariable: type: object additionalProperties: false properties: Name: type: string Value: type: string Description: type: string CustomerEmailGroup: type: integer description: |- 0 = Earnpoints 1 = Others x-enumNames: - Earnpoints - Others enum: - 0 - 1 ObjectiveType: type: integer description: |- 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 x-enumNames: - Purchase - Signup - Birthday - Review - Referral - SocialMediaFollowInstagram - SocialMediaFollowFacebook - Quiz - Custom - SocialMediaFollowLinkedin - SocialMediaFollowTikTok - Participation - Fitness enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 ApiPreGeneratedCoupon: allOf: - $ref: '#/components/schemas/BaseOriginalIdApiEntity' - type: object description: >- A Pre Generated Coupon is a coupon that exists at ecommerce but is not used yet by any customer When a customer wants to redeem points for a coupon, BonifiQ choose an available PreGenerate Coupon for these specific customer additionalProperties: false properties: CouponCode: type: string CreatedDate: type: string format: date-time IsAssigned: type: boolean CouponType: $ref: '#/components/schemas/CouponType' CouponValue: type: number format: decimal ValidDateStart: type: string format: date-time nullable: true ValidDateEnd: type: string format: date-time nullable: true CouponId: type: integer format: int32 nullable: true PreGeneratedCouponListId: type: integer format: int32 CouponType: type: integer description: |- 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others x-enumNames: - FixedValue - Percent - FreeShipping - DiscountShipping - Others enum: - 0 - 1 - 2 - 3 - 4 BaseOriginalIdApiEntity: allOf: - $ref: '#/components/schemas/BaseApiEntity' - type: object description: >- This class represents a request with an external Id (such as OrderId) in a third-party system x-abstract: true additionalProperties: false properties: OriginalId: type: string description: 'This is the Id in the third party system. ' securitySchemes: Basic Authentication: type: http description: Use API Basic Auth Keys name: Basic Authentication in: header scheme: basic ````