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

> Los Payouts representan dinero enviado desde el saldo de una cuenta o de un usuario a un destino externo, como una cuenta bancaria, una billetera u otro método de retiro guardado.

Usa la API de Payouts para crear y seguir retiros, gestionar métodos de retiro guardados y mostrar los detalles de llegada previstos para los fondos que salen de Whop.

## Endpoints

| Endpoint | Solicitud |
| - | - |
| [Listar retiros](https://docs.whop.com/es/api-reference/payouts/list-payouts.md) | GET `/payouts` |
| [Recuperar retiro](https://docs.whop.com/es/api-reference/payouts/retrieve-payout.md) | GET `/payouts/{id}` |
| [Listar métodos de retiro guardados](https://docs.whop.com/es/api-reference/payouts/list-saved-payout-methods.md) | GET `/payouts/methods` |
| [Listar métodos de retiro compatibles](https://docs.whop.com/es/api-reference/payouts/list-supported-payout-methods.md) | GET `/payouts/supported_methods` |
| [Crear retiro](https://docs.whop.com/es/api-reference/payouts/create-payout.md) | POST `/payouts` |
| [Cancelar retiro](https://docs.whop.com/es/api-reference/payouts/cancel-payout.md) | POST `/payouts/{id}/cancel` |
| [Crear método de retiro guardado](https://docs.whop.com/es/api-reference/payouts/create-saved-payout-method.md) | POST `/payouts/methods` |
| [Crear sesión de vinculación de PayPal](https://docs.whop.com/es/api-reference/payouts/create-paypal-link-session.md) | POST `/payouts/paypal_link_sessions` |
| [Crear cotización de retiro](https://docs.whop.com/es/api-reference/payouts/create-payout-quote.md) | POST `/payouts/quotes` |
| [Actualizar método de retiro guardado](https://docs.whop.com/es/api-reference/payouts/update-saved-payout-method.md) | PATCH `/payouts/methods/{id}` |
| [Eliminar método de retiro guardado](https://docs.whop.com/es/api-reference/payouts/delete-saved-payout-method.md) | DELETE `/payouts/methods/{id}` |

## Atributos

**id** `string` *required*

ID del retiro, con el prefijo `wdrl_`.

**amount** `string` *required*

El importe del retiro en unidades enteras de moneda, como cadena decimal.

**cancelable** `boolean` *required*

Si `POST /payouts/\{id}/cancel` actuaría sobre este retiro en este momento: `true` mientras esté `in_review`, mientras esté `processing` sin nada enviado aún al proveedor de retiros, o mientras aún se pueda pedir al proveedor que cancele un retiro enviado. `false` una vez que el dinero ha llegado o el retiro ya ha terminado.

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

Cómo se convirtió el saldo a la moneda del retiro antes de enviarlo. `null` cuando el retiro se envió desde un saldo en su propia moneda.

> [accordion] Propiedades
>
> **from\_amount** `string` *required*
>
> El importe que la conversión tomó del saldo, como cadena decimal.
>
> **from\_currency** `string` *required*
>
> La moneda del saldo del que la conversión tomó el importe.
>
> **rate** `number` *required*
>
> La tasa de conversión, en unidades de la moneda del retiro por cada unidad de `from_currency`. Cualquier cargo por conversión está incluido en esta tasa.

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

Cuándo se creó el retiro.

**currency** `string` *required*

Moneda del retiro.

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

El importe entregado en la moneda de destino, como cadena decimal. Se asigna cuando se procesa el retiro, por lo que es `null` antes de ese momento y en los retiros sin una conversión registrada.

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

Moneda en la que se entregan los fondos, tomada del método de retiro al crear el retiro. En un retiro financiado mediante una solicitud de conversión, sigue al retiro de liquidación generado junto a él (la fila de `GET /payouts` que lleva el id de este retiro como `payout_request_id`) y solo es `null` cuando no existe ningún retiro de liquidación.

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

Hora estimada en la que los fondos estarán disponibles en la cuenta de destino.

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

Tipo de cambio de la moneda del retiro a la moneda de destino. Se asigna cuando se procesa el retiro, por lo que es `null` antes de ese momento y en los retiros sin una tasa registrada.

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

Por qué terminó el retiro sin pagarse, o por qué se revirtió tras la liquidación. Presente en retiros fallidos, cancelados, denegados y revertidos; `null` en caso contrario.

> [accordion] Propiedades
>
> **code** `string | null` *required*
>
> Código de error clasificado del catálogo de errores mantenido.
>
> **funds\_returned\_at** `string | null` *required*
>
> La hora efectiva de la reversión que devolvió los fondos al saldo; `null` si nunca salieron de él o aún no han vuelto. Solo se establece una vez confirmada la devolución en el libro contable; el asiento contable en sí puede registrarse unos momentos después de esta hora.
>
> **message** `string | null` *required*
>
> Explicación legible del fallo. Quienes tienen `payout:destination:read` pueden recibir un texto personalizado para el destino; los demás reciben el mensaje genérico del catálogo.

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

La comisión cobrada por el retiro, en la moneda del retiro, como cadena decimal.

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

Quién asumió la comisión del retiro: la propia cuenta o su plataforma principal.

Opciones disponibles: `self`, `platform`

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

El margen de Whop sobre la comisión del proveedor, en la moneda del retiro, como cadena decimal. `"0.0"` cuando no se aplica ninguno.

**metadata** `object` *required*

Datos clave-valor adjuntados al crear y devueltos en cada lectura. Como máximo 50 claves, nombres de clave de hasta 40 caracteres y valores de cadena de hasta 500 caracteres.

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

El neto previsto para el destino, en la moneda del retiro: amount menos fee\_amount menos markup\_fee cuando fee\_paid\_by es `self`; igual a amount cuando la plataforma cubre las comisiones. Un retiro que termina denegado, cancelado o fallido no entregó nada: la mayoría conservan la cifra prevista y `failure` indica dónde están los fondos, pero un retiro cancelado financiado mediante una solicitud de conversión puede informar en su lugar del resultado liquidado: `amount` lleva lo que permaneció en el saldo, las comisiones son cero porque no se cobró ninguna y `net_amount` es 0 porque no se entregó nada.

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

Notas libres adjuntadas por quien creó el retiro, o `null` cuando no se proporcionó ninguna. Máximo 255 caracteres.

**object** `string` *required*

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

Nombre de la entidad que procesa el retiro.

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

El método de retiro guardado utilizado. Requiere payout:destination:read; null sin él.

> [accordion] Propiedades
>
> **nickname** `string | null` *required*
>
> Alias del método de retiro guardado.
>
> **supported\_payout\_method** `object | null` *required*
>
> Detalles de visualización del método de retiro compatible.
>
> > [accordion] Propiedades
> >
> > **delivery\_type** `string` *required*
> >
> > Cómo se entregan los fondos al destinatario.
> >
> > Opciones disponibles: `cash_pickup`, `bank_deposit`, `home_delivery`, `mobile_wallet`, `card`, `check`, `bill`, `cryptocurrency`, `unknown`
> >
> > **icon\_url** `string | null` *required*
> >
> > URL del icono del método de retiro compatible.
> >
> > **payer\_name** `string | null` *required*
> >
> > Nombre visible del método de retiro compatible.
>
> **type** `string` *required*
>
> El tipo de método de retiro que usó el retiro. `external` envió los fondos fuera de Whop. `whop_card` movió los fondos a la propia Whop Card de la cuenta.
>
> Opciones disponibles: `external`, `whop_card`

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

ID de la solicitud de retiro, con el prefijo `cofr_`, devuelto por `POST /payouts`. Relaciónalo con el retiro liquidado en `GET /payouts`. Devuelve `null` para los retiros no creados con `POST /payouts`.

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

Cómo se creó el retiro. `automatic` indica un retiro automático programado. `null` cuando el retiro no tiene un origen registrado.

Opciones disponibles: `api`, `dashboard`, `automatic`

**speed** `string` *required*

Velocidad de entrega del retiro.

Opciones disponibles: `standard`, `instant`

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

La descripción del pago enviada con el retiro, o `null` si no se estableció ningún descriptor. Cuando se establece, de 5 a 80 caracteres ASCII imprimibles.

**status** `string` *required*

Estado actual del retiro.

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

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

La fase más detallada de la máquina dentro de `status`; por ejemplo, `awaiting_provider_acceptance` frente a `in_transit` dentro de `processing`, o la fase de conversión dentro de `requested`. Vocabulario informativo: se pueden añadir valores sin cambiar de versión; `status` es el contrato versionado.

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

Referencia de la red de pagos para este retiro, como un número de rastreo ACH, un ID de extremo a extremo de RTP o FedNow, un IMAD de transferencia bancaria o un UETR de SWIFT. `null` hasta que la referencia esté disponible, y en los retiros que no tienen ninguna.

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

- [Versiones de la API](https://docs.whop.com/es/developer/api/versioning.md)
- [Estabilidad de la API](https://docs.whop.com/es/api-reference/stability.md)
- [API de Accounts](https://docs.whop.com/es/api-reference/accounts/account.md)
