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

# Payment Rules API

> Met een Payment Rule kan een account op zijn eigen betalingen reageren voordat ze de bank bereiken: ze blokkeren, doorlaten, ter beoordeling sturen of de koper om 3D Secure vragen.

Elke regel matcht op een kleine set betalingskenmerken, en elke voorwaarde moet kloppen voordat de regel van toepassing is.

De definitie van een regel staat vast zodra deze is aangemaakt, zodat de betalingen waarover de regel heeft beslist de regel die erover besliste blijven noemen. Gebruik [Vervangen](https://docs.whop.com/nl/api-reference/payment-rules/replace-a-payment-rule.md) om er een te wijzigen, en [Velden opvragen](https://docs.whop.com/nl/api-reference/payment-rules/list-fields.md) voor de kenmerken, operatoren en waarden die een voorwaarde kan gebruiken.

Lees de handleiding [Fraude beheren](https://docs.whop.com/nl/developer/guides/manage-fraud.md) voor een stapsgewijze uitleg over het blokkeren, beoordelen, uitdagen en toestaan van checkouts om fraude terug te dringen.

> [!WARNING]
>
> Een `review`-regel kan legacy-embeds op **Processing**
> laten staan tot de capture. Automatische capture is gepland voor 48 uur na
> autorisatie, maar de afronding kan langer duren of mislukken. Review-regels gelden
> voor het hele account en zijn nog steeds van toepassing op legacy-embeds. Bekijk [geschiktheid voor review hold
> en checkoutbeperkingen](https://docs.whop.com/nl/developer/guides/manage-fraud.md#review-a-payment-before-charging-it)
> voordat je ze inschakelt.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Payment rules opvragen](https://docs.whop.com/nl/api-reference/payment-rules/list-payment-rules.md) | GET `/payment_rules` |
| [Een payment rule ophalen](https://docs.whop.com/nl/api-reference/payment-rules/retrieve-a-payment-rule.md) | GET `/payment_rules/{id}` |
| [Velden opvragen](https://docs.whop.com/nl/api-reference/payment-rules/list-fields.md) | GET `/payment_rules/fields` |
| [Een payment rule aanmaken](https://docs.whop.com/nl/api-reference/payment-rules/create-a-payment-rule.md) | POST `/payment_rules` |
| [Een payment rule activeren](https://docs.whop.com/nl/api-reference/payment-rules/activate-a-payment-rule.md) | POST `/payment_rules/{id}/activate` |
| [Een payment rule deactiveren](https://docs.whop.com/nl/api-reference/payment-rules/deactivate-a-payment-rule.md) | POST `/payment_rules/{id}/deactivate` |
| [Een payment rule vervangen](https://docs.whop.com/nl/api-reference/payment-rules/replace-a-payment-rule.md) | POST `/payment_rules/{id}/replace` |
| [Een payment rule bijwerken](https://docs.whop.com/nl/api-reference/payment-rules/update-a-payment-rule.md) | PATCH `/payment_rules/{id}` |
| [Een payment rule verwijderen](https://docs.whop.com/nl/api-reference/payment-rules/delete-a-payment-rule.md) | DELETE `/payment_rules/{id}` |

## Attributen

**id** `string` *required*

Payment rule-ID, met prefix `prule_`.

**account\_id** `string` *required*

Account-ID, met prefix `biz_`.

**action** `string` *required*

Wat de regel van dit account vraagt wanneer elke voorwaarde matcht. Eén toepasselijke account-regelactie wint, in deze volgorde: `allow`, `block`, `review`, `enforce_3ds`. Een `allow` overschrijft de andere regels van dit account, nooit de eigen fraudecontroles van Whop. Een `review` vraagt autorisatie zonder capture aan voor een geschikte on-session kaartbetaling via Whop Payments. Automatische capture is gepland voor 48 uur na autorisatie; capture of void de betaling eerder om sneller te beslissen. De capture kan later worden afgerond of mislukken. Review wordt overgeslagen voor niet-ondersteunde methoden, off-session betalingen en betalingen die al voor handmatige capture zijn geconfigureerd. Een `enforce_3ds` wordt overgeslagen wanneer de account-regel geen challenge kan toepassen. Andere 3DS-vereisten blijven gelden.

Beschikbare opties: `allow`, `block`, `review`, `enforce_3ds`

**conditions** `object` *required*

De voorwaarden waaraan een betaling wordt getoetst. Maximaal 10 voorwaarden, en 8 KiB na serialisatie.

> [accordion] Eigenschappen
>
> **all** `object[]` *required*
>
> Voorwaarden die allemaal moeten matchen voordat de regel van toepassing is. Een betalingskenmerk dat de regel niet kan lezen, matcht niet.
>
> > [accordion] Eigenschappen
> >
> > **field** `string` *required*
> >
> > Het betalingskenmerk dat deze voorwaarde leest.
> >
> > Beschikbare opties: `risk_score`, `amount_in_usd`, `card_country`, `card_brand`, `card_funding`, `card_bin`, `billing_country`, `billing_postal_code`, `billing_city`, `customer_email`, `email_domain`, `ip_address`, `ip_country`
> >
> > **operator** `string` *required*
> >
> > Hoe het betalingskenmerk met de waarde wordt vergeleken.
> >
> > Beschikbare opties: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`, `starts_with`, `contains`, `ends_with`, `in_cidr`
> >
> > **value** `number or string or string[]` *required*
> >
> > De waarde waarmee wordt vergeleken.

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

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

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

Wanneer de regel is verwijderd, als ISO 8601-tijdstempel. `null`, tenzij `status` `deleted` is.

**metadata** `object` *required*

Aangepaste string-naar-string-waarden voor je integratie. Maximaal 50 sleutels, 40 tekens per sleutel, 500 tekens per waarde.

**name** `string` *required*

Een naam voor deze regel. Maximaal 255 tekens.

**status** `string` *required*

Of de regel op betalingen wordt toegepast. Een `deleted` regel blijft bewaard, zodat de betalingen waarover hij al heeft beslist hem nog steeds noemen.

Beschikbare opties: `active`, `inactive`, `deleted`

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

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

```json PaymentRule theme={null}
{
	"id": "prule_xxxxxxxxxxxxx",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"name": "Block high-risk cards from outside the US",
	"status": "active",
	"action": "block",
	"conditions": {
		"all": [
			{
				"field": "risk_score",
				"operator": "gte",
				"value": 85
			},
			{
				"field": "card_country",
				"operator": "neq",
				"value": "US"
			}
		]
	},
	"metadata": {},
	"created_at": "2026-09-01T12:00:00.000Z",
	"updated_at": "2026-09-01T12:00:00.000Z",
	"deleted_at": null
}
```
