# Paylead ## Docs - [Glossary](https://docs.paylead.fr/glossary.md): Key terms and concepts in the Paylead ecosystem - [Issue an access token](https://docs.paylead.fr/program/api/authz/tokens/issue-an-access-token.md): Exchange API key credentials for a short-lived ES256 JWT access token. Authenticate with HTTP Basic: the username is the API key's `client_id` (a UUID) and the password is its `client_secret`. Send the returned `access_token` as `Authorization: Bearer ` on every subsequent Platform API call. - [Enroll a consumer into the perks program (accept CGU).](https://docs.paylead.fr/program/api/perks/consumers/enroll-a-consumer-into-the-perks-program-accept-cgu.md) - [Create or update a consumer's KYC (Mangopay natural user).](https://docs.paylead.fr/program/api/perks/kyc/create-or-update-a-consumers-kyc-mangopay-natural-user.md) - [List the rewards a consumer has received.](https://docs.paylead.fr/program/api/perks/rewards/list-the-rewards-a-consumer-has-received.md) - [Assign a consumer to a segment.](https://docs.paylead.fr/program/api/perks/segments/assign-a-consumer-to-a-segment.md) - [List the segments a consumer is currently assigned to.](https://docs.paylead.fr/program/api/perks/segments/list-the-segments-a-consumer-is-currently-assigned-to.md) - [Unassign a consumer from a segment.](https://docs.paylead.fr/program/api/perks/segments/unassign-a-consumer-from-a-segment.md) - [Designate the bank account where a consumer wants to be paid out.](https://docs.paylead.fr/program/api/perks/upm/designate-the-bank-account-where-a-consumer-wants-to-be-paid-out.md) - [Read the payment account currently designated for a consumer.](https://docs.paylead.fr/program/api/perks/upm/read-the-payment-account-currently-designated-for-a-consumer.md) - [Revoke the consumer's currently designated payment account.](https://docs.paylead.fr/program/api/perks/upm/revoke-the-consumers-currently-designated-payment-account.md) - [Trigger a payout of the consumer's pool.](https://docs.paylead.fr/program/api/perks/upm/trigger-a-payout-of-the-consumers-pool.md): Pays out the consumer's `PAID_IN` rewards: reserves the funds in the ledger, moves the money on the PSP (working capital to the program's UPM wallet, then a bank wire to the consumer's recipient), and marks the rewards `PAID_OUT`. Returns `202 Accepted`: the payout is initiated synchronously but the… - [List the READY voucher orders a consumer has placed.](https://docs.paylead.fr/program/api/perks/voucher-orders/list-the-ready-voucher-orders-a-consumer-has-placed.md) - [Versions & Download](https://docs.paylead.fr/program/api/releases.md): Browse every published version of the Program API and download the OpenAPI specs. - [Create a bulk of historical transactions](https://docs.paylead.fr/program/api/thub/bulk-transaction/create-a-bulk-of-historical-transactions.md): Inserts multiple historical transactions to consumer `consumer_id` using a bulk. Historical transactions will not be cashbacked. - [Create a bulk of transactions](https://docs.paylead.fr/program/api/thub/bulk-transaction/create-a-bulk-of-transactions.md): Inserts multiple transactions to consumer `consumer_id` using a bulk. - [Offboard a consumer from Paylead platform](https://docs.paylead.fr/program/api/thub/consumers/offboard-a-consumer-from-paylead-platform.md): Delete a consumer by providing it's `consumer_id` - [Onboard a consumer on Paylead platform](https://docs.paylead.fr/program/api/thub/consumers/onboard-a-consumer-on-paylead-platform.md): Create a consumer by providing it's `consumer_id` - [Get a consumer's aggregated reward information](https://docs.paylead.fr/program/api/thub/rewards/get-a-consumers-aggregated-reward-information.md): Aggregates reward information for consumer `consumer_id` by querying the different backends concurrently. Each backend contributes its own field (e.g. `perks`) and is only included when it responds: a backend that fails, times out or has no data for the consumer is omitted from the payload. - [Delete transaction](https://docs.paylead.fr/program/api/thub/transaction/delete-transaction.md): Delete the transaction `transaction_id` on account `account_id` linked to bank connection `bank_connection_id` for consumer `consumer_id`. - [Get the transaction details](https://docs.paylead.fr/program/api/thub/transaction/get-the-transaction-details.md): Returns all the information about transaction `transaction_id` on account `account_id` linked to bank connection `bank_connection_id` for consumer `consumer_id`. - [Update transaction](https://docs.paylead.fr/program/api/thub/transaction/update-transaction.md): Update the `transaction_id` transaction on `account_id` linked to `bank_connection_id` bank connection for consumer `consumer_id`. - [Authentication](https://docs.paylead.fr/program/user-journey/authentication.md): Authenticate Paylead API calls with a JWT bearer token issued from Shift. One token per environment, carrying the scopes it needs. - [Share transactions](https://docs.paylead.fr/program/user-journey/concepts/transaction-lifecycle.md): How the bank shares Consumer transactions with Paylead: the platform-level feed every service builds on. - [Pool & payout](https://docs.paylead.fr/program/user-journey/concepts/ventilation.md): How Paylead fills the Consumer pool, triggers the payout against the Program Manager's thresholds, and settles the Program's commission. - [The WebApp](https://docs.paylead.fr/program/user-journey/concepts/web-app.md): How Paylead delegates part of the Consumer journey, across both Perks and Loyalty, to an embedded webview inside the bank app. - [Webhooks](https://docs.paylead.fr/program/user-journey/concepts/webhooks.md): How Paylead pushes real-time events to your back-office and how to make your endpoint reliable. - [Environments](https://docs.paylead.fr/program/user-journey/environments.md): Paylead exposes two environments: sandbox for integration work and production for live traffic. Each has its own URL, tokens, and data. - [Errors](https://docs.paylead.fr/program/user-journey/errors.md): Paylead application errors carry a problem-details envelope (a machine-readable code, a human title, and field-level errors), while some responses are raised at the edge without it. - [FAQ](https://docs.paylead.fr/program/user-journey/faq.md): Common questions from banks evaluating or onboarding Paylead: pricing, integration, data handling, and operations. - [Consumer lifecycle](https://docs.paylead.fr/program/user-journey/guides/manage-consumers.md): Create a Consumer on the platform, set up transaction sharing, opt them in to Perks or Loyalty, and off-board them. The service-agnostic Consumer lifecycle. - [Promote your program](https://docs.paylead.fr/program/user-journey/guides/promote-program.md): Use public Offers to attract prospects before they enroll. Highlight Brands and promotions on landing pages, marketing emails, and onboarding flows. - [Reward lifecycle](https://docs.paylead.fr/program/user-journey/guides/reward-lifecycle.md): The Reward lifecycle: types, the two status tracks, listing and retrieving Rewards through the Paylead API, and how attribution guarantees one Reward per purchase. - [Use an offer](https://docs.paylead.fr/program/user-journey/guides/use-an-offer.md): The two ways a Consumer uses an Offer: a Cashback Offer rewards automatically from a shared transaction, a Voucher Offer is bought up front through the Paylead API. - [The Offer catalog](https://docs.paylead.fr/program/user-journey/guides/work-with-offers.md): What an Offer is, how it funds your Program, and how to fetch, filter, and display the catalog through the Paylead API. - [Loyalty journey](https://docs.paylead.fr/program/user-journey/loyalty-journey.md): Program × Product Manager: how the Loyalty domain links bank and loyalty accounts for Automatic Earn. - [User journey](https://docs.paylead.fr/program/user-journey/overview.md): Program × Product Manager: how the Paylead integration works end to end. - [Quickstart](https://docs.paylead.fr/program/user-journey/quickstart.md): Make your first Paylead API call in under 15 minutes. Get an API key, pick an environment, and read a live response. - [Rate limits & Caching](https://docs.paylead.fr/program/user-journey/rate-limits.md): Paylead applies rate limits. Back off on 429, and cache safe reads. - [Security](https://docs.paylead.fr/program/user-journey/security.md): How Paylead enforce security mechanisms to ensure safe use of its API. - [Versioning](https://docs.paylead.fr/program/user-journey/versioning.md) - [What is Paylead?](https://docs.paylead.fr/program/user-journey/what-is-paylead.md): Embedded Loyalty platform for financial institutions. - [Authentication](https://docs.paylead.fr/program/webapp/authentication.md): Program × Developer: SSO integration between your bank app and the Paylead WebApp (MFP). - [Mobile Bridge](https://docs.paylead.fr/program/webapp/bridge/overview.md): Program × Developer: how the Paylead WebApp (MFP) calls native iOS/Android capabilities from inside your WebView. - [Versions & download](https://docs.paylead.fr/program/webapp/bridge/releases.md): Browse every published version of the Paylead Mobile Bridge and download its JSON Schema. - [WebView configuration](https://docs.paylead.fr/program/webapp/configuration.md): Program × Developer: WebView setup and opening URL parameters for embedding the Paylead WebApp (MFP). - [Cookies](https://docs.paylead.fr/program/webapp/cookies.md): Program × Developer: cookies set on the Paylead WebApp (MFP) in production. - [WebApp (MFP)](https://docs.paylead.fr/program/webapp/overview.md): Program × Developer: embedding the Paylead WebApp inside a bank mobile app. - [Page URLs](https://docs.paylead.fr/program/webapp/page-urls.md): Program × Developer: the WebApp (MFP) URL of each screen a host app can open directly, with its path parameters and product availability. - [Troubleshooting](https://docs.paylead.fr/program/webapp/troubleshooting.md): Program × Developer: diagnosing common WebApp (MFP) SSO and WebView issues. ## OpenAPI Specs - [connector](https://docs.paylead.fr/program/api/openapi/legacy/1.1.11/connector.json) - [openapi](https://docs.paylead.fr/program/api/openapi/2.0.0/thub/openapi.json) - [2.0.0](https://docs.paylead.fr/program/api/openapi/2.0.0/2.0.0.json) - [m2m](https://docs.paylead.fr/program/api/openapi/legacy/1.1.4/m2m.json) - [injector](https://docs.paylead.fr/program/api/openapi/legacy/1.1.2/injector.json)