Skip to main content
Para dar de alta una subcuenta en tu plataforma, crea un objeto Account para ella bajo la cuenta de tu plataforma. Esa cuenta podrá entonces aceptar cargos directos, recibir transferencias y usar los flujos de pagos salientes de Whop.

Ejemplo

Crea una cuenta para la subcuenta:
En este ejemplo:
  • email es la dirección de correo electrónico de la subcuenta. Whop la usa para identificar la subcuenta y enviar notificaciones importantes.
  • La clave de API de la cuenta determina qué cuenta de plataforma es propietaria de la subcuenta.
  • title es el nombre visible obligatorio de la subcuenta.
  • external_id es el ID propio de tu plataforma para esta subcuenta, por ejemplo el ID de tu tienda. Cada ID corresponde a una subcuenta, y puedes buscar la cuenta por él más adelante.
  • metadata contiene pares clave-valor personalizados, como seller_tier, una clasificación o nivel para la subcuenta (p. ej., “bronze”, “silver” o “gold”).
  • La respuesta incluye un account.id que puedes usar para hacer referencia a esta subcuenta en futuras llamadas a la API
La dirección de correo electrónico debe pertenecer a la subcuenta (negocio o persona física) que gestionará la cuenta. Esta persona recibirá las notificaciones de configuración de la cuenta y de pagos.

Buscar una subcuenta por tu ID

Lista tus subcuentas con external_id para obtener la cuenta correspondiente a uno de tus registros. Termina el valor con % para obtener todas las cuentas cuyo ID empieza por un espacio de nombres que hayas elegido, como shopline:%. La coincidencia distingue entre mayúsculas y minúsculas, _ coincide de forma literal y % solo funciona al final, así que los ID que crees no pueden contenerlo.
TypeScript
Update Account establece o borra external_id en una subcuenta existente. Solo tu plataforma puede cambiarlo. La subcuenta puede leerlo, pero no editarlo.

Reutilizar una dirección de correo electrónico

Varias subcuentas pueden compartir una dirección de correo electrónico, siempre que cada una tenga un external_id distinto. La creación de una cuenta es idempotente respecto al par de correo electrónico y external_id:
  • external_id nuevo: Whop crea una subcuenta nueva, aunque el correo electrónico ya esté en uso.
  • Mismo correo electrónico y external_id: Whop devuelve la subcuenta existente en lugar de crear un duplicado, así que los reintentos son seguros.
  • external_id ya usado con otro correo electrónico: Whop devuelve un 409 en lugar de crear una segunda cuenta con ese ID. Para mover el ID a la cuenta nueva en la misma solicitud, consulta Sustituir la cuenta asociada a un ID.
  • Sin external_id: Whop devuelve la subcuenta existente para ese correo electrónico que no tiene external_id, si la hay.
Las cuentas que comparten un correo electrónico las gestiona el mismo usuario de Whop: la persona que recibe esa bandeja de entrada.
Las versiones anteriores de esta guía ponían external_id dentro de metadata. Whop sigue aceptándolo ahí en todas las versiones de la API, establece external_id a partir de él y lo devuelve en metadata. Sigue las mismas reglas que el campo de nivel superior, incluido el 409 cuando otra subcuenta ya lo tiene, así que envía reassign_external_id: true para reutilizar uno. Cambiar metadata.external_id más adelante no cambia external_id. Para cambiarlo, usa Update Account. Las integraciones nuevas deben enviar el campo de nivel superior.

Sustituir la cuenta asociada a un ID

Cuando vuelves a emitir una cuenta por tu parte, por ejemplo una tienda que pasa a un nuevo propietario, crea la nueva subcuenta con el mismo external_id y reassign_external_id: true. Whop mueve el ID a la nueva subcuenta en la misma solicitud en lugar de devolver un 409.
TypeScript
  • La subcuenta que tenía el ID no se elimina ni se modifica de ninguna otra forma. Sigue activa con external_id establecido en null, conserva su metadata y su saldo, y envía un webhook account.updated. Elimínala tú mismo si ya no la necesitas.
  • Si la creación falla, el ID se queda donde estaba.
  • La solicitud necesita el permiso company:update en la cuenta de tu plataforma además de company:create_child, porque modifica una subcuenta existente.
  • Una solicitud con el mismo correo electrónico y external_id que una subcuenta existente devuelve esa subcuenta, aunque establezca el indicador.
  • El ID solo se mueve entre tus propias subcuentas.
Para mover un ID entre dos subcuentas que ya existen, llama a Update Account dos veces: borra external_id en la antigua y luego establécelo en la otra. Update Account no tiene reassign_external_id, y establecer el ID antes de borrarlo devuelve un 409.

Completar la incorporación

Si el destinatario aún no tiene una cuenta de Whop, envíale un enlace de incorporación de cuenta después de crear la cuenta. Completa la verificación Know Your Customer (KYC) a través de ese enlace y, a partir de ahí, la cuenta puede recibir transferencias y otros flujos de pagos salientes.
Una vez que el destinatario completa la incorporación, puedes:
  • crear flujos de checkout para él con comisiones de aplicación.
  • transferir fondos al saldo de su cuenta.
  • permitirle retirar fondos con el portal de pagos salientes.

Primeros pasos

Antes de poder dar de alta subcuentas, debes configurar la cuenta de tu plataforma:
  1. Regístrate para obtener una cuenta de plataforma: crea una cuenta en whop.com/dashboard
  2. Genera una clave de API de cuenta: ve a la página de configuración de desarrollador y genera una clave de API de cuenta
  3. Usa la clave de API para la autenticación: esta clave de API es la forma de autenticarte con la API actual y controlar tus subcuentas
La clave de API de cuenta proporciona los permisos necesarios para crear y gestionar subcuentas bajo la cuenta de tu plataforma.

Metadatos personalizados

Puedes adjuntar metadatos personalizados a las cuentas al crearlas. Los metadatos te permiten almacenar información adicional sobre cada subcuenta como pares clave-valor. Esto es útil para:
  • Hacer seguimiento de los niveles o clasificaciones de las subcuentas
  • Vincular con los registros de la base de datos de tu plataforma
Whop almacena los metadatos en el objeto Account y los devuelve en cada lectura, pero no puedes filtrar cuentas por ellos. Pon en external_id el identificador por el que buscas las cuentas.

Referencia de la API

API Create Account

Consulta la referencia completa de la API para crear cuentas y todos los parámetros disponibles

Próximos pasos

Después de crear una cuenta para una subcuenta:

Cobrar y repartir pagos

Elige entre cargos directos y transferencias

Renderizar el portal de pagos salientes

Permite que las subcuentas retiren sus fondos