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

> Les Payouts représentent l'argent envoyé depuis le solde d'un compte ou d'un utilisateur vers une destination externe, comme un compte bancaire, un portefeuille ou un autre moyen de versement enregistré.

Utilisez l'API Payouts pour créer et suivre des versements, gérer les moyens de versement enregistrés et afficher les détails d'arrivée prévue des fonds qui quittent Whop.

## Endpoints

| Endpoint | Requête |
| - | - |
| [Lister les versements](https://docs.whop.com/fr/api-reference/payouts/list-payouts.md) | GET `/payouts` |
| [Récupérer un versement](https://docs.whop.com/fr/api-reference/payouts/retrieve-payout.md) | GET `/payouts/{id}` |
| [Lister les moyens de versement enregistrés](https://docs.whop.com/fr/api-reference/payouts/list-saved-payout-methods.md) | GET `/payouts/methods` |
| [Lister les moyens de versement pris en charge](https://docs.whop.com/fr/api-reference/payouts/list-supported-payout-methods.md) | GET `/payouts/supported_methods` |
| [Créer un versement](https://docs.whop.com/fr/api-reference/payouts/create-payout.md) | POST `/payouts` |
| [Annuler un versement](https://docs.whop.com/fr/api-reference/payouts/cancel-payout.md) | POST `/payouts/{id}/cancel` |
| [Créer un moyen de versement enregistré](https://docs.whop.com/fr/api-reference/payouts/create-saved-payout-method.md) | POST `/payouts/methods` |
| [Créer une session de liaison PayPal](https://docs.whop.com/fr/api-reference/payouts/create-paypal-link-session.md) | POST `/payouts/paypal_link_sessions` |
| [Créer un devis de versement](https://docs.whop.com/fr/api-reference/payouts/create-payout-quote.md) | POST `/payouts/quotes` |
| [Mettre à jour un moyen de versement enregistré](https://docs.whop.com/fr/api-reference/payouts/update-saved-payout-method.md) | PATCH `/payouts/methods/{id}` |
| [Supprimer un moyen de versement enregistré](https://docs.whop.com/fr/api-reference/payouts/delete-saved-payout-method.md) | DELETE `/payouts/methods/{id}` |

## Attributs

**id** `string` *required*

ID du versement, préfixé par `wdrl_`.

**amount** `string` *required*

Le montant du versement en unités monétaires entières, sous forme de chaîne décimale.

**cancelable** `boolean` *required*

Indique si `POST /payouts/\{id}/cancel` agirait sur ce versement à cet instant :
`true` tant qu'il est `in_review`, tant qu'il est `processing` sans que rien n'ait encore
été soumis au prestataire de versement, ou tant qu'il est encore possible de demander
l'annulation d'un versement soumis auprès du prestataire. `false` une fois l'argent arrivé ou le
versement déjà terminé.

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

La manière dont le solde a été converti dans la devise du versement avant l'envoi du versement. `null` lorsque le versement a été envoyé depuis un solde dans sa propre devise.

> [accordion] Propriétés
>
> **from\_amount** `string` *required*
>
> Le montant prélevé sur le solde par la conversion, sous forme de chaîne décimale.
>
> **from\_currency** `string` *required*
>
> La devise du solde sur lequel la conversion a prélevé le montant.
>
> **rate** `number` *required*
>
> Le taux de conversion, en unités de la devise du versement pour chaque unité de `from_currency`. Les éventuels frais de conversion sont inclus dans ce taux.

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

Date de création du versement.

**currency** `string` *required*

Devise du versement.

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

Le montant livré dans la devise de destination, sous forme de chaîne décimale.
Attribué lors du traitement du versement ; il vaut donc `null` avant cela et sur
les versements sans conversion enregistrée.

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

Devise dans laquelle les fonds sont livrés, reprise du moyen de versement lors de la
création du versement. Sur un versement financé par une demande de conversion, elle suit le
versement de règlement créé en parallèle — la ligne de `GET /payouts` portant l'id de ce
versement comme `payout_request_id` — et ne vaut `null` que lorsqu'aucun versement de règlement
n'existe.

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

Date estimée à laquelle les fonds deviennent disponibles sur le compte de destination.

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

Taux de change de la devise du versement vers la devise de destination. Attribué
lors du traitement du versement ; il vaut donc `null` avant cela et sur les versements
sans taux enregistré.

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

La raison pour laquelle le versement s'est terminé sans paiement, ou pour laquelle il a été annulé après règlement. Présent sur les versements échoués, annulés, refusés et contrepassés ; `null` sinon.

> [accordion] Propriétés
>
> **code** `string | null` *required*
>
> Code d'échec classifié issu du catalogue d'erreurs maintenu.
>
> **funds\_returned\_at** `string | null` *required*
>
> La date d'effet de la contrepassation qui a remis les fonds sur le solde —
> `null` s'ils ne l'ont jamais quitté ou ne sont pas encore revenus. Renseigné uniquement une fois le
> retour confirmé dans le grand livre ; l'écriture comptable elle-même peut intervenir quelques instants
> après cette date.
>
> **message** `string | null` *required*
>
> Explication lisible de l'échec. Les appelants disposant de `payout:destination:read` peuvent recevoir un texte personnalisé selon la destination ; les autres appelants reçoivent le message générique du catalogue.

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

Les frais facturés pour le versement, dans la devise du versement, sous forme de chaîne décimale.

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

Qui a supporté les frais de versement : le compte lui-même ou sa plateforme parente.

Options disponibles : `self`, `platform`

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

La majoration de Whop sur les frais du prestataire, dans la devise du versement, sous forme de chaîne
décimale. `"0.0"` lorsqu'aucune ne s'applique.

**metadata** `object` *required*

Données clé-valeur associées lors de la création et renvoyées à chaque lecture. 50 clés au maximum,
noms de clés jusqu'à 40 caractères, valeurs de chaîne jusqu'à 500 caractères.

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

Le montant net prévu pour la destination, dans la devise du versement : amount moins
fee\_amount moins markup\_fee lorsque fee\_paid\_by vaut `self` ; égal à amount lorsque
la plateforme prend en charge les frais. Un versement qui se termine refusé, annulé ou échoué
n'a rien livré — la plupart conservent le montant prévu et `failure` indique où se trouvent les
fonds, mais un versement annulé financé par une demande de conversion peut à la place indiquer le
résultat réglé : `amount` contient ce qui est resté sur le solde, les frais sont
nuls car aucun n'a été facturé, et `net_amount` vaut 0 car rien n'a été
livré.

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

Notes libres ajoutées par le créateur du versement, ou `null` lorsqu'aucune n'a été
fournie. 255 caractères maximum.

**object** `string` *required*

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

Nom de l'entité qui traite le versement.

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

Le moyen de versement enregistré utilisé. Nécessite payout:destination:read ; null sans celui-ci.

> [accordion] Propriétés
>
> **nickname** `string | null` *required*
>
> Surnom du moyen de versement enregistré.
>
> **supported\_payout\_method** `object | null` *required*
>
> Détails d'affichage du moyen de versement pris en charge.
>
> > [accordion] Propriétés
> >
> > **delivery\_type** `string` *required*
> >
> > La manière dont les fonds sont livrés au destinataire.
> >
> > Options disponibles : `cash_pickup`, `bank_deposit`, `home_delivery`, `mobile_wallet`, `card`, `check`, `bill`, `cryptocurrency`, `unknown`
> >
> > **icon\_url** `string | null` *required*
> >
> > URL de l'icône du moyen de versement pris en charge.
> >
> > **payer\_name** `string | null` *required*
> >
> > Nom d'affichage du moyen de versement pris en charge.
>
> **type** `string` *required*
>
> Le type de moyen de versement utilisé par le versement. `external` a envoyé les fonds hors de Whop. `whop_card` a transféré les fonds sur la propre Whop Card du compte.
>
> Options disponibles : `external`, `whop_card`

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

ID de la demande de versement, préfixé par `cofr_`, renvoyé par `POST /payouts`. Associez-le au
versement réglé dans `GET /payouts`. Renvoie `null` pour les versements non créés
par `POST /payouts`.

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

La manière dont le versement a été créé. `automatic` désigne un versement automatique programmé. `null` lorsque le versement n'a pas de source enregistrée.

Options disponibles : `api`, `dashboard`, `automatic`

**speed** `string` *required*

Vitesse de livraison du versement.

Options disponibles : `standard`, `instant`

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

Le libellé de paiement envoyé avec le versement, ou `null` si aucun libellé n'a été
défini. Lorsqu'il est défini, 5 à 80 caractères ASCII imprimables.

**status** `string` *required*

Statut actuel du versement.

Options disponibles : `requested`, `in_review`, `processing`, `completed`, `reversed`, `canceled`, `failed`, `denied`

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

La phase machine la plus fine sous `status` — par exemple
`awaiting_provider_acceptance` ou `in_transit` sous `processing`, ou la
phase de conversion sous `requested`. Vocabulaire informatif : des valeurs peuvent être
ajoutées sans changement de version ; `status` est le contrat versionné.

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

Référence du réseau de paiement pour ce versement, comme un numéro de trace ACH, un ID de bout en bout RTP
ou FedNow, un IMAD de virement ou un UETR SWIFT. `null` tant que la
référence n'est pas disponible, et sur les versements qui n'en ont pas.

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

- [Payout created](https://docs.whop.com/fr/api-reference/payouts/payout-created.md)
- [Payout reversed](https://docs.whop.com/fr/api-reference/payouts/payout-reversed.md)
- [Payout updated](https://docs.whop.com/fr/api-reference/payouts/payout-updated.md)
