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
}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
}Use API Basic Auth Keys
Reward Redeem Request model
ID of the customer requesting the reward redeem. its the ID from the client store.
Show child attributes
0 = PercentDiscountCoupon 1 = ValueDiscountCoupon 2 = FreightDiscountCoupon 3 = PointToCashback 4 = Customized
0, 1, 2, 3, 4 Show child attributes
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
0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22 0 = Earnpoints 1 = Others
0, 1 0 = Purchase 1 = Signup 2 = Birthday 3 = Review 4 = Referral 5 = SocialMediaFollowInstagram 6 = SocialMediaFollowFacebook 7 = Quiz 8 = Custom 9 = SocialMediaFollowLinkedin 10 = SocialMediaFollowTikTok
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Show child attributes
Show child attributes
This is the Id in the third party system.
0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others
0, 1, 2, 3, 4 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others
0, 1, 2, 3, 4 Show child attributes
0 = Online 1 = Offline
0, 1 0 = DenyCollections 1 = AllowCollections
0, 1 Show child attributes
Was this page helpful?