Reward types
Paylead generates four types of Rewards. Treat them identically on the Consumer screen: they all credit the bank account the same way.The Reward status flow
Every Reward carries two parallel status tracks: a technical status your back-office uses for accounting and Ventilation, and a Consumer-facing status to surface in the bank app. Show the Consumer status in the UI; reconcile on the technical status.- Consumer status
- Technical status
What the Consumer sees in your app (five values).
| Status | What it means | Display tip |
|---|---|---|
Pending | Reward earned, not yet confirmed. | ”Earning: confirms within 30 days”. |
Validated | Reward confirmed; payout guaranteed. | ”Confirmed”. |
Pool | Reward sitting in the Consumer’s pool, awaiting payout. | ”Confirmed: paid out next month”. |
Paid | Reward credited to the Consumer’s bank account. | Show the credit date and amount. |
Cancelled | Underlying transaction refunded, disputed, or voided. | Show with reason, archive after 30 days. |
As soon as a Reward is visible to the Consumer (
Pending), display it. Don’t wait for validation: the early signal is what drives engagement. The two tracks are decoupled: the Consumer status follows UX moments, not the exact accounting state.List rewards
Return every Reward generated for a specific Consumer.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.
links.detail URL for the full payload.
Get reward details
Fetch the full payload for a single Reward. Show it on the detail screen with the estimated payout date, the originating transaction, and the source Offer.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.
Need real-time status updates instead of polling? Subscribe to the
reward.* events on the Webhooks reference. Paylead pushes a notification on every status transition so you can drive in-app notifications, CRM updates, and accounting reconciliation without batch jobs.Reward attribution
A single Consumer purchase can land in Paylead from multiple sources at the same time: the bank’s own feed, an account aggregator. Without arbitration, the merchant could be billed twice and the Consumer rewarded twice. Reward attribution prevents that: it runs automatically on every eligible transaction, in two stages.Duplication engine
The duplication engine inspects incoming transactions against a battery of signals (IBAN, issuing bank, amount, executed-at timestamp, Brand identifier, and sequence proximity) to detect when several records describe the same underlying purchase.When two or more transactions resolve to the same purchase, only one is allowed to generate a Reward. The others are flagged as duplicates and excluded.
When no Reward is attributed
Not every eligible transaction generates a Reward. Common reasons:
- The Offer’s budget cap was reached before the transaction settled.
- The transaction was cancelled or refunded before validation.
- A duplicate was processed and the current record lost the attribution round.
reward_created Webhook fires. Use Consumer detail on Shift if a Consumer disputes a missing Cashback.FAQ
How long does a Reward stay in `Pending` before validation?
How long does a Reward stay in `Pending` before validation?
Up to 30 days, matching the refund window of most card networks. The exact validation date is exposed as
executed_at plus the brand’s validation delay.What happens to a Reward when the underlying transaction is refunded?
What happens to a Reward when the underlying transaction is refunded?
If the refund occurs before validation, the Reward transitions to
CANCELLED automatically. Once a Reward reaches VALIDATED, it can no longer be cancelled or modified: a later refund is not clawed back. For disputes, use the form on Shift; there is no public dispute API endpoint.Can a single transaction generate multiple Rewards?
Can a single transaction generate multiple Rewards?
No. Paylead’s Reward attribution mechanism guarantees exactly one Reward per qualifying purchase, even when the same transaction is reported by multiple sources (bank feed plus aggregator).
What’s next
Pool & payout
How a validated Reward reaches the Consumer’s pool and gets paid out.
Webhooks reference
React to Reward lifecycle events in real time.
Loyalty journey
The loyalty wallet Consumers build alongside their Rewards.