A campaign object represents an incentive offered to customers. Ansa supports five types of incentive campaigns:

Drops

A drop directly funds user wallets at a scheduled time. Use the settings.startAt timestamp to control when the drop occurs. The configuration accepts a single integer, representing the amount to 'drop' into each customer’s wallet.

{
  "type": "drop",
  "drop": 200
}

Promo codes

Promo codes allow users to redeem a code for a fixed amount of credit. The configuration object must include a code, the string users will enter to redeem the promotion, and amount, the reward amount.

{
  "type": "promoCode",
  "promoCode": {
    "code": "CHRISTMAS20",
    "amount": 123
  }
}

Reload bonus

A reload bonus rewards users when they add funds to their account. You can define multiple reward tiers and choose one of two bonus modes:

1. oncePerCampaign: a user can receive the bonus only once
2. unlimited: a user can receive the bonus as many times as they meet the criteria

⚠️ If multiple reload bonus campaigns are active, Ansa will apply the campaign that gives the highest reward.

{
  "type": "reloadBonus",
  "reloadBonus": {
    "type": "oncePerCampaign",
    "rewardTiers": [
      {
        "minAmount": 100,
        "promoAmount": 100
      }
    ]
  }
}

{
  "type": "reloadBonus",
  "reloadBonus": {
    "type": "unlimited",
    "rewardTiers": [
      {
        "minAmount": 100,
        "promoAmount": 100
      },
      {
        "minAmount": 200,
        "promoAmount": 500
      }
    ]
  }
}

Cash back

Cash back campaigns give users a percentage of their spending back as a reward. Specify the percentage using the cashback.percentCashback field.

⚠️ If multiple cash back campaigns are active, Ansa will apply the one with the highest reward.

{
  "type": "cashback",
  "cashback": {
    "percentCashback": 12
  }
}

User creation bonus

User creation bonus campaigns give users a fixed reward upon creating a wallet. Specify the amount to grant users using the userCreationBonus.amount field.

⚠️ If there are multiple user creation bonus campaigns active, Ansa will apply the one with the highest reward.

ℹ️ As the User creation bonus campaign is only for newly created customers, User segments do not apply to this type of campaign. At this time, the fixed reward is given to all new users while the campaign is active.

{
  "type": "userCreationBonus",
  "userCreationBonus": {
    "amount": 500
  }
}

Campaign attributes

The type field in your request determines the required {type} key and the corresponding configuration object. Each incentive type has its own format and rules, detailed above.

Campaign settings attributes

Expiration metadata attributes