> ## 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 Whop Partners

> Recomienda negocios a Whop y gana con su actividad, con un enlace de referido y ganancias que puedes consultar desde la API.

Ganas mientras dure el referido, a partir de cuatro fuentes de ingresos distintas. Una sola llamada te inscribe y devuelve tu enlace. Todo lo demás informa de lo que has referido y de lo que has ganado.

## Qué puedes crear

* **Un programa de referidos que gestionas tú mismo**, compartiendo tu propio enlace con tu propia audiencia.
* **Informes sobre lo que has referido**: qué negocios y usuarios siguen activos y qué genera cada uno.
* **Extractos de ganancias** desglosados hasta la transacción y la tasa que hay detrás de cada línea.
* **Una página pública de clasificación** a partir de la clasificación de partners.

## Objetos principales

Partner, negocio referido, ganancia de partner. Cada uno se define en [Conceptos principales](https://docs.whop.com/es/developer/concepts.md).

## Inscripción

[`POST /partners`](https://docs.whop.com/es/api-reference/partners/enroll-as-a-whop-partner) inscribe al usuario que hace la llamada y hace que sus negocios de partner puedan generar ganancias. Devuelve `referral_link`, la URL que compartes para que se te atribuyan los referidos, y `whop_partner_enabled_at`. Volver a inscribirse conserva la fecha de inscripción original en lugar de restablecerla, lo que hace que la llamada sea segura de repetir.

Requiere el permiso `partner:create`. Consultar referidos y ganancias requiere `partner:basic:read`, y listar negocios referidos también acepta `referral:basic:read`. Consulta [Permisos](https://docs.whop.com/es/developer/guides/permissions.md).

## Por qué ganas

`payout_percentages` en un negocio referido indica tu tasa por fuente de ingresos como fracción, así que `0.3` significa 30 %. Tres de las cuatro son una parte del beneficio bruto de Whop. El gasto en publicidad es la excepción: es una parte del propio gasto.

| `income_source` | Tu parte corresponde a |
| - | - |
| `sales` | El beneficio de Whop sobre las ventas de productos del negocio |
| `ad_spend` | El gasto del negocio en Whop Ads |
| `transfer` | El beneficio de Whop por las transferencias de saldo de la plataforma |
| `card_interchange` | El beneficio de Whop por el intercambio de tarjetas |

En un negocio cerrado para un negocio de partner, esa tasa pertenece al equipo. [`GET /partners/businesses/:id`](https://docs.whop.com/es/api-reference/partners/retrieve-a-referred-business) también devuelve `my_payout_percentages`, tu propia parte de cada tasa. Es la tasa completa cuando referiste el negocio tú mismo. En un acuerdo de un negocio de partner, es tu parte de equipo de la tasa. Un responsable gana su parte menos la parte de la persona que tiene por debajo, y un participante del acuerdo gana su parte. Es `null` cuando no ganas nada con el negocio.

[`GET /partners/businesses`](https://docs.whop.com/es/api-reference/partners/list-referred-businesses) lista todo lo que has referido, del más reciente al más antiguo. Cada negocio de partner incluye un ID `coma_`, un `status` de `active` o `removed`, y `referral_started_at` y `referral_expires_at`.

`earnings_usd` y `volume_usd` son objetos, no números individuales. `earnings_usd` se desglosa en `completed`, `pending` y `total`. `volume_usd` se desglosa en `attributed`, `awaiting_settlement` y `settled`.

## Consultar las ganancias

[`GET /partners/businesses/{id}/earnings`](https://docs.whop.com/es/api-reference/partners/list-referred-business-earnings) desglosa lo que Whop te paga por un negocio. Cada ganancia indica su `income_source`, el `transaction_amount_usd` del que procede y tu `payout_percentage`.

Las ganancias se liquidan antes de pagarse. Tanto `commission_amount_usd` como `payout_percentage` son `null` hasta entonces.

| `status` | Significado |
| - | - |
| `awaiting_settlement` | La transacción subyacente aún no se ha liquidado |
| `pending` | Liquidada, aún no pagada |
| `completed` | Pagada |
| `canceled` | Anulada antes del pago, con `cancelation_reason` |
| `reversed` | Recuperada a posteriori, con `cancelation_reason` |

Cuando existen los datos, `financial_activity` desglosa las líneas de ingresos y costes que hay detrás de la comisión. Es `null` para las ganancias que se liquidaron antes de que Whop registrara ese detalle.

## La clasificación

[`GET /partners/leaderboard`](https://docs.whop.com/es/api-reference/partners/retrieve-the-leaderboard) clasifica a los referidores según sus ganancias de partner. El parámetro `period` acepta `day`, `month`, `year`, `last_30_days` o `all_time`, y su valor predeterminado es `all_time`.

La autenticación es opcional. Quienes llaman de forma anónima obtienen la clasificación en `leaders`, y quienes están autenticados también obtienen su propia posición en `me`, que es `null` cuando aún no tienes ganancias por referidos.

## Próximos pasos

> [card] [Inscribirse como partner](https://docs.whop.com/es/api-reference/partners/enroll-as-a-whop-partner.md)
>
> Una sola llamada para unirte y obtener tu enlace de referido.

> [card] [Listar tus referidos](https://docs.whop.com/es/api-reference/partners/list-referred-businesses.md)
>
> Todos los negocios que has incorporado, con sus ganancias.

> [card] [Afiliados](https://docs.whop.com/es/developer/guides/affiliates.md)
>
> Seguimiento de referidos dentro de tus propios productos.

> [card] [Referencia de Partners](https://docs.whop.com/es/api-reference/partners/partner)
>
> Todos los endpoints de partners, con un playground.


## Related topics

- [API de Partners](https://docs.whop.com/es/api-reference/partners/partner.md)
- [Descripción general de la API de Whop](https://docs.whop.com/es/api-reference/overview.md)
- [Conceptos principales de la API de Whop](https://docs.whop.com/es/developer/concepts.md)
