Skip to main content
A Consumer is the anchor of your Program. Every Reward, Offer eligibility check, and Webhook references one. This guide follows the lifecycle described in the User journey: the Consumer is created on the platform, transaction sharing is set up, and the Consumer opts in to one or both services.

​
The Consumer lifecycle

1

Create on the platform

Create the Consumer with their consumer_id, the only required field. Service-agnostic: it registers the end user before any service opt-in.
2

Set up transaction sharing

Share the Consumer’s transaction history (typically the last 12 months), then keep pushing new transactions.
3

Opt in to a service

Enroll the Consumer in Perks, Loyalty, or both. Each opt-in accepts that service’s terms and unlocks it.
4

Add the Smart Ranking consent (Perks, optional)

On Perks, the Consumer can grant the SMART_RANKING consent to enable Offer Smart Ranking.
5

Assign Segments (Perks, optional)

On Perks, the Program Manager can assign one or more Segments to scope which Offers the Consumer sees.
6

Off-board

Deactivate the Consumer when they unsubscribe from all Paylead services.

​
Create a Consumer on the platform

The Consumer ID you pass is the bank’s internal identifier. Paylead reuses it across every downstream call (transactions, Rewards, Webhooks). Once chosen, it cannot be changed without a full off-board and re-onboard. It is also the identifier Paylead displays to represent the Consumer across all business units (support, marketing, technical). Create the Consumer with Onboard a consumer on Paylead platform. Payload essentials
  • id: bank-internal Consumer ID. The only required field. Must be unique and stable across the Consumer’s lifetime.
  • banks: optional. The bank connections and accounts to link. One Consumer can hold several accounts under the same id, and accounts can be added later.
The Consumer exists on the platform and is ready to receive transactions.

​
Set up transaction sharing

Transactions are shared at the platform level and reused by whichever service the Consumer joins. Push the Consumer’s history with Create a bulk of historical transactions, then keep them current with Create a bulk of transactions.
Always call the historical endpoint, even when the Consumer has no history to share. With no past transactions, send an empty payload ({ "banks": [] }) to complete this step.
For how Paylead ingests and matches transactions, see Share transactions.

​
Opt in to Perks

Enroll the Consumer in the Perks service with Enroll a consumer into the perks program. Enrolling accepts the Program’s terms and makes the Consumer eligible to match Offers. Enrollment marks the start of Reward eligibility on the Consumer’s linked bank accounts.
Opting in is per service. A Consumer can be enrolled in Perks, Loyalty, or both. This guide covers the Perks-side operations; the Loyalty opt-in is covered in the User journey.
Offer Smart Ranking personalizes the order of Offers from the Consumer’s transaction data. It requires the Consumer’s explicit SMART_RANKING consent. Manage it through the Perks enrollment call: pass SMART_RANKING in extra_consents to grant it, and in removed_consents to withdraw it.
Capturing consent is the bank’s responsibility. Collect the Consumer’s explicit choice in your own UI before sending it to Paylead. The Paylead call records the result; it does not replace your consent-capture flow under GDPR.

​
Assign Segments (Perks, optional)

Segments let you expose Offers to a defined audience, set by your bank’s own criteria, for example Premium, New, or Gold. A Consumer can belong to several Segments at once. Segmentation is optional and managed by the Program Manager in Shift or through the API.
Segment definitions are provisioned by your Paylead account manager after a compliance check on the criteria. The Program Manager then assigns Consumers to them in Shift or through the API. This keeps targeting rules under business control.

​
Off-board a Consumer

Off-boarding stops Reward generation, revokes the Consumer’s identifier, and locks their record. Use it when the Consumer leaves your Program, closes their bank account, or exercises their right to be forgotten under GDPR. Off-board with Offboard a consumer from Paylead platform.
Off-boarding is irreversible. Rewards already issued are preserved for accounting and Ventilation, but no new Rewards are generated. To re-enroll the Consumer later, use a new id.
The Consumer is off-boarded. Reward generation stops. Existing Rewards in the Ventilation pipeline complete payout normally.

​
What’s next

The Offer catalog

Surface partner Brands and Offers to your onboarded Consumers.

Reward lifecycle

Track the Reward lifecycle and display statuses in your app.

Webhooks reference

Subscribe to Consumer and Reward events for real-time updates.