> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# API Cashback Rules

> Une Cashback Rule reverse aux sous-comptes directs d'une plateforme une part de leurs dépenses par carte, financée par la plateforme.

Chaque règle définit un taux, une période d'éligibilité et des filtres marchands facultatifs, et peut être limitée à un seul sous-compte.

Utilisez l'API Cashback Rules pour créer, mettre à jour et lister les règles que votre plateforme finance, puis versez le cashback à la demande depuis votre solde USD disponible.

## Endpoints

| Endpoint | Requête |
| - | - |
| [Lister les règles de cashback](https://docs.whop.com/fr/api-reference/cashback-rules/list-cashback-rules.md) | GET `/cashback_rules` |
| [Créer une règle de cashback](https://docs.whop.com/fr/api-reference/cashback-rules/create-cashback-rule.md) | POST `/cashback_rule` |
| [Verser le cashback](https://docs.whop.com/fr/api-reference/cashback-rules/pay-out-cashback.md) | POST `/cashback_rules/payout` |
| [Mettre à jour une règle de cashback](https://docs.whop.com/fr/api-reference/cashback-rules/update-cashback-rule.md) | PATCH `/cashback_rules/{id}` |

## Verser le cashback

Envoyez un objet vide à `POST /cashback_rules/payout` pour distribuer tout le cashback éligible. Définissez `cashback_rule_id` pour distribuer une seule règle, `account_id` pour payer un seul sous-compte, ou `transaction_id` pour payer une seule transaction par carte. Si plusieurs filtres sont fournis, ils doivent tous correspondre.

```json theme={null}
{
	"cashback_rule_id": "cicbr_7kR2m9Qx4L",
	"account_id": "biz_connectedDemo",
	"transaction_id": "citx_8jF6w3Nv2B"
}
```

Utilisez un en-tête `Idempotency-Key` lorsque vous demandez un versement. Une réponse `202` avec `status: "processing"` confirme que le traitement a été mis en file d'attente et renvoie les filtres fournis. Une réponse `200` avec `status: "failed"` signifie que la file d'attente a rejeté la requête. Ces statuts décrivent la planification, pas l'achèvement du paiement. Les tâches de transaction relancent automatiquement les échecs. Ajoutez des USD au portefeuille de financement si ses fonds sont insuffisants. Les requêtes répétées ignorent les paiements déjà enregistrés, et l'idempotence du registre empêche les crédits en double.

Réponse :

```json theme={null}
{
	"status": "processing",
	"cashback_rule_id": "cicbr_7kR2m9Qx4L",
	"account_id": "biz_connectedDemo",
	"transaction_id": "citx_8jF6w3Nv2B"
}
```

## Attributs

**id** `string` *required*

ID de la règle de cashback, préfixé par `cicbr_`.

**created\_at** `string` *required*

Date de création de la règle, sous forme d'horodatage ISO 8601.

**description** `string | null` *required*

Description facultative de la règle de cashback.

**discarded\_at** `string | null` *required*

Date à laquelle la règle a été abandonnée, sous forme d'horodatage ISO 8601.
Null signifie qu'elle n'a pas été abandonnée.

**expires\_at** `string | null` *required*

Fin exclusive de la période d'éligibilité, sous forme d'horodatage ISO 8601.
Null signifie aucune expiration.

**funding\_account\_id** `string` *required*

Compte de plateforme désigné pour financer le cashback, préfixé par `biz_`.
Déduit des identifiants authentifiés.

**merchant\_category\_code** `string | null` *required*

Code de catégorie marchand à quatre chiffres. Null correspond à n'importe quel
MCC. Lorsque les deux filtres marchands sont null, scoped\_account\_id est requis.

**merchant\_name** `string | null` *required*

Nom brut du marchand tel que communiqué par le fournisseur de la carte. Null
correspond à n'importe quel nom de marchand. Lorsqu'il est défini, il est
combiné à tout filtre MCC ; il ne s'agit pas d'une correspondance par
sous-chaîne ni sur un nom d'affichage enrichi.

**rate\_bps** `integer` *required*

Taux de cashback en points de base. 100 signifie 1 %, et 10000 signifie 100 %.

**scoped\_account\_id** `string | null` *required*

ID du sous-compte, préfixé par `biz_`. Null désigne tous les sous-comptes
directs de la plateforme qui finance.

**starts\_at** `string` *required*

Début inclusif de la période d'éligibilité de la règle, sous forme
d'horodatage ISO 8601.

**updated\_at** `string` *required*

Date de dernière mise à jour de la règle, sous forme d'horodatage ISO 8601.

```json CashbackRule theme={null}
{
	"id": "cicbr_a1B2c3D4e5F6g",
	"merchant_name": "ACME SOFTWARE",
	"merchant_category_code": "5734",
	"rate_bps": 500,
	"description": "Software cashback",
	"funding_account_id": "biz_a1B2c3D4e5F6g",
	"scoped_account_id": "biz_h7I8j9K0l1M2n",
	"starts_at": "2026-10-01T00:00:00.000Z",
	"expires_at": "2026-11-01T00:00:00.000Z",
	"discarded_at": null,
	"created_at": "2026-09-10T08:00:00.000Z",
	"updated_at": "2026-09-10T08:00:00.000Z"
}
```
