Set up a Consumer for payout
Before Paylead can pay a Consumer, two pieces of information must be registered for that Consumer.1
Basic KYC
Identity data Paylead forwards to its payment provider to register the Consumer’s payout account. Only
first_name, last_name, email, and address are required. Register it with Create or update a consumer’s KYC.2
Payment account
The bank account where the Consumer wants to be paid out, set through
target_account. Designate it with Designate the bank account where a consumer wants to be paid out. You can also read or revoke it.How Ventilation works
Every pooled Reward feeds the Consumer’s cagnotte. Paylead sums the Reward amounts and triggers the payout against two thresholds, both set by the Program Manager.When a Reward enters the pool
A Reward feeds the cagnotte once it reaches the Consumer-facingPOOLED status. When that happens depends on a Program-level model the Program Manager chooses.
Every
VALIDATED Reward is guaranteed to be paid by Paylead. The Best experience model relies on that guarantee to front the Cashback to the Consumer at validation, instead of waiting for PAID_IN.Triggering the payout
The Program Manager defines two thresholds on the pooled amount:- Manual threshold: once the sum of pooled Reward amounts reaches it, the Consumer can trigger the payout from the app.
- Auto threshold: once the sum reaches it, Paylead pays out the cagnotte automatically.
Program commission settlement
The Program Manager’s commission (its share of the Offer value) is settled separately from the Consumer payout, through a debit note.Under European regulation, Paylead pays an invoice 60 days after it is issued. Example: Rewards validated in March produce a debit note on 1 May; if the Program Manager invoices the same day, Paylead settles around 30 June.
Check a Consumer’s pool
A Program Manager can read a Consumer’s aggregated pool status (pooled amount and Reward counts) with Get a consumer’s aggregated reward information. The path is/consumers/{consumer_id}/rewards/info. It belongs to the Consumers component, so it sits outside the /perks prefix carried by the adjacent per-Consumer endpoints (/perks/consumers/{consumer_id}/rewards, /voucher-orders, /accounts/payment, /pools/me/payouts).
The response carries one field per backend that actually answered. A backend that fails, times out, or has no data for the Consumer is omitted from the payload, so an absent field means “no data”, not zero. Read the amounts under their backend key (perks), never at the root of the response: validation, pooled, paid, and voucher each carry an amount and a count. perks.can_trigger_pooled tells you whether the Consumer can request a payout right now, which is the check to run before offering the action.
Reconciliation and reporting
On a standard Program, the Program Manager does not pull a distribution file: Paylead runs the Consumer-level payout. For accounting and reconciliation, use the Reporting exports via the Paylead API. Programs set up for external Ventilation work the other way round: Paylead computes who is owed what, and the Program pays its own Consumers from a distribution file it downloads in Shift. See Ventilations for that flow.Edge cases
The Consumer leaves the Program before payout
The Consumer leaves the Program before payout
Paylead stops the payout: the account link is no longer authoritative. What
happens to each Reward depends on its status at that moment, see
Rewards in flight at off-boarding.
The transaction is refunded before the Reward is validated
The transaction is refunded before the Reward is validated
Paylead reconciles the refund against the original transaction and cancels the Reward during the refund window, before it reaches
VALIDATED. Refunds that land after validation are handled according to the Program’s terms and conditions.Multiple Rewards on one Consumer
Multiple Rewards on one Consumer
A Consumer’s pool aggregates every pooled Reward. Paylead pays out the accumulated balance.
Currency
Currency
All amounts are denominated in EUR. Paylead does not support multi-currency Programs.
What’s next
Loyalty journey
The loyalty wallet Consumers build alongside their Rewards.
Webhooks
Get notified when a payout succeeds or fails.