> ## 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.

# Cashback Rules API

> Een Cashback Rule betaalt de directe subaccounts van een platform een deel van hun kaartuitgaven terug, gefinancierd door het platform.

Elke regel stelt een percentage, een geschiktheidsperiode en optionele merchantfilters in, en kan worden beperkt tot één subaccount.

Gebruik de Cashback Rules API om de regels die je platform financiert aan te maken, bij te werken en weer te geven, en betaal cashback op aanvraag uit vanuit je beschikbare USD-saldo.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Cashbackregels weergeven](https://docs.whop.com/nl/api-reference/cashback-rules/list-cashback-rules.md) | GET `/cashback_rules` |
| [Cashbackregel aanmaken](https://docs.whop.com/nl/api-reference/cashback-rules/create-cashback-rule.md) | POST `/cashback_rule` |
| [Cashback uitbetalen](https://docs.whop.com/nl/api-reference/cashback-rules/pay-out-cashback.md) | POST `/cashback_rules/payout` |
| [Cashbackregel bijwerken](https://docs.whop.com/nl/api-reference/cashback-rules/update-cashback-rule.md) | PATCH `/cashback_rules/{id}` |

## Cashback uitbetalen

Stuur een leeg object naar `POST /cashback_rules/payout` om alle in aanmerking komende cashback uit te keren. Stel `cashback_rule_id` in om één regel uit te keren, `account_id` om één subaccount te betalen, of `transaction_id` om één kaarttransactie te betalen. Meerdere filters moeten allemaal overeenkomen.

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

Gebruik een `Idempotency-Key`-header wanneer je een uitbetaling aanvraagt. Een `202`-response met `status: "processing"` bevestigt dat de verwerking in de wachtrij is geplaatst en herhaalt de opgegeven filters. Een `200`-response met `status: "failed"` betekent dat de wachtrij het verzoek heeft geweigerd. Deze statussen beschrijven de planning, niet de voltooiing van de betaling. Transactiejobs proberen mislukte pogingen automatisch opnieuw. Voeg USD toe aan de financieringswallet als die onvoldoende saldo heeft. Herhaalde verzoeken slaan betalingen over die al zijn vastgelegd, en idempotentie in het grootboek voorkomt dubbele creditering.

Response:

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

## Attributen

**id** `string` *required*

Cashbackregel-ID, met prefix `cicbr_`.

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

Wanneer de regel is aangemaakt, als ISO 8601-tijdstempel.

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

Optionele beschrijving van de cashbackregel.

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

Wanneer de regel is verwijderd, als ISO 8601-tijdstempel. Null betekent dat
deze niet is verwijderd.

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

Exclusief einde van de geschiktheidsperiode, als ISO 8601-tijdstempel. Null
betekent geen vervaldatum.

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

Platformaccount dat is aangewezen om cashback te financieren, met prefix
`biz_`. Afgeleid uit de geauthenticeerde credential.

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

Viercijferige merchant category code. Null komt overeen met elke MCC. Wanneer
beide merchantfilters null zijn, is scoped\_account\_id vereist.

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

Ruwe merchantnaam zoals gerapporteerd door de kaartprovider. Null komt overeen
met elke merchantnaam. Wanneer ingesteld, wordt deze samen met een eventueel
MCC-filter gematcht; geen substring- of verrijkte weergavenaam-match.

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

Cashbackpercentage in basispunten. 100 betekent 1% en 10000 betekent 100%.

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

Subaccount-ID, met prefix `biz_`. Null wijst alle directe subaccounts van het
financierende platform aan.

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

Inclusief begin van de geschiktheidsperiode van de regel, als ISO
8601-tijdstempel.

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

Wanneer de regel voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.

```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"
}
```


## Related topics

- [Create Cashback Rule](https://docs.whop.com/nl/api-reference/cashback-rules/create-cashback-rule.md)
- [Update Cashback Rule](https://docs.whop.com/nl/api-reference/cashback-rules/update-cashback-rule.md)
- [List Cashback Rules](https://docs.whop.com/nl/api-reference/cashback-rules/list-cashback-rules.md)
