Skip to main content
Version: 3.x

TRReward

The reward object the SDK returns when a user earns a reward. Your reward callback receives a list of them. The iOS and Android SDKs use slightly different names and types for some properties, shown below.

Properties​

PropertyiOSAndroidDescription
Transaction identifiertransactionIdentifier (String?)transactionIdentifier (String?)Unique identifier for the transaction. Use it to deduplicate rewards in your app or in your server-to-server postback handling.
Placement tagplacementTag (String?)placementTag (String?)The placement tag where the reward was earned.
Placement identifierplacementIdentifier (String?)placementIdentifier (String?)The placement identifier where the reward was earned.
Currency namecurrencyName (String?)currencyName (String?)Name of the rewarded currency. Note: This is the Currency name set in the Publisher Dashboard, not the Display name.
Reward amountrewardAmount (Int)rewardAmount (Float?)Amount of currency rewarded (in your app's currency).
Payout eventpayoutEvent (String?)payoutEventType (String?)Type of payout event — see Payout event values.

In Java, use the getters (getRewardAmount(), getPayoutEventType(), and so on).

Payout event values​

EventiOS payoutEventAndroid payoutEventType
User completed the profiling flowprofile_rewardPROFILE_REWARD
User started a survey but was disqualifiedpartial_payoutPARTIAL_PAYOUT
User successfully completed a surveyfull_payoutFULL_PAYOUT
Quick Questions payoutquick_questions_payoutQUICK_QUESTIONS_PAYOUT