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

# Payouts API

> Payouts zijn geld dat vanuit het saldo van een account of gebruiker naar een externe bestemming wordt gestuurd, zoals een bankrekening, wallet of andere opgeslagen uitbetalingsmethode.

Gebruik de Payouts API om uitbetalingen aan te maken en te volgen, opgeslagen uitbetalingsmethoden te beheren en de verwachte aankomstgegevens te tonen voor geld dat Whop verlaat.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Uitbetalingen opvragen](https://docs.whop.com/nl/api-reference/payouts/list-payouts.md) | GET `/payouts` |
| [Uitbetaling ophalen](https://docs.whop.com/nl/api-reference/payouts/retrieve-payout.md) | GET `/payouts/{id}` |
| [Opgeslagen uitbetalingsmethoden opvragen](https://docs.whop.com/nl/api-reference/payouts/list-saved-payout-methods.md) | GET `/payouts/methods` |
| [Ondersteunde uitbetalingsmethoden opvragen](https://docs.whop.com/nl/api-reference/payouts/list-supported-payout-methods.md) | GET `/payouts/supported_methods` |
| [Uitbetaling aanmaken](https://docs.whop.com/nl/api-reference/payouts/create-payout.md) | POST `/payouts` |
| [Uitbetaling annuleren](https://docs.whop.com/nl/api-reference/payouts/cancel-payout.md) | POST `/payouts/{id}/cancel` |
| [Opgeslagen uitbetalingsmethode aanmaken](https://docs.whop.com/nl/api-reference/payouts/create-saved-payout-method.md) | POST `/payouts/methods` |
| [PayPal-koppelsessie aanmaken](https://docs.whop.com/nl/api-reference/payouts/create-paypal-link-session.md) | POST `/payouts/paypal_link_sessions` |
| [Uitbetalingsofferte aanmaken](https://docs.whop.com/nl/api-reference/payouts/create-payout-quote.md) | POST `/payouts/quotes` |
| [Opgeslagen uitbetalingsmethode bijwerken](https://docs.whop.com/nl/api-reference/payouts/update-saved-payout-method.md) | PATCH `/payouts/methods/{id}` |
| [Opgeslagen uitbetalingsmethode verwijderen](https://docs.whop.com/nl/api-reference/payouts/delete-saved-payout-method.md) | DELETE `/payouts/methods/{id}` |

## Attributen

**id** `string` *required*

Payout-ID, met prefix `wdrl_`.

**amount** `string` *required*

Het uitbetalingsbedrag in hele valuta-eenheden, als decimale string.

**cancelable** `boolean` *required*

Of `POST /payouts/\{id}/cancel` op dit moment effect zou hebben op deze uitbetaling: `true` zolang deze `in_review` is, zolang deze `processing` is en er nog niets bij de uitbetalingsprovider is ingediend, of zolang een ingediende uitbetaling nog bij de provider kan worden geannuleerd. `false` zodra het geld is aangekomen of de uitbetaling al is beëindigd.

**conversion** `object | null` *required*

Hoe het saldo naar de uitbetalingsvaluta is omgerekend voordat de uitbetaling werd verstuurd. `null` wanneer de uitbetaling is verstuurd vanuit een saldo in de eigen valuta.

> [accordion] Eigenschappen
>
> **from\_amount** `string` *required*
>
> Het bedrag dat de omrekening van het saldo heeft afgeschreven, als decimale string.
>
> **from\_currency** `string` *required*
>
> De valuta van het saldo waarvan de omrekening het bedrag heeft afgeschreven.
>
> **rate** `number` *required*
>
> De omrekeningskoers, in eenheden van de uitbetalingsvaluta per eenheid `from_currency`. Eventuele omrekeningskosten zijn in deze koers inbegrepen.

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

Wanneer de uitbetaling is aangemaakt.

**currency** `string` *required*

Uitbetalingsvaluta.

**destination\_amount** `string | null` *required*

Het bedrag dat in de bestemmingsvaluta is geleverd, als decimale string. Wordt toegewezen wanneer de uitbetaling wordt verwerkt, dus het is daarvoor `null`, en ook bij uitbetalingen zonder vastgelegde omrekening.

**destination\_currency** `string | null` *required*

Valuta waarin het geld wordt geleverd, overgenomen van de uitbetalingsmethode wanneer de uitbetaling wordt aangemaakt. Bij een uitbetaling die door een omrekeningsverzoek wordt gefinancierd, volgt deze de settlement-uitbetaling die ernaast wordt aangemaakt — de `GET /payouts`-rij met de id van deze uitbetaling als `payout_request_id` — en is alleen `null` wanneer er geen settlement-uitbetaling bestaat.

**estimated\_arrival** `string | null` *required*

Geschat tijdstip waarop het geld beschikbaar komt op de bestemmingsrekening.

**exchange\_rate** `number | null` *required*

Wisselkoers van de uitbetalingsvaluta naar de bestemmingsvaluta. Wordt toegewezen wanneer de uitbetaling wordt verwerkt, dus het is daarvoor `null`, en ook bij uitbetalingen zonder vastgelegde koers.

**failure** `object | null` *required*

Waarom de uitbetaling eindigde zonder te betalen, of waarom deze na settlement is teruggedraaid. Aanwezig bij mislukte, geannuleerde, geweigerde en teruggedraaide uitbetalingen; anders `null`.

> [accordion] Eigenschappen
>
> **code** `string | null` *required*
>
> Geclassificeerde foutcode uit de bijgehouden foutcatalogus.
>
> **funds\_returned\_at** `string | null` *required*
>
> Het effectieve tijdstip van de terugboeking die het geld terug op het saldo zette — `null` als het saldo nooit is verlaten of het geld nog niet is teruggekeerd. Wordt pas ingesteld zodra de terugkeer in het grootboek is bevestigd; de grootboekboeking zelf kan kort na dit tijdstip plaatsvinden.
>
> **message** `string | null` *required*
>
> Voor mensen leesbare uitleg van de fout. Aanroepers met `payout:destination:read` kunnen tekst ontvangen die op de bestemming is afgestemd; andere aanroepers krijgen het generieke catalogusbericht.

**fee\_amount** `string` *required*

De kosten die voor de uitbetaling in rekening zijn gebracht, in de uitbetalingsvaluta, als decimale string.

**fee\_paid\_by** `string` *required*

Wie de uitbetalingskosten droeg: het account zelf, of het bovenliggende platform.

Beschikbare opties: `self`, `platform`

**markup\_fee** `string` *required*

De opslag van Whop op de providerkosten, in de uitbetalingsvaluta, als decimale string. `"0.0"` wanneer er geen van toepassing is.

**metadata** `object` *required*

Sleutel-waardegegevens die bij het aanmaken zijn toegevoegd en bij elke leesbewerking worden teruggegeven. Maximaal 50 sleutels, sleutelnamen tot 40 tekens, stringwaarden tot 500 tekens.

**net\_amount** `string` *required*

Het geplande netto bedrag voor de bestemming, in de uitbetalingsvaluta: amount min fee\_amount min markup\_fee wanneer fee\_paid\_by `self` is; gelijk aan amount wanneer het platform de kosten dekt. Een uitbetaling die eindigt als geweigerd, geannuleerd of mislukt heeft niets geleverd — de meeste behouden het geplande bedrag en `failure` geeft aan waar het geld is, maar een geannuleerde uitbetaling die door een omrekeningsverzoek is gefinancierd kan in plaats daarvan de afgewikkelde uitkomst rapporteren: `amount` bevat wat op het saldo is gebleven, de kosten zijn nul omdat er geen in rekening zijn gebracht, en `net_amount` is 0 omdat er niets is geleverd.

**notes** `string | null` *required*

Vrije notities die door de maker van de uitbetaling zijn toegevoegd, of `null` wanneer er geen zijn opgegeven. Maximaal 255 tekens.

**object** `string` *required*

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

Naam van de partij die de uitbetaling verwerkt.

**payout\_method** `object | null` *required*

De gebruikte opgeslagen uitbetalingsmethode. Vereist payout:destination:read; null zonder.

> [accordion] Eigenschappen
>
> **nickname** `string | null` *required*
>
> Bijnaam van de opgeslagen uitbetalingsmethode.
>
> **supported\_payout\_method** `object | null` *required*
>
> Weergavegegevens van de ondersteunde uitbetalingsmethode.
>
> > [accordion] Eigenschappen
> >
> > **delivery\_type** `string` *required*
> >
> > Hoe het geld aan de ontvanger wordt geleverd.
> >
> > Beschikbare opties: `cash_pickup`, `bank_deposit`, `home_delivery`, `mobile_wallet`, `card`, `check`, `bill`, `cryptocurrency`, `unknown`
> >
> > **icon\_url** `string | null` *required*
> >
> > URL van het pictogram van de ondersteunde uitbetalingsmethode.
> >
> > **payer\_name** `string | null` *required*
> >
> > Weergavenaam van de ondersteunde uitbetalingsmethode.
>
> **type** `string` *required*
>
> Het soort uitbetalingsmethode dat de uitbetaling gebruikte. `external` stuurde geld buiten Whop. `whop_card` zette geld over naar de eigen Whop Card van het account.
>
> Beschikbare opties: `external`, `whop_card`

**payout\_request\_id** `string | null` *required*

Payout request-ID, met prefix `cofr_`, geretourneerd door `POST /payouts`. Koppel het aan de afgewikkelde uitbetaling in `GET /payouts`. Geeft `null` terug voor uitbetalingen die niet door `POST /payouts` zijn aangemaakt.

**source** `string | null` *required*

Hoe de uitbetaling is aangemaakt. `automatic` betekent een geplande automatische uitbetaling. `null` wanneer de uitbetaling geen vastgelegde bron heeft.

Beschikbare opties: `api`, `dashboard`, `automatic`

**speed** `string` *required*

Leveringssnelheid van de uitbetaling.

Beschikbare opties: `standard`, `instant`

**statement\_descriptor** `string | null` *required*

De betalingsomschrijving die met de uitbetaling wordt meegestuurd, of `null` als er geen omschrijving is ingesteld. Indien ingesteld, 5-80 afdrukbare ASCII-tekens.

**status** `string` *required*

Huidige status van de uitbetaling.

Beschikbare opties: `requested`, `in_review`, `processing`, `completed`, `reversed`, `canceled`, `failed`, `denied`

**status\_detail** `string` *required*

De meest gedetailleerde machinefase onder `status` — bijvoorbeeld `awaiting_provider_acceptance` versus `in_transit` onder `processing`, of de omrekeningsfase onder `requested`. Informatief vocabulaire: er kunnen waarden worden toegevoegd zonder versieverhoging; `status` is het geversioneerde contract.

**trace\_code** `string | null` *required*

Referentie van het betaalnetwerk voor deze uitbetaling, zoals een ACH-tracenummer, een RTP- of FedNow-end-to-end-ID, een wire-IMAD of een SWIFT UETR. `null` totdat de referentie beschikbaar is, en bij uitbetalingen die er geen hebben.

```json Payout theme={null}
{
	"id": "wdrl_xxxxxxxxxxxxx",
	"amount": "125.5",
	"cancelable": false,
	"conversion": null,
	"created_at": "2026-06-01T12:00:00Z",
	"currency": "usd",
	"destination_amount": "115.89",
	"destination_currency": "eur",
	"estimated_arrival": "2026-06-03T12:00:00Z",
	"exchange_rate": 0.9234,
	"failure": null,
	"fee_amount": "1.25",
	"fee_paid_by": "self",
	"markup_fee": "0.0",
	"metadata": {
		"batch_id": "2026-06-01"
	},
	"net_amount": "124.25",
	"notes": "March affiliate commissions",
	"object": "payout",
	"payer_name": "Whop Payments",
	"payout_request_id": "cofr_xxxxxxxxxxxxx",
	"payout_method": {
		"nickname": "Operating account",
		"type": "external",
		"supported_payout_method": {
			"delivery_type": "bank_deposit",
			"icon_url": "https://cdn.whop.com/bank.png",
			"payer_name": "Whop Payments"
		}
	},
	"source": "api",
	"speed": "standard",
	"status": "completed",
	"status_detail": "completed",
	"statement_descriptor": "MYCOMPANY",
	"trace_code": "021000021234567"
}
```


## Related topics

- [API-versies](https://docs.whop.com/nl/developer/api/versioning.md)
- [Payout created](https://docs.whop.com/nl/api-reference/payouts/payout-created.md)
- [Payout reversed](https://docs.whop.com/nl/api-reference/payouts/payout-reversed.md)
