MerchantReward
MerchantReward = {
campaignId:string;conditions:RuleConditions;defaultLockupSeconds?:number;expiresAt?:string|null;interactionTypeKey:InteractionTypeKey;maxRewardsPerUser?:number;merchantMaxRewardsPerUser?:number;name:string;pendingRewardExpirationDays?:number;referee?:EstimatedReward;referrer?:EstimatedReward;token?:Address; }
Defined in: types/rpc/merchantInformation.ts:134
A reward offer exposed by a merchant campaign.
Mirrors the backend EstimatedRewardItem one-to-one — a static parity
assertion on the backend keeps its runtime-validated schema in lockstep with
this published contract.
Properties
Section titled “Properties”campaignId
Section titled “campaignId”campaignId:
string
Defined in: types/rpc/merchantInformation.ts:138
Identifier of the campaign rule this reward originates from.
conditions
Section titled “conditions”conditions:
RuleConditions
Defined in: types/rpc/merchantInformation.ts:148
Raw gating rules — inspect to derive start date, minimum purchase, …
defaultLockupSeconds?
Section titled “defaultLockupSeconds?”
optionaldefaultLockupSeconds?:number
Defined in: types/rpc/merchantInformation.ts:150
Seconds a reward stays locked before settlement.
expiresAt?
Section titled “expiresAt?”
optionalexpiresAt?:string|null
Defined in: types/rpc/merchantInformation.ts:158
ISO-8601 campaign end date, or null when open-ended.
interactionTypeKey
Section titled “interactionTypeKey”interactionTypeKey:
InteractionTypeKey
Defined in: types/rpc/merchantInformation.ts:142
Interaction that triggers the reward.
maxRewardsPerUser?
Section titled “maxRewardsPerUser?”
optionalmaxRewardsPerUser?:number
Defined in: types/rpc/merchantInformation.ts:154
Per-user reward cap for this campaign.
merchantMaxRewardsPerUser?
Section titled “merchantMaxRewardsPerUser?”
optionalmerchantMaxRewardsPerUser?:number
Defined in: types/rpc/merchantInformation.ts:156
Merchant-wide per-user reward cap across every campaign.
name:
string
Defined in: types/rpc/merchantInformation.ts:140
Campaign display name.
pendingRewardExpirationDays?
Section titled “pendingRewardExpirationDays?”
optionalpendingRewardExpirationDays?:number
Defined in: types/rpc/merchantInformation.ts:152
Days before a pending reward expires.
referee?
Section titled “referee?”
optionalreferee?:EstimatedReward
Defined in: types/rpc/merchantInformation.ts:146
Reward paid to the referee, when the campaign defines one.
referrer?
Section titled “referrer?”
optionalreferrer?:EstimatedReward
Defined in: types/rpc/merchantInformation.ts:144
Reward paid to the referrer, when the campaign defines one.
token?
Section titled “token?”
optionaltoken?:Address
Defined in: types/rpc/merchantInformation.ts:136
Reward token address; falls back to the merchant token when omitted.