Redeem Rewards

This API call allows you to redeem or cash out the rewards for a particular user, allowing batch processing of rewards or to process by gross amount of rewards

---

 

This is the API call that you shall employ to credit balances into an influencer’s wallet or in-app credit pool. It is very well understood that a user can earn multiple rewards thanks to the fact that he can share the app to a big set of his acquaintances. For every conversion he would be eligible for a reward.

If you’d have some custom algorithm to initiate the transfer of rewards to the user’s account, just make this API call immediately after the algorithm finishes from your side.

NOTE
Rewards redemption can be achieved in 3 ways:

---

Input i.e. Request

{
"apikey":"7b808b1f969048db8463a4c60091c49b",
"privatekey":"09726325ed71465191eda4ec006d601b",
"userKey":"",
"Emailid":"suryare1@gmail.com",
"UserIdInstore": "",
"poolId":"",
"rewarddtlids":[],
"amount":"20",
"campaignId":"2376",
"growthHack":"Word_of_Mouth"
}

Below sample inputs would be guides to how you can redeem rewards for a user, in all three methods mentioned above.
Note that the below methods are listed in decreasing order of preference, as treated by the AppVirality preference.

conditional – One of the conditional parameters is mandatory to identify the user. Priority for user identification is userkey, UserIdInstore and EmailId

BY REWARD DETAIL IDS

You may redeem a large set of Rewards for a user, in the below mentioned manner.
This is applicable for the Wallet or InStore Credits scenario of coupon distribution.

{
"apikey":"50524c1812904217a638a41d00cfbe94",
"privatekey":"5392d14323884ea3aeb3a4d200b4238d",
"userKey":"176502556c624614b913a62400ab4d7e",
"EmailId": "",
"UserIdInstore": "",
// Declared Reward detail IDs would be redeemed for the User mentioned
"rewarddtlids":[
              "1110",
              "375",
              "668"
          ]
}

BY AMOUNT

This will redeem the stated amount of credits to the user mentioned, in his Wallet or InStore Credit.
As you may understand this would not work when the coupon distribution is set up for Coupons.

{
"apikey":"50524c1812904217a638a41d00cfbe94",
"privatekey":"5392d14323884ea3aeb3a4d200b4238d",
"userKey":"176502556c624614b913a62400ab4d7e",
"EmailId": "",
"UserIdInstore": "",
// declared amount would be updated to the Wallet of the user
"amount":"200",
"growthhack":"Word_of_Mouth",
"campaignID":"160"
}

Importance of ‘GrowthHack’ & ‘CampaignID’

GrowthHack notifies the system to redeem the credits of the user towards the mentioned GrowthHack type, i.e. Loyalty_Program or Referral (Word_of_Mouth in SDK terminology). In case you have missed adding the same, the credits would still be redeemed regardless of whatever growth hack it might be.

Similar to above, mentioning the CampaignID enables the system to lodge the earnings against a particular campaign. Failing to do this will simply redeem the rewards irrespective of campaign.

 

BY COUPON POOL

This method would disburse one unit of a coupon from a Coupon Pool, as declared in your input – to the user. This is applicable to only those campaigns wherein, the Coupon Distribution method is set to ‘User will choose‘

This would require you to send across the Pool ID from which the coupon is to be picked.

{
"apikey":"50524c1812904217a638a41d00cfbe94",
"privatekey":"5392d14323884ea3aeb3a4d200b4238d",
"userKey":"176502556c624614b913a62400ab4d7e",
"EmailId": "",
"UserIdInstore": "",
"poolId":"531"         // One Coupon shall be delivered to user from said Coupon Pool
}

---

Response

{
"success":true,
 "statuscode": 1,
  "message": success
}

Status codes which you will see while using Redeem Rewards API