From Campaign to Offer
An Offer is never created in a vacuum. It is the published outcome of a Paylead proposal for a partner merchant that the Program Manager has reviewed and accepted.Paylead proposes a Campaign
Paylead submits a Campaign: a raw, unpublished commercial proposal carrying its conditions: eligible Brand, duration, playground range, channel, and targeting rules.
The Program Manager reviews it in Shift
The Program Manager reviews each Campaign in Shift and either publishes it as an Offer or rejects it. This is where the Program Manager sets how the playground is split between its own commission and the Cashback returned to the Consumer.
A Campaign is Paylead’s draft proposal; an Offer is the curated, published promotion the Consumer sees. Only the Program Manager turns one into the other.
How an Offer funds the Program
Offers are not a cost: they are the revenue mechanism. When a Consumer transaction matches an active Offer (a Commissioned Transaction):- Paylead returns a playground to your Program for that transaction.
- The playground splits (per Offer, as the Program Manager decided at publication) between the Program Manager’s commission and the Consumer’s Cashback.
Offer types and states
An Offer’stype sets how the Consumer earns; its state reflects where the Offer is in its life.
| Type | What it is |
|---|---|
| Cashback | Rewards a share of each qualifying purchase, credited to the Consumer’s pool. |
| Voucher | A Voucher bought up front, below face value or with the discount credited back. |
| Loyalty Offer | Rewards only after a defined number of qualifying purchases. |
| State | What it means |
|---|---|
| Boosted | The Offer carries two rates, a baseline and a higher current rate while a boost is active. The contrast drives conversion. |
| Consumed | The Offer’s per-Consumer Cashback cap has been reached. Keep it visible in a dimmed “already claimed” state rather than hiding it. |
What an Offer carries
Every Offer defines the terms a transaction must satisfy to be rewarded:- Eligible Brand: where the purchase must happen.
- A rate: the share of the playground returned to the Consumer.
- Validity period: the window during which the Offer is active.
- Channel: the transactional channel through which the purchase is rewarded: online, in-store, or both.
- Specific conditions: minimum and maximum amounts, capping, targeting.
CASHBACK Offers, the voucher fields to VOUCHER Offers).
Identity and display
| Field | Description |
|---|---|
id | Unique identifier of the Offer (UUID). |
name | Display name shown to the Consumer. |
reference | Human-readable reference built from the Brand name, creation date, and an increment (for example MYBRAND-20180220-001). |
description | Consumer-facing description of the Offer. |
picture | Offer illustration. |
highlight_level | Editorial prominence for contextual displays such as banners or carousels: HIGHEST, HIGH, or NORMAL. |
is_favorite | Whether the Consumer has liked the Offer. |
| Field | Description |
|---|---|
type | Offer mechanism: CASHBACK, LBS_CASHBACK, VOUCHER, UNIQUE_COUPON, or GENERIC_COUPON. |
status | ACTIVE (available now), PUBLISHED (visible but not yet active, for teasing), or COMPLETED (budget spent or all coupons burnt). |
publication_date | When the Offer becomes visible. Can precede the start date for teasing. |
start_date | First date a transaction can qualify (inclusive). |
end_date | Last date a transaction can qualify (inclusive). |
CASHBACK Offers)
| Field | Description |
|---|---|
cashback_rate | Current effective rate used to compute the Cashback amount (0 to 100). |
default_cashback_rate | Baseline rate, shown alongside cashback_rate when a boost is active. |
is_boosted | Whether a boost is currently active (current rate above baseline). |
| Field | Description |
|---|---|
application_channel | Where the Offer applies: ONLINE, OFFLINE, or BOTH. |
application_url | URL to reach the Offer when the channel is ONLINE or BOTH. |
min_amount | Minimum transaction amount required to generate a Reward. |
max_amount | Maximum transaction amount counted: the maximum Reward is max_amount × cashback_rate. |
max_limit_transaction_amount | Hard ceiling. A transaction above this amount generates no Reward at all. |
source_transaction | When true, only transactions from the Program’s default bank qualify. |
segments | The Segments the Offer is scoped to. |
| Field | Description |
|---|---|
max_cashbacks_per_consumer | Maximum number of Rewards a single Consumer can earn on the Offer (null means unlimited). |
capping_period | Reset window for the cap: NO_RESET, WEEKLY, MONTHLY, QUARTERLY, or BIANNUAL. |
frequency | Number of qualifying purchases before a Reward is granted (loyalty Offers). |
frequency_counter | Qualifying purchases the Consumer has made so far toward frequency. |
is_consumed | Whether the Consumer has reached the Offer’s per-Consumer cap. |
| Field | Description |
|---|---|
legal_terms | Legal terms attached to the Offer. Mandatory to display. |
VOUCHER Offers)
| Field | Description |
|---|---|
min_value / max_value | Range of face values the Consumer can buy. |
max_discount_rate | Best price-to-value ratio across the Offer’s vouchers. |
value | Nominal face value of a purchased voucher. |
price | Amount the Consumer paid for the voucher. |
codes | Redeemable codes, each with an optional activation_code (PIN), value, and validity_date. |
status | Voucher state: RESERVED, CONFIRMED, READY, CANCELLED, REFUNDING, REFUNDED, or REFUND_REJECTED. |
reservation_date / reservation_expired_date | When the voucher was reserved, and when an unconfirmed reservation auto-cancels. |
Fetch the catalog
The Paylead API exposes three entry points. Pick the one that matches your UI.- Group by Brand
- List all offers
- Get Offer details
Return one entry per Brand the Consumer is eligible for, with aggregated Offer statistics. Use this for the catalog index screen.Each entry returns the Brand identity, the maximum Cashback rate available, and flags such as
Code examples coming soon. The Paylead API (v2) is still under construction. Request and response examples for this section will be published once the contract is finalized. In the meantime, contact your Paylead account manager for early-access details.
is_boosted and is_consumed.Personalization: Offer Smart Ranking
Consumers do not see the catalog in a fixed order. Offer Smart Ranking personalizes the order of Offers per Consumer, using purchase habits, location, Brand power, and editorial spotlight. It improves catalog relevance and conversion, and requires the Consumer’s explicit consent to perform best.Display and filter behaviors
Three behaviors shape how you render and filter the catalog. The underlying fields are listed in What an Offer carries.- Boosted Offers: show both
default_cashback_rate(baseline) andcashback_rate(current) so the contrast is visible. Filter withis_boosted=trueto surface only active boosts. - Loyalty Offers: filter with
loyalty_frequency__isnull=false, then show progress withfrequency_counteragainstfrequency. - Consumed Offers: flagged
is_consumed=trueonce the per-Consumer cap is reached. Don’t hide them. Display a dimmed “Already claimed” state, and useis_consumed=falseonly on dedicated “available now” screens.
Code examples coming soon. The Paylead API (v2) is still under construction. Request and response examples for this section will be published once the contract is finalized. In the meantime, contact your Paylead account manager for early-access details.
What’s next
Reward lifecycle
Track Rewards generated when Consumers transact on an Offer.
Use an offer
How a Consumer redeems an Offer to earn a Reward.
Promote your program
Surface public Offers to prospects who are not Consumers yet.