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

# Transfers API

> Een Transfer verplaatst geld tussen Whop-saldi: van het ene account of de ene gebruiker naar een ander, van de wallet van een account naar een persoon of adres, of naar een claimlink die iedereen met de URL kan inwisselen.

Gebruik de Transfers API om geld te versturen, ontvangers te vinden die je kunt betalen, overboekingen weer te geven en op te halen bij het afstemmen van geldstromen, en claimlinks te bekijken of in te wisselen.

Abonneer je op `transfer.completed` en `transfer.failed` voor uitkomsten in plaats van te pollen. Elk deelnemend account kan zich op deze events abonneren. `transfer.created` wordt ook bij succes verstuurd, niet wanneer de verwerking begint. Een mislukte overboeking kan onder hetzelfde ID opnieuw worden geprobeerd en later alsnog slagen; haal de overboeking op om de huidige status af te stemmen.

Een geslaagde saldo-overboeking wordt bijgeschreven op het beschikbare saldo van de ontvanger, tenzij er een vrijgavedatum geldt. Overboekingen die uit een openstaand saldo worden gefinancierd, behouden een vrijgavedatum en worden bijgeschreven op het openstaande saldo; toepasselijke reserves van de ontvanger of fraudeblokkeringen kunnen ervoor zorgen dat geld niet beschikbaar is. `succeeded` bevestigt dat de overboeking is voltooid, niet dat al het geld kan worden opgenomen.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Claimlink ophalen](https://docs.whop.com/nl/api-reference/transfers/retrieve-claim-link.md) | GET `/claim_links/{id}` |
| [Transfers weergeven](https://docs.whop.com/nl/api-reference/transfers/list-transfers.md) | GET `/transfers` |
| [Transfer ophalen](https://docs.whop.com/nl/api-reference/transfers/retrieve-transfer.md) | GET `/transfers/{id}` |
| [Transferontvangers weergeven](https://docs.whop.com/nl/api-reference/transfers/list-transfer-recipients.md) | GET `/transfers/recipients` |
| [Claimen](https://docs.whop.com/nl/api-reference/transfers/claim.md) | POST `/claim_links/{id}/claim` |
| [Transfer aanmaken](https://docs.whop.com/nl/api-reference/transfers/create-transfer.md) | POST `/transfers` |

## Attributen

**id** `string` *required*

Transfer-ID.

**amount** `object | null` *required*

Bedrag dat aan de ontvanger is bijgeschreven. Null zolang de overboeking niet is geslaagd.

> [accordion] Eigenschappen
>
> **amount** `string` *required*
>
> Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is
> bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg
> afrondt.
>
> **currency** `string` *required*
>
> Valutacode volgens ISO 4217 van drie letters, in kleine letters.
>
> **decimals** `integer` *required*
>
> Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling
> zelf wordt uitgevoerd.
>
> **display\_decimals** `integer` *required*
>
> Hoeveel decimalen je moet TONEN. Meestal gelijk aan `decimals`, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso's geschreven, dus het is `2` en `0`. Formatteer het getal hiermee in je eigen locale.

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

Wanneer de overboeking is aangemaakt.

**destination** `object | null` *required*

Bedrijfsaccount of gebruiker die de overboeking ontvangt.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Account- of gebruikers-ID.
>
> **logo\_url** `string | null` *required*
>
> URL van het bedrijfslogo of de gebruikersavatar. Null als er geen afbeelding
> beschikbaar is.
>
> **name** `string | null` *required*
>
> Weergavenaam van het bedrijf of de gebruiker.
>
> **object** `string` *required*
>
> Of het profiel een bedrijfsaccount of een gebruiker is.
>
> Beschikbare opties: `account`, `user`

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

Vastgelegd tijdstip van mislukking. Null tenzij de overboeking is mislukt.

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

Machineleesbare foutcode. Null tenzij de overboeking is mislukt.

**failure\_reason** `string | null` *required*

Uitleg van de fout. Null tenzij de overboeking is mislukt.

**fee** `object | null` *required*

Alle toepasselijke transferkosten, inclusief platformopslag. Null als het gezaghebbende totaal niet beschikbaar is.

> [accordion] Eigenschappen
>
> **amount** `string` *required*
>
> Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is
> bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg
> afrondt.
>
> **currency** `string` *required*
>
> Valutacode volgens ISO 4217 van drie letters, in kleine letters.
>
> **decimals** `integer` *required*
>
> Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling
> zelf wordt uitgevoerd.
>
> **display\_decimals** `integer` *required*
>
> Hoeveel decimalen je moet TONEN. Meestal gelijk aan `decimals`, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso's geschreven, dus het is `2` en `0`. Formatteer het getal hiermee in je eigen locale.

**metadata** `object` *required*

Aangepaste metadata die aan de overboeking is gekoppeld.

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

Notitie bij de overboeking.

**object** `string` *required*

Het objecttype.

**origin** `object | null` *required*

Bedrijfsaccount of gebruiker die de overboeking verstuurt.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Account- of gebruikers-ID.
>
> **logo\_url** `string | null` *required*
>
> URL van het bedrijfslogo of de gebruikersavatar. Null als er geen afbeelding
> beschikbaar is.
>
> **name** `string | null` *required*
>
> Weergavenaam van het bedrijf of de gebruiker.
>
> **object** `string` *required*
>
> Of het profiel een bedrijfsaccount of een gebruiker is.
>
> Beschikbare opties: `account`, `user`

**status** `string` *required*

Huidige status van de overboeking. Een overboeking kan als `processing` worden aangemaakt en een paar seconden later worden afgewikkeld; poll Retrieve Transfer of luister naar de webhooks `transfer.completed` en `transfer.failed` in plaats van de respons bij het aanmaken als definitief te beschouwen. `succeeded` en `failed` zijn definitief.

Beschikbare opties: `processing`, `succeeded`, `failed`

**status\_changed\_at** `string | null` *required*

Vastgelegd tijdstip van de huidige overgang. Null als het historische
tijdstip van de overgang onbekend is.

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

Vastgelegd tijdstip van slagen. Null als onbekend.

**tracking\_url** `string` *required*

Trackingpagina voor de overboeking. Om deze te bekijken moet je zijn ingelogd
en toegang hebben tot de overboeking.

```json Transfer theme={null}
{
	"id": "ctt_xxxxxxxxxxxxxx",
	"object": "transfer",
	"status": "succeeded",
	"origin": {
		"id": "biz_xxxxxxxxxxxxxx",
		"object": "account",
		"name": "Pickaxe",
		"logo_url": null
	},
	"destination": {
		"id": "user_xxxxxxxxxxxxx",
		"object": "user",
		"name": "Alex Rivera",
		"logo_url": null
	},
	"amount": {
		"amount": "50.00",
		"currency": "usd",
		"decimals": 2,
		"display_decimals": 2
	},
	"fee": {
		"amount": "1.00",
		"currency": "usd",
		"decimals": 2,
		"display_decimals": 2
	},
	"created_at": "2026-06-01T12:00:00.000Z",
	"status_changed_at": null,
	"succeeded_at": null,
	"failed_at": null,
	"failure_code": null,
	"failure_reason": null,
	"notes": "Creator bonus",
	"metadata": {
		"external_transfer_id": "transfer_123"
	},
	"tracking_url": "https://whop.com/ctt_xxxxxxxxxxxxxx/"
}
```


## Related topics

- [Transfers](https://docs.whop.com/nl/api-reference/legacy/transfers/transfer.md)
- [Transfer completed](https://docs.whop.com/nl/api-reference/transfers/transfer-completed.md)
- [Transfer created](https://docs.whop.com/nl/api-reference/transfers/transfer-created.md)
