Skip to main content
Usa las cuentas para los clientes, creadores, comerciantes, vendedores o negocios conectados que admita tu integración. Usa la API de Accounts para crear cuentas, listar las cuentas visibles para tus credenciales, recuperar o actualizar una cuenta, suspender o eliminar una subcuenta gestionada por tu plataforma y recuperar la cuenta asociada a la clave de API actual. Los campos business_type, industry_group e industry_type clasifican las cuentas. Consulta el glosario de tipos de negocio e industrias para ver todos los valores válidos.

Endpoints

Recargos de comisiones

Los recargos de comisiones permiten a una plataforma añadir cargos o subvencionar las comisiones de pago de sus subcuentas. Gestiónalos a través del documento de comisiones de la cuenta: define valores predeterminados en la cuenta de plataforma o anula comisiones individuales en una subcuenta. Consulta Recargos y subvenciones de comisiones para ver ejemplos, límites y requisitos de financiación.

Endpoints de comisiones

Usa la clave de API de la cuenta de plataforma con el permiso company:update_child_fees para configurar los recargos. Cada recargo devuelto incluye adjustable y unadjustable_reason para que tu integración pueda determinar si se puede editar.

Leer las comisiones

La sección markups contiene las tasas efectivas de la subcuenta. La sección child_markups de una cuenta de plataforma contiene sus valores predeterminados para las subcuentas. El source de un recargo es custom cuando se ha configurado en ese nivel, o default cuando recurre a una tasa heredada o a cero. Su campo default muestra la tasa que se aplicaría si se borrara el recargo personalizado. Los importes fijos devueltos usan el objeto Money; las actualizaciones aceptan fixed como un número en dólares estadounidenses.

Definir los valores predeterminados de la plataforma

Actualiza child_markups en la cuenta de plataforma. Este ejemplo define un recargo de pago del 2 % sin cargo fijo:
percentage: 2 significa 2 %. Los valores predeterminados se aplican a las subcuentas que no tienen una anulación para esa comisión. Los recargos de pago se aplican cuando no se ha definido ninguna comisión de aplicación en el checkout.

Definir una anulación para una subcuenta

Actualiza markups en la subcuenta. Este ejemplo sustituye su recargo de pago heredado por un 1 % más 0,25 $:
Solo cambian las claves que envías. Para otros tipos de transacciones, usa transfers, crypto_swaps, deposits indexado por vía de pago, o payouts indexado por método de pago. Consulta el endpoint de actualización para ver las claves admitidas y el esquema de la solicitud.

Borrar un recargo

Envía null para el recargo para borrarlo. Borrar la anulación de una subcuenta restaura el valor predeterminado de su plataforma, o cero si no hay ningún valor predeterminado configurado:
Para borrar un valor predeterminado de la plataforma, envía child_markups: { payments: null } a la cuenta de plataforma. Un { percentage: 0, fixed: 0 } explícito sigue siendo una tasa configurada; usa null para restaurar la herencia. Una cuenta publica sus documentos legales como archivos PDF: terms_of_service, privacy_policy, return_policy, cancellation_policy, shipping_policy y eula. Cada uno se lee como un File y se define mediante Update Account con el id de un archivo que hayas subido. Las nuevas disputas toman de forma predeterminada las pruebas de sus políticas de estos documentos. El espacio de la política de cancelación usa cancellation_policy, después terms_of_service y después return_policy. El espacio de la política de reembolso usa return_policy y después terms_of_service. Cualquiera de los dos espacios recurre a la política de la plataforma Whop cuando no hay ninguno definido, y shipping_policy se incluye en las disputas de bienes físicos. Defínelos una vez aquí y usa Upload Dispute Evidence solo cuando una disputa necesite una versión distinta de una política.
Envía null para un documento para eliminarlo. Solo se aceptan archivos PDF.

Atributos

string
requerido
ID de la cuenta, con el prefijo biz_.
number | null
requerido
Gasto publicitario cobrado durante toda la vida de la cuenta, en USD. Solo se calcula en list para quienes llaman con stats:read en la cuenta; null en caso contrario.
object[]
requerido
Activos de la cuenta, cada uno con su valor en USD. Vacío cuando total_usd es null.

Propiedades

string
requerido
Importe total mantenido en unidades nativas, como cadena decimal.
object
requerido
Saldo dividido en importes disponibles, pendientes y en reserva, como cadenas decimales en unidades nativas, con los días en que se espera que se liquide el importe pendiente.

Propiedades

string
requerido
Importe que puedes gastar, enviar o retirar ahora, en unidades nativas, como cadena decimal.
string
requerido
La parte de pending que ya se ha liquidado y está esperando para pasar a la billetera de criptomonedas o a la Whop Card de la cuenta, donde pasa a ser available. El movimiento suele empezar en menos de una hora; mientras se ejecuta, el importe se informa en in_transit. No se incluye el dinero movido solo para recargar el saldo mínimo retenido de la cuenta. En unidades nativas, como cadena decimal.
string
requerido
Importe que se mueve entre los propios destinos de la cuenta, como una recarga de tarjeta. En unidades nativas, como cadena decimal.
string
requerido
Importe de pagos recientes que aún se están liquidando, en unidades nativas, como cadena decimal.
object[]
requerido
Cuándo se espera que se liquide el importe pendiente, una entrada por día, empezando por la más temprana. El dinero sin un día de liquidación programado, incluido finishing_settlement, queda fuera, por lo que estas entradas más finishing_settlement pueden sumar menos que pending, nunca más.

Propiedades

string
requerido
Importe esperado ese día, en unidades nativas, como cadena decimal.
string
requerido
El día en que se espera que este dinero termine de liquidarse, como fecha ISO 8601.
string
requerido
Importe retenido, en unidades nativas, como cadena decimal. Recupera las reservas de la cuenta para saber por qué se retiene y cuándo se libera.
string | null
requerido
URL del icono del activo.
string
requerido
El nombre visible del activo
number | null
requerido
Precio en USD por unidad, o null cuando no hay ningún tipo de cambio disponible.
string
requerido
Símbolo visible del activo, como USDT, cbBTC o EUR.
string | null
requerido
Valor en USD del activo, o null cuando no hay ningún tipo de cambio disponible.
string | null
requerido
URL de la imagen de banner de la cuenta.
object | null
requerido
Dirección comercial de la cuenta usada para calcular impuestos, con line1, line2, city, state, postal_code y country. null cuando no hay ninguna dirección definida.
string | null
requerido
La razón social de la cuenta usada con su dirección fiscal.
string | null
requerido
Categoría de negocio general de la cuenta. Consulta el glosario de tipos de negocio e industrias para ver los valores válidos.
boolean
requerido
Si los fondos pendientes pueden transferirse desde esta cuenta de plataforma a sus subcuentas.
object | null
requerido
El documento de política de cancelación de la cuenta, o null si no ha publicado ninguno.

Propiedades

string
requerido
El ID del archivo, con el prefijo file_.
string | null
requerido
Marcador de posición BlurHash para una imagen o un vídeo. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El tipo MIME del archivo original, por ejemplo application/pdf. Se conserva cuando la moderación elimina el archivo.
string
requerido
Cuándo se creó el archivo, como marca de tiempo ISO 8601.
number | null
requerido
Duración del audio o del vídeo en segundos. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El nombre de archivo original, incluida su extensión.
integer | null
requerido
Altura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
El tamaño en bytes que debe tener cada parte (excepto la última). Solo está presente al crear, y solo para cargas multiparte.
string | null
El ID de la carga multiparte, que se devuelve a complete. Solo está presente al crear, y solo para cargas multiparte.
object[] | null
La URL prefirmada de cada parte. Solo está presente al crear, y solo para cargas multiparte.

Propiedades

integer
requerido
El índice, empezando por 1, de esta parte dentro de la carga multiparte.
string
requerido
La URL prefirmada a la que enviar con PUT los bytes de esta parte.
string
requerido
El tipo de este objeto, siempre file.
boolean
requerido
Si la moderación eliminó el archivo. Cuando es true, url sirve una imagen de sustitución. filename, size y content_type siguen describiendo el archivo original.
integer | null
requerido
El tamaño del archivo en bytes. null hasta que la carga haya terminado.
object
Cabeceras que se deben enviar con el PUT de la carga. Solo está presente al crear.
string
requerido
En qué punto del ciclo de vida de la carga se encuentra el archivo.Opciones disponibles: pending, processing, ready, failed
string | null
URL prefirmada a la que enviar con PUT los bytes del archivo. Solo está presente al crear, y solo para cargas de una sola parte.
string | null
requerido
Una URL para descargar el archivo. Los archivos públicos obtienen una URL de CDN permanente y los archivos privados obtienen una URL firmada que caduca. null hasta que la carga haya terminado. Cuando la moderación elimina el archivo, una URL de imagen de sustitución.
string
requerido
Los archivos public se sirven desde una URL de CDN sin firmar. Los archivos private se sirven desde una URL firmada que caduca.Opciones disponibles: public, private
string | null
requerido
URL de la forma de onda del audio. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
requerido
Anchura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
object | null
requerido
Vías de pago habilitadas para esta cuenta, cada una active, inactive o pending (incorporación o revisión en curso). Solo se calcula en retrieve y me para quienes llaman con el alcance company:balance:read; null en caso contrario.

Propiedades

string
requerido
Cobros bancarios: débitos, transferencias y vías bancarias localesOpciones disponibles: active, inactive, pending
string
requerido
Cobros de compra ahora y paga después; requiere aprobaciónOpciones disponibles: active, inactive, pending
string
requerido
Cobros con tarjeta, incluidos Apple Pay y Google PayOpciones disponibles: active, inactive, pending
string
requerido
Depósitos por transferencia bancaria o ACH a la cuenta bancaria virtual de la cuentaOpciones disponibles: active, inactive, pending
string
requerido
Recargas de saldo cobrando a un método de pago almacenadoOpciones disponibles: active, inactive, pending
string
requerido
Emisión de tarjetas Whop; requiere la aprobación de la solicitud de tarjetaOpciones disponibles: active, inactive, pending
string
requerido
Depósitos on-chain a la billetera de criptomonedas de la cuentaOpciones disponibles: active, inactive, pending
string
requerido
Pagos on-chain a una billetera de criptomonedasOpciones disponibles: active, inactive, pending
string
requerido
Pagos instantáneos a un destino de pago aptoOpciones disponibles: active, inactive, pending
string
requerido
Lanzamiento de campañas publicitarias a través de Whop Ads. inactive hasta que se verifique la identidad o el negocio de la cuenta, mientras un acuerdo de servicios publicitarios solicitado esté pendiente de la firma de la cuenta y mientras la cuenta esté suspendida de Whop Ads.Opciones disponibles: active, inactive, pending
string
requerido
Pagos estándar a un destino de pago externoOpciones disponibles: active, inactive, pending
string
requerido
Transferencias a otras cuentasOpciones disponibles: active, inactive, pending
object | null
requerido
Detalles de la solicitud de Whop Cards de la cuenta. Se devuelve en list, retrieve y me para quienes llaman con el alcance company:balance:read; null en caso contrario, o cuando la cuenta no tiene ninguna solicitud de tarjeta ni ninguna revisión de solicitud bloqueante.

Propiedades

string | null
requerido
Motivo por el que el emisor de la tarjeta rechazó la solicitud. unsupported_state sustituye a unsupported_region para una persona o un negocio verificado en Estados Unidos. compliance abarca las comprobaciones de sanciones, personas expuestas políticamente y medios adversos. other abarca los motivos que no están en esta lista. null cuando status no es denied, o cuando el emisor no rechazó la solicitud.Opciones disponibles: compromised_identity, duplicate, unsupported_region, compliance, fraud, verification_failed, unsupported_state, other
string | null
requerido
Si la solicitud de tarjeta verifica un negocio (business, KYB) o una persona (individual, identidad del consumidor). null cuando la solicitud aún no está vinculada a una verificación.Opciones disponibles: individual, business
string
requerido
En qué estado se encuentra la solicitud de tarjeta. approved significa que se pueden emitir tarjetas. needs_verification significa que el solicitante aún no ha completado la verificación de identidad; needs_information significa que sí lo hizo, pero los documentos se rechazaron por un motivo subsanable y deben volver a enviarse. pending y manual_review están en curso. denied, locked y canceled son definitivos.Opciones disponibles: approved, pending, manual_review, denied, locked, canceled, needs_verification, needs_information
boolean
requerido
Si el checkout muestra un campo de NIF-IVA/ID fiscal para que los compradores lo introduzcan de forma opcional. No exige un NIF-IVA para comprar.
object
requerido
Estado de constitución de la empresa de la cuenta, gestionado a través de Form Company. Un status draft hasta que se paga el checkout de constitución; después, el progreso de la presentación con documentos descargables y firmas pendientes. Vacío cuando el estado de constitución no está disponible temporalmente.

Propiedades

object[]
Documentos de constitución disponibles para descargar, como los Articles of Organization y la carta de confirmación del EIN. Presentes una vez que status deja de ser draft.

Propiedades

string
requerido
ID del documento, con el prefijo file_.
string
requerido
Nombre del documento legible para personas, como Articles of Organization.
string
requerido
Categoría del documento: articles_of_organization, operating_agreement, ein_letter, signed_ss4, signed_form8821 o mail para la correspondencia postal recibida en nombre de la empresa.
string
requerido
URL de CDN para descargar el documento.
boolean
Si el IRS ha emitido el EIN de la empresa. Presente una vez que status deja de ser draft.
Nombre registrado de la empresa, incluida la terminación de la entidad, por ejemplo Acme, LLC. Presente una vez que status deja de ser draft.
object
Formularios del IRS pendientes de la firma de un fundador, cada uno con una URL de firma alojada. Presente una vez que status deja de ser draft; vacío cuando no hay nada que firmar.

Propiedades

object
Estado de la firma del formulario 8821 del IRS, la autorización de información fiscal. Solo está presente mientras el formulario aún requiere una acción del fundador.

Propiedades

string
Cuándo caduca la URL de firma, como marca de tiempo ISO 8601. Solo está presente cuando se incluye la URL de firma.
string
requerido
pending cuando hay una sesión de firma lista para el fundador; unknown cuando no se pudo determinar el estado de la firma.Opciones disponibles: pending, unknown
string
URL de firma alojada donde el fundador completa el formulario. Presente mientras status es pending y quien llama tiene incorporation:write. Se omite en los webhooks.
object
Estado de la firma del formulario SS-4 del IRS, la solicitud del EIN. Solo está presente mientras el formulario aún requiere una acción del fundador.

Propiedades

string
Cuándo caduca la URL de firma, como marca de tiempo ISO 8601. Solo está presente cuando se incluye la URL de firma.
string
requerido
pending cuando hay una sesión de firma lista para el fundador; unknown cuando no se pudo determinar el estado de la firma.Opciones disponibles: pending, unknown
string
URL de firma alojada donde el fundador completa el formulario. Presente mientras status es pending y quien llama tiene incorporation:write. Se omite en los webhooks.
boolean
Si la presentación de constitución ante el estado está completa. Presente una vez que status deja de ser draft.
string
Opciones disponibles: draft, processing, filed, rejected, completed
string | null
requerido
País en el que se encuentra la cuenta.
string
requerido
Cuándo se creó la cuenta, como marca de tiempo ISO 8601.
integer | null
requerido
Clientes distintos con un recibo pagado en la cuenta en los últimos 30 días, actualizado cada pocas horas. Solo se calcula en retrieve para quienes llaman con stats:read en la cuenta; null en caso contrario y cuando el recuento no está disponible.
string | null
requerido
Descripción promocional de la cuenta.
integer
Cuántos miembros del equipo dependen directamente del negocio, sin ningún responsable por encima. Presente en las lecturas de una sola cuenta.
boolean
requerido
Si Whop reúne y presenta las pruebas de las disputas de esta cuenta. Activarlo suscribe a la cuenta a la comisión por éxito que se cobra en las disputas que gana.
boolean
requerido
Si Economic Intelligence está activado para la cuenta. Se desactiva automáticamente cuando termina su periodo contratado. Mientras está desactivado, la cuenta no puede activar un experimento ni ejecutar una recomendación.
string | null
requerido
Dirección de correo electrónico del propietario de la cuenta.
object | null
requerido
El documento de acuerdo de licencia de usuario final de la cuenta, o null si no ha publicado ninguno.

Propiedades

string
requerido
El ID del archivo, con el prefijo file_.
string | null
requerido
Marcador de posición BlurHash para una imagen o un vídeo. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El tipo MIME del archivo original, por ejemplo application/pdf. Se conserva cuando la moderación elimina el archivo.
string
requerido
Cuándo se creó el archivo, como marca de tiempo ISO 8601.
number | null
requerido
Duración del audio o del vídeo en segundos. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El nombre de archivo original, incluida su extensión.
integer | null
requerido
Altura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
El tamaño en bytes que debe tener cada parte (excepto la última). Solo está presente al crear, y solo para cargas multiparte.
string | null
El ID de la carga multiparte, que se devuelve a complete. Solo está presente al crear, y solo para cargas multiparte.
object[] | null
La URL prefirmada de cada parte. Solo está presente al crear, y solo para cargas multiparte.

Propiedades

integer
requerido
El índice, empezando por 1, de esta parte dentro de la carga multiparte.
string
requerido
La URL prefirmada a la que enviar con PUT los bytes de esta parte.
string
requerido
El tipo de este objeto, siempre file.
boolean
requerido
Si la moderación eliminó el archivo. Cuando es true, url sirve una imagen de sustitución. filename, size y content_type siguen describiendo el archivo original.
integer | null
requerido
El tamaño del archivo en bytes. null hasta que la carga haya terminado.
object
Cabeceras que se deben enviar con el PUT de la carga. Solo está presente al crear.
string
requerido
En qué punto del ciclo de vida de la carga se encuentra el archivo.Opciones disponibles: pending, processing, ready, failed
string | null
URL prefirmada a la que enviar con PUT los bytes del archivo. Solo está presente al crear, y solo para cargas de una sola parte.
string | null
requerido
Una URL para descargar el archivo. Los archivos públicos obtienen una URL de CDN permanente y los archivos privados obtienen una URL firmada que caduca. null hasta que la carga haya terminado. Cuando la moderación elimina el archivo, una URL de imagen de sustitución.
string
requerido
Los archivos public se sirven desde una URL de CDN sin firmar. Los archivos private se sirven desde una URL firmada que caduca.Opciones disponibles: public, private
string | null
requerido
URL de la forma de onda del audio. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
requerido
Anchura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El identificador propio de la plataforma principal para esta subcuenta, único entre las subcuentas de la plataforma. null cuando no está definido.
object | null
requerido
La solicitud de financiación más reciente de la cuenta. Solo se calcula en retrieve y me para quienes llaman con el alcance company:balance:read; null en caso contrario, o cuando la cuenta nunca ha solicitado financiación.

Propiedades

string
requerido
El ID de la solicitud de financiación más reciente de la cuenta, que empieza por inrq_. Recupérala para ver los requisitos y los comentarios de la revisión.
string
requerido
El estado de revisión de la solicitud de financiación más reciente: requires_collection (a la espera del comerciante, incluso después de una solicitud de más información), awaiting_review, approved, denied o completed. Si los métodos de pago con financiación están habilitados se indica en capabilities.accept_bnpl_payments.Opciones disponibles: requires_collection, awaiting_review, completed, approved, denied
string | null
requerido
Cuándo una cuenta suspendida puede pagar su saldo a su propio método de pago, como marca de tiempo ISO 8601. Una disputa puede retrasarlo. Se calcula en retrieve, me y suspend; null en caso contrario, cuando status no es suspended y cuando la suspensión retiene el saldo.
string[]
requerido
Preferencias de la página de inicio pública de la cuenta.Opciones disponibles: hide_member_count, hide_members_card
string | null
requerido
Vertical de industria específico de la cuenta. Consulta el glosario de tipos de negocio e industrias para ver los valores válidos.
string | null
requerido
Prefijo usado para las facturas de la cuenta.
object | null
requerido
El progreso en Whop Levels del owner de la cuenta, contabilizado en todas las cuentas que posee, por lo que todas muestran el mismo nivel. Solo se calcula en retrieve y me para quienes llaman con el alcance company:basic:read; null en caso contrario y cuando la cuenta no está en Whop Levels.

Propiedades

integer
requerido
El nivel propio de esta cuenta solo a partir de sus puntos, de 0 a 10. current es mayor cuando las otras cuentas del propietario lo elevan.
integer
requerido
El nivel que se aplica: el más alto que alcanzó el propietario este mes o en los 5 meses anteriores, de 0 a 10.
integer
requerido
Puntos obtenidos este mes en todas las cuentas que posee el propietario, más los puntos de socio del propietario, redondeados hacia abajo. Una cuenta cuyo mes da un saldo neto inferior a cero cuenta como cero.
object
requerido
Los puntos de este mes, desglosados según dónde se obtuvieron. Cada origen es neto de sus reembolsos, por lo que uno puede ser negativo.

Propiedades

integer
requerido
Puntos de los cargos pagados de Whop Ads, netos de reembolsos: 10 por cada dólar, redondeados hacia cero.
integer
requerido
Puntos del gasto capturado con Whop Card, netos de reembolsos: 10 por cada dólar, redondeados hacia cero.
integer
requerido
Puntos de las cuentas que el propietario refirió como socio: 1 por cada 3 que ganen, redondeados hacia cero.
integer
requerido
Puntos del volumen de trading de perpetuos ejecutado a través de Whop: 1 por cada dólar negociado, redondeados hacia cero.
string
requerido
Cuándo se restablecen a cero los puntos de este mes, como marca de tiempo ISO 8601.
string | null
requerido
URL de la imagen del logotipo de la cuenta.
object
requerido
Metadatos arbitrarios de clave/valor proporcionados al crear la cuenta.
string | null
requerido
Tipo de incorporación que ha completado la cuenta.Opciones disponibles: platform, seller
string | null
requerido
URL de la imagen Open Graph de la cuenta.
string | null
requerido
Variante de la imagen Open Graph de la cuenta.Opciones disponibles: white, black, orange
boolean
requerido
Si la orquestación de pagos está habilitada para esta cuenta.
string | null
requerido
Detalles del tipo de negocio cuando business_type es other.
string | null
requerido
Detalles de la industria cuando industry_type es other.
object
requerido
El único usuario propietario de la cuenta, cuyo correo electrónico es el email anterior. Es distinto del rol owner de los miembros del equipo, que puede tener cualquier número de ellos.

Propiedades

string
requerido
ID del usuario, con el prefijo user_.
string | null
requerido
Nombre visible.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no ha definido ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre está presente. Es un marcador de posición generado cuando el usuario no ha definido ninguna imagen.
string
requerido
Nombre de usuario público.
object | null
requerido
Cuenta principal de las subcuentas, o null para las cuentas independientes.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
object
Tasas de recargo que esta cuenta principal cobra a la subcuenta que se está leyendo, indexadas por tipo de comisión (por ejemplo, crypto_deposit_markup), cada una con percentage_fee y fixed_fee_usd. Se resuelven dando prioridad a las anulaciones propias de la subcuenta sobre el valor predeterminado de la plataforma.
string | null
requerido
URL de la imagen del logotipo de la cuenta.
string
requerido
Identificador de la ruta pública de la cuenta.
string
requerido
Nombre visible de la cuenta.
object | null
El socio de primer nivel activo de la cuenta. Presente en las respuestas de recuperación; null cuando no hay ningún socio de primer nivel activo atribuido a la cuenta. Se omite en otras respuestas.

Propiedades

string
requerido
ID del usuario, con el prefijo user_.
string | null
requerido
Dirección de correo electrónico para contactar con el socio. Null cuando el socio no ha añadido su propia dirección de correo electrónico.
string | null
requerido
Nombre visible.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no ha definido ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre está presente. Es un marcador de posición generado cuando el usuario no ha definido ninguna imagen.
object | null
requerido
Negocio en nombre del cual el socio refirió esta cuenta, cuando la referencia pertenece a su equipo. null para una referencia personal.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
string
requerido
Nombre visible de la cuenta.
string
requerido
Nombre de usuario público.
string | null
requerido
Cuándo el usuario se convirtió en Whop Partner verificado, como marca de tiempo ISO 8601. Null si no está verificado.
object | null
requerido
Controles de salud de pagos aplicados actualmente a la cuenta. Solo se calcula en retrieve y me para quienes llaman con el alcance company:balance:read; null en caso contrario.

Propiedades

object
requerido
Ajustes de reembolso automático para las alertas de disputa previas al contracargo.

Propiedades

boolean
requerido
Si se impide al propietario de la cuenta cambiar este umbral.
number | null
requerido
Importe máximo de alerta de disputa que se reembolsa automáticamente, en USD. null cuando los reembolsos automáticos están desactivados.
number | null
requerido
Comisión cobrada por cada alerta de disputa, en USD. null cuando no está disponible.
boolean
requerido
Si se fuerza 3-D Secure en todos los pagos con tarjeta en el checkout. La cuenta no puede omitirlo mientras esté activado.
boolean
requerido
Si los controles de salud de pagos desactivan explícitamente la financiación. Es independiente de la aprobación de financiación en capabilities.accept_bnpl_payments.
number
requerido
Porcentaje de comisión de procesamiento adicional para el procesamiento de alto riesgo.
object[]
requerido
Métodos de pago sobre los que se ha advertido a la cuenta de que se acercan a su límite de tasa de disputas. Cada entrada incluye payment_method, measure (disputes, disputes_and_tc40s o fraud_disputes), warned_at como marca de tiempo ISO 8601, y rate, warning_rate y target_rate como fracciones en las que 0.01 es el 1 %. Vacío cuando no hay ninguno advertido. Un método advertido se pausa, y aparece en restricted_payment_methods, si sigue por encima de su tasa objetivo unas cuatro semanas después.
number
requerido
Porcentaje de comisión cobrado cuando se adelanta saldo pendiente, aún no liquidado, para financiar el saldo de tarjetas de la cuenta, donde 2 significa 2 %. 0 cuando la cuenta está exenta.
integer
requerido
Días adicionales que los pagos permanecen pendientes antes de estar disponibles.
object
requerido
Reserva aplicada actualmente al volumen de pagos entrantes.

Propiedades

integer
requerido
Número de días que se retienen los fondos reservados antes de liberarlos.
number | null
requerido
Porcentaje del volumen de pagos entrantes retenido en reserva. null cuando no se aplica ninguna reserva.
object
requerido
Ajustes de reembolso automático para los casos del centro de resolución.

Propiedades

number | null
requerido
Importe máximo de los casos del centro de resolución financiados con tarjeta que se reembolsa automáticamente, en USD. null cuando los reembolsos automáticos están desactivados para tarjetas.
number | null
requerido
Importe máximo de los casos del centro de resolución financiados con financiación que se reembolsa automáticamente, en USD. null cuando los reembolsos automáticos están desactivados para la financiación.
boolean
requerido
Si se impide al propietario de la cuenta cambiar estos umbrales.
number | null
requerido
Importe máximo de los casos del centro de resolución financiados con PayPal que se reembolsa automáticamente, en USD. null cuando los reembolsos automáticos están desactivados para PayPal.
string[]
requerido
Marcas de tarjeta bloqueadas en el checkout para esta cuenta. Vacío cuando no hay ninguna bloqueada. La cuenta no puede volver a habilitarlas por sí misma.Opciones disponibles: card_visa, card_mastercard, card_american_express, card_discover_global_network, addi, affirm, afterpay_clearpay, alma, billie, capchase_pay, claritypay, flex_pay, klarna, kriya, kueski, mondu, oney, scalapay, sequra, sezzle, splitit, sunbit, tabby, tamara, zip, card_installments_three, card_installments_six, card_installments_twelve, oney_3x, oney_4x, klarna_pay_now, us_bank_account, sepa_debit, bacs_debit, au_becs_debit, acss_debit, pay_by_bank, payto, paypal, cashapp, venmo, amazon_pay, link, wechat_pay
string | null
requerido
Por qué los fondos pendientes sin fecha de liquidación aún no se mueven. kyc_incomplete, pending_information_request y update_payout_profile son cuestiones sobre las que el comerciante puede actuar. compliance_review significa que se está revisando una verificación que el comerciante ya envió, por lo que estos fondos siguen pendientes hasta que se apruebe. withdrawals_disabled significa que Whop ha bloqueado los retiros, por lo que estos fondos no pueden pasar a estar disponibles. null cuando no hay ningún motivo que mostrar: aún se están liquidando o se retienen por un motivo que no se indica aquí.Opciones disponibles: kyc_incomplete, pending_information_request, update_payout_profile, compliance_review, withdrawals_disabled
object
requerido
Cómo se retira automáticamente el saldo de la cuenta.

Propiedades

integer | null
requerido
Día en que se ejecuta el retiro automático: 0-6 (domingo-sábado) para weekly, 1-31 para monthly. null para manual y daily.
string
requerido
Con qué frecuencia se retira automáticamente el saldo de la cuenta.Opciones disponibles: manual, daily, weekly, monthly
string | null
requerido
Próxima fecha en la que está programado el retiro automático, como fecha ISO 8601. null para manual y daily, en los que no aplica una única fecha siguiente.
object | null
requerido
Los métodos de pago predeterminados de la cuenta en el checkout. El payment_method_configuration propio de una variante o de una configuración de checkout tiene prioridad. null cuando la cuenta usa los valores predeterminados de la plataforma Whop.

Propiedades

string[]
requerido
Métodos de pago que este checkout excluye, incluso cuando los valores predeterminados los ofrecerían.
string[]
requerido
Métodos de pago que este checkout ofrece además de los que proporcionan los valores predeterminados.
boolean
requerido
Si el conjunto predeterminado de Whop es el punto de partida. Cuando es false, solo se ofrece enabled.
object[]
requerido
Créditos de plataforma emitidos por Whop por divisa, leídos de la caché de saldos. Los créditos solo pueden gastarse en productos aptos de Whop, como Whop Ads, nunca pueden retirarse y no se incluyen en balances ni en total_usd. Vacío cuando la cuenta no tiene ninguno o total_usd es null.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object | null
requerido
El documento de política de privacidad de la cuenta, o null si no ha publicado ninguno.

Propiedades

string
requerido
El ID del archivo, con el prefijo file_.
string | null
requerido
Marcador de posición BlurHash para una imagen o un vídeo. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El tipo MIME del archivo original, por ejemplo application/pdf. Se conserva cuando la moderación elimina el archivo.
string
requerido
Cuándo se creó el archivo, como marca de tiempo ISO 8601.
number | null
requerido
Duración del audio o del vídeo en segundos. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El nombre de archivo original, incluida su extensión.
integer | null
requerido
Altura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
El tamaño en bytes que debe tener cada parte (excepto la última). Solo está presente al crear, y solo para cargas multiparte.
string | null
El ID de la carga multiparte, que se devuelve a complete. Solo está presente al crear, y solo para cargas multiparte.
object[] | null
La URL prefirmada de cada parte. Solo está presente al crear, y solo para cargas multiparte.

Propiedades

integer
requerido
El índice, empezando por 1, de esta parte dentro de la carga multiparte.
string
requerido
La URL prefirmada a la que enviar con PUT los bytes de esta parte.
string
requerido
El tipo de este objeto, siempre file.
boolean
requerido
Si la moderación eliminó el archivo. Cuando es true, url sirve una imagen de sustitución. filename, size y content_type siguen describiendo el archivo original.
integer | null
requerido
El tamaño del archivo en bytes. null hasta que la carga haya terminado.
object
Cabeceras que se deben enviar con el PUT de la carga. Solo está presente al crear.
string
requerido
En qué punto del ciclo de vida de la carga se encuentra el archivo.Opciones disponibles: pending, processing, ready, failed
string | null
URL prefirmada a la que enviar con PUT los bytes del archivo. Solo está presente al crear, y solo para cargas de una sola parte.
string | null
requerido
Una URL para descargar el archivo. Los archivos públicos obtienen una URL de CDN permanente y los archivos privados obtienen una URL firmada que caduca. null hasta que la carga haya terminado. Cuando la moderación elimina el archivo, una URL de imagen de sustitución.
string
requerido
Los archivos public se sirven desde una URL de CDN sin firmar. Los archivos private se sirven desde una URL firmada que caduca.Opciones disponibles: public, private
string | null
requerido
URL de la forma de onda del audio. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
requerido
Anchura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
object | null
requerido
Código de clasificación fiscal aplicado de forma predeterminada a los productos de la cuenta, con id, name y product_type. null cuando no hay ningún valor predeterminado definido.
OBSOLETO: Usa en su lugar el endpoint GET /economic_intelligence?account_id=\{account_id}.

Propiedades

string
requerido
La recomendación; pueden añadirse nuevos valores, así que gestiona correctamente las acciones desconocidasOpciones disponibles: theme_business, create_product, create_plan, verify_identity, connect_affiliate_program, create_promotion, migrate_from_stripe, accept_first_payment, launch_first_ad, launch_draft_campaign, increase_ad_budget, refresh_ad_creatives, fix_ad_billing, exclude_customers_from_ads, retarget_abandoned_checkouts, fix_funnel_dropoff, invite_team_member, enable_tax_collection, create_card, apply_for_financing
string[]
requerido
Capacidades que esto desbloquearía, o vacío
string
requerido
La URL a la que enlaza la llamada a la acción
string
requerido
Etiqueta del botón
string
requerido
Texto de apoyo, o vacío
string | null
requerido
URL del icono de ilustración, o null
integer | null
requerido
Impacto estimado de 0 a 100, o null cuando no está clasificado
string | null
requerido
Por qué se recomendó esta acción, o null
string
requerido
Siempre opcional, nunca bloqueanteOpciones disponibles: optional
string
requerido
Titular de la recomendación
boolean
requerido
Si los usuarios autorizados deben activar la autenticación de dos factores.
object[] | null
requerido
Acciones que debe realizar el propietario de la cuenta para desbloquear capacidades como los pagos y el gasto con tarjeta, ordenadas por prioridad de visualización. Solo se calcula en retrieve y me para quienes llaman con el alcance company:balance:read; null en caso contrario.

Propiedades

string
requerido
Lo que debe hacer el titular; pueden añadirse nuevos valores, así que gestiona correctamente las acciones desconocidasOpciones disponibles: deposit_funds, review_held_payments, submit_information_request, update_automatic_withdrawal_method, reauthorize_payout_methods, update_payout_method, update_payout_profile, card_usage_review, verify_identity, scale_account_setup, sign_formation_documents, configure_tax_remitter, add_vat_registration, confirm_tax_details, accept_payout_terms, enable_two_factor_authentication, respond_to_abuse_report
string[]
requerido
Capacidades bloqueadas hasta que esto se resuelva
string | null
requerido
La URL a la que enlaza la llamada a la acción, o null cuando no hay botón
string
requerido
Etiqueta del botón, o vacío cuando no hay botón
string
requerido
Texto de apoyo, o vacío
string | null
requerido
La URL del icono de ilustración de la acción, o null si no tiene
string
requerido
required (actúa ahora) o pending (en revisión)Opciones disponibles: required, pending
string
requerido
Titular de la acción
object | null
requerido
El documento de política de devoluciones de la cuenta, o null si no ha publicado ninguno.

Propiedades

string
requerido
El ID del archivo, con el prefijo file_.
string | null
requerido
Marcador de posición BlurHash para una imagen o un vídeo. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El tipo MIME del archivo original, por ejemplo application/pdf. Se conserva cuando la moderación elimina el archivo.
string
requerido
Cuándo se creó el archivo, como marca de tiempo ISO 8601.
number | null
requerido
Duración del audio o del vídeo en segundos. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El nombre de archivo original, incluida su extensión.
integer | null
requerido
Altura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
El tamaño en bytes que debe tener cada parte (excepto la última). Solo está presente al crear, y solo para cargas multiparte.
string | null
El ID de la carga multiparte, que se devuelve a complete. Solo está presente al crear, y solo para cargas multiparte.
object[] | null
La URL prefirmada de cada parte. Solo está presente al crear, y solo para cargas multiparte.

Propiedades

integer
requerido
El índice, empezando por 1, de esta parte dentro de la carga multiparte.
string
requerido
La URL prefirmada a la que enviar con PUT los bytes de esta parte.
string
requerido
El tipo de este objeto, siempre file.
boolean
requerido
Si la moderación eliminó el archivo. Cuando es true, url sirve una imagen de sustitución. filename, size y content_type siguen describiendo el archivo original.
integer | null
requerido
El tamaño del archivo en bytes. null hasta que la carga haya terminado.
object
Cabeceras que se deben enviar con el PUT de la carga. Solo está presente al crear.
string
requerido
En qué punto del ciclo de vida de la carga se encuentra el archivo.Opciones disponibles: pending, processing, ready, failed
string | null
URL prefirmada a la que enviar con PUT los bytes del archivo. Solo está presente al crear, y solo para cargas de una sola parte.
string | null
requerido
Una URL para descargar el archivo. Los archivos públicos obtienen una URL de CDN permanente y los archivos privados obtienen una URL firmada que caduca. null hasta que la carga haya terminado. Cuando la moderación elimina el archivo, una URL de imagen de sustitución.
string
requerido
Los archivos public se sirven desde una URL de CDN sin firmar. Los archivos private se sirven desde una URL firmada que caduca.Opciones disponibles: public, private
string | null
requerido
URL de la forma de onda del audio. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
requerido
Anchura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
object[]
Recompensas para negocios vinculadas a través del enlace de referencia activo de esta cuenta, con el progreso específico de la cuenta y el estado del libro contable. Presente en las respuestas de recuperación; vacío sin acceso de lectura tanto al saldo como a las estadísticas.

Propiedades

string
requerido
ID de la definición de la recompensa, con el prefijo prwd_. El progreso y el estado se aplican a la cuenta que lo contiene.
object
requerido
Volumen apto en USD necesario para obtener esta recompensa.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Volumen apto en USD de la actividad de la recompensa acumulado por esta cuenta desde la atribución, calculado con las reglas de cumplimiento.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string
requerido
Actividad que hace que esta cuenta sea apta para la recompensa.Opciones disponibles: sales, ad_spend
object
requerido
Importe en USD abonado por esta recompensa. Usa el importe de concesión guardado una vez que ha empezado el cumplimiento.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string
requerido
El estado de la recompensa de esta cuenta. Credited requiere un asiento contable registrado; processing incluye un requisito cumplido a la espera de cumplimiento. Reversing y reversed reflejan una reversión posterior de la recompensa.Opciones disponibles: in_progress, processing, credited, reversing, reversed, unavailable
string
requerido
Identificador de la ruta pública de la cuenta.
boolean
requerido
Si Whop envía correos electrónicos transaccionales a los clientes en nombre de esta cuenta.
object | null
requerido
El documento de política de envíos de la cuenta, o null si no ha publicado ninguno.

Propiedades

string
requerido
El ID del archivo, con el prefijo file_.
string | null
requerido
Marcador de posición BlurHash para una imagen o un vídeo. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El tipo MIME del archivo original, por ejemplo application/pdf. Se conserva cuando la moderación elimina el archivo.
string
requerido
Cuándo se creó el archivo, como marca de tiempo ISO 8601.
number | null
requerido
Duración del audio o del vídeo en segundos. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El nombre de archivo original, incluida su extensión.
integer | null
requerido
Altura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
El tamaño en bytes que debe tener cada parte (excepto la última). Solo está presente al crear, y solo para cargas multiparte.
string | null
El ID de la carga multiparte, que se devuelve a complete. Solo está presente al crear, y solo para cargas multiparte.
object[] | null
La URL prefirmada de cada parte. Solo está presente al crear, y solo para cargas multiparte.

Propiedades

integer
requerido
El índice, empezando por 1, de esta parte dentro de la carga multiparte.
string
requerido
La URL prefirmada a la que enviar con PUT los bytes de esta parte.
string
requerido
El tipo de este objeto, siempre file.
boolean
requerido
Si la moderación eliminó el archivo. Cuando es true, url sirve una imagen de sustitución. filename, size y content_type siguen describiendo el archivo original.
integer | null
requerido
El tamaño del archivo en bytes. null hasta que la carga haya terminado.
object
Cabeceras que se deben enviar con el PUT de la carga. Solo está presente al crear.
string
requerido
En qué punto del ciclo de vida de la carga se encuentra el archivo.Opciones disponibles: pending, processing, ready, failed
string | null
URL prefirmada a la que enviar con PUT los bytes del archivo. Solo está presente al crear, y solo para cargas de una sola parte.
string | null
requerido
Una URL para descargar el archivo. Los archivos públicos obtienen una URL de CDN permanente y los archivos privados obtienen una URL firmada que caduca. null hasta que la carga haya terminado. Cuando la moderación elimina el archivo, una URL de imagen de sustitución.
string
requerido
Los archivos public se sirven desde una URL de CDN sin firmar. Los archivos private se sirven desde una URL firmada que caduca.Opciones disponibles: public, private
string | null
requerido
URL de la forma de onda del audio. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
requerido
Anchura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
boolean
requerido
Si la cuenta aparece en los whops a los que se ha unido en otras cuentas.
boolean
requerido
Si las reseñas se muestran en las páginas de productos directos al consumidor.
boolean
requerido
Si la cuenta muestra usuarios en el directorio de usuarios.
Enlaces sociales de la cuenta.

Propiedades

string
requerido
El ID del enlace social
string | null
requerido
El título visible opcional del enlace social
string
requerido
La URL del enlace social
string
requerido
La plataforma social de este enlaceOpciones disponibles: x, instagram, facebook, tiktok, youtube, linkedin, twitch, website, custom
string | null
requerido
Si la cuenta puede operar en Whop: active o suspended. Se calcula en list, retrieve, me y suspend; null en caso contrario.
string | null
requerido
Por qué se suspendió la cuenta, como una etiqueta del tipo Suspended - Fraudulent activity. Suspended cuando no hay ningún motivo registrado. Se calcula en retrieve, me y suspend. null en caso contrario, o cuando status no es suspended.
object
requerido
Configuración de visualización de la página de la tienda de la cuenta.

Propiedades

string | null
requerido
Color de acento usado en la página de la tienda de la cuenta.Opciones disponibles: ruby, tomato, red, crimson, pink, plum, purple, violet, iris, cyan, teal, jade, green, grass, brown, blue, orange, indigo, sky, mint, yellow, amber, lime, lemon, magenta, gold, bronze, gray
string | null
requerido
Diseño usado en la página de la tienda de la cuenta.Opciones disponibles: featured, compact
string | null
requerido
Presentación del perfil usada en la página de la tienda de la cuenta.Opciones disponibles: personal, business
Si la página de la tienda de la cuenta muestra un enlace de afiliado de Whop.
string | null
requerido
Público objetivo de esta cuenta.
string[]
requerido
Códigos de estados de EE. UU. (de los 50 estados más DC) en los que la cuenta recauda impuestos: el conjunto completo cuando Whop los ingresa (tax_remitted_by whop), el subconjunto configurado cuando la cuenta los ingresa por su cuenta (self) y vacío cuando no se da ninguno de los dos casos. Al actualizar, envía la lista completa para reemplazarla (solo se permite cuando es self).
object[]
requerido
Registros fiscales/de IVA de la cuenta. Vacío cuando no hay ninguno definido.

Propiedades

string
requerido
ID del identificador fiscal.
string
requerido
Tipo de ID fiscal.Opciones disponibles: ad_nrt, ao_tin, ar_cuit, al_tin, am_tin, aw_tin, au_abn, au_arn, eu_vat, az_tin, bs_tin, bh_vat, bd_bin, bb_tin, by_tin, bj_ifu, bo_tin, ba_tin, br_cnpj, br_cpf, bg_uic, bf_ifu, kh_tin, cm_niu, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cv_nif, cl_tin, cn_tin, co_nit, cd_nif, cr_tin, hr_oib, do_rcn, ec_ruc, eg_tin, sv_nit, et_tin, eu_oss_vat, ge_vat, gh_tin, de_stn, gb_vat, gn_nif, hk_br, hu_tin, is_vat, in_gst, id_npwp, il_vat, jp_cn, jp_rn, jp_trn, kz_bin, ke_pin, kg_tin, la_tin, li_uid, li_vat, my_frp, my_itn, my_sst, mr_nif, mx_rfc, md_vat, me_pib, ma_vat, np_pan, nz_gst, ng_tin, mk_vat, no_vat, no_voec, om_vat, pe_ruc, ph_tin, pl_nip, ro_tin, ru_inn, ru_kpp, sa_vat, sn_ninea, rs_pib, sg_gst, sg_uen, si_tin, za_vat, kr_brn, es_cif, ch_uid, ch_vat, tw_vat, tj_tin, tz_vat, th_vat, tr_tin, ug_tin, ua_vat, ae_trn, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, zm_tin, zw_tin, sr_fin, xi_vat
string
requerido
Valor del ID fiscal, por ejemplo DE123456789. Consulta la guía de IDs fiscales.
string | null
requerido
Quién calcula e ingresa los impuestos de la cuenta. whop significa que Whop los calcula y los ingresa. self significa que Whop los calcula y la cuenta los recauda y los ingresa. none significa que ninguno de los dos, y la cuenta es responsable. Los negocios nuevos empiezan con whop y las cuentas conectadas nuevas empiezan con none. null significa que la cuenta aún no tiene ningún ajuste.Opciones disponibles: whop, self, none
string | null
requerido
Cómo se aplican los impuestos a los precios de la cuenta: inclusive (impuestos incluidos en el precio indicado) o exclusive (impuestos añadidos al precio). Toma exclusive como valor predeterminado cuando no está definido; null solo cuando la cuenta no tiene conexión de pagos.Opciones disponibles: inclusive, exclusive
object | null
requerido
El documento de términos del servicio de la cuenta, o null si no ha publicado ninguno.

Propiedades

string
requerido
El ID del archivo, con el prefijo file_.
string | null
requerido
Marcador de posición BlurHash para una imagen o un vídeo. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El tipo MIME del archivo original, por ejemplo application/pdf. Se conserva cuando la moderación elimina el archivo.
string
requerido
Cuándo se creó el archivo, como marca de tiempo ISO 8601.
number | null
requerido
Duración del audio o del vídeo en segundos. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
El nombre de archivo original, incluida su extensión.
integer | null
requerido
Altura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
El tamaño en bytes que debe tener cada parte (excepto la última). Solo está presente al crear, y solo para cargas multiparte.
string | null
El ID de la carga multiparte, que se devuelve a complete. Solo está presente al crear, y solo para cargas multiparte.
object[] | null
La URL prefirmada de cada parte. Solo está presente al crear, y solo para cargas multiparte.

Propiedades

integer
requerido
El índice, empezando por 1, de esta parte dentro de la carga multiparte.
string
requerido
La URL prefirmada a la que enviar con PUT los bytes de esta parte.
string
requerido
El tipo de este objeto, siempre file.
boolean
requerido
Si la moderación eliminó el archivo. Cuando es true, url sirve una imagen de sustitución. filename, size y content_type siguen describiendo el archivo original.
integer | null
requerido
El tamaño del archivo en bytes. null hasta que la carga haya terminado.
object
Cabeceras que se deben enviar con el PUT de la carga. Solo está presente al crear.
string
requerido
En qué punto del ciclo de vida de la carga se encuentra el archivo.Opciones disponibles: pending, processing, ready, failed
string | null
URL prefirmada a la que enviar con PUT los bytes del archivo. Solo está presente al crear, y solo para cargas de una sola parte.
string | null
requerido
Una URL para descargar el archivo. Los archivos públicos obtienen una URL de CDN permanente y los archivos privados obtienen una URL firmada que caduca. null hasta que la carga haya terminado. Cuando la moderación elimina el archivo, una URL de imagen de sustitución.
string
requerido
Los archivos public se sirven desde una URL de CDN sin firmar. Los archivos private se sirven desde una URL firmada que caduca.Opciones disponibles: public, private
string | null
requerido
URL de la forma de onda del audio. Null cuando no está disponible o la moderación lo ha eliminado.
integer | null
requerido
Anchura de la imagen o del vídeo en píxeles. Null cuando no está disponible o la moderación lo ha eliminado.
string | null
requerido
Comportamiento de 3D Secure para los pagos con tarjeta compatibles realizados en sesión. mandate_challenge exige un desafío 3DS antes de procesar el pago; mandate_if_required exige un desafío solo cuando el procesador de pagos lo requiere; frictionless_if_required usa el flujo 3DS sin fricción habitual. Los pagos de 1000 $ o más usan mandate_if_required a menos que se seleccione mandate_challenge. Los requisitos de riesgo y de recuperación de la autenticación pueden anular la preferencia. null usa el flujo de checkout estándar.Opciones disponibles: mandate_challenge, mandate_if_required, frictionless_if_required
string
requerido
Nombre visible de la cuenta.
number | null
requerido
Ventas de la cuenta durante toda su vida, normalizadas a USD. Solo se calcula en retrieve y me para quienes llaman con el alcance stats:read; null en caso contrario.
string | null
requerido
Valor total en USD de los saldos con tipos de cambio conocidos. Solo se calcula en las lecturas de una sola cuenta (retrieve y me); null en las respuestas de listas, las escrituras, cuando falta el permiso de lectura de saldos o cuando la fuente de saldos no está disponible.
trading_account | null
requerido
La dirección de la cuenta de trading, una instantánea de su margen y sus posiciones abiertas, y sus suscripciones de WebSocket. Actívalo con include_trading=true en las lecturas de una sola cuenta. null en caso contrario, sin permiso de trading o sin una billetera de Ethereum.

Propiedades

string
requerido
El ID de la billetera de Whop que respalda esta cuenta de trading, con el prefijo cwal_.
string | null
requerido
La cuenta propietaria de esta cuenta de trading, con el prefijo biz_. null cuando la posee un usuario.
object | null
requerido
Estado específico de Hyperliquid. Presente cuando provider es hyperliquid; en caso contrario, null.

Propiedades

string
requerido
Dirección de billetera en minúsculas que contiene la cuenta de Hyperliquid.
string | null
requerido
USDT0 en la billetera de Whop en Plasma que una operación deposit puede mover a esta cuenta, como cadena decimal. null cuando no se pudo leer la cadena.
object | null
requerido
Valor de la cuenta y margen en el exchange principal y en los mercados xyz, leídos de Hyperliquid como máximo una vez por segundo. null cuando no se pudo leer Hyperliquid. Usa websocket_subscriptions para recibir actualizaciones en tiempo real.

Propiedades

object
requerido
Valor total de la cuenta en USD, incluidas las ganancias y pérdidas no realizadas.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Margen asignado a las posiciones abiertas, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Valor nocional combinado de las posiciones abiertas, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
USD que se pueden retirar ahora sin cerrar posiciones.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
trading_position[] | null
requerido
Posiciones perpetuas abiertas en el exchange principal y en los mercados xyz, leídas de Hyperliquid como máximo una vez por segundo. null cuando no se pudo leer Hyperliquid. Usa websocket_subscriptions para recibir actualizaciones en tiempo real.

Propiedades

string
requerido
ID de la posición de trading, con el prefijo trdpos_. Estable para un mercado dentro de una cuenta de trading.
object | null
requerido
Precio de entrada medio en USD, o null cuando el proveedor lo omite.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object | null
requerido
Detalles del perpetuo de Hyperliquid. Presente en las posiciones de Hyperliquid; en caso contrario, null.

Propiedades

object
requerido
Funding pagado por la posición en varios periodos, en USD.

Propiedades

object | null
requerido
Funding pagado en este mercado a lo largo del historial de la cuenta, en USD, o null cuando no está disponible.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object | null
requerido
Funding pagado desde el último cambio de tamaño de la posición, en USD, o null cuando no está disponible.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object | null
requerido
Funding pagado desde que se abrió la posición, en USD, o null cuando no está disponible.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Modo de margen y multiplicador de la posición.

Propiedades

string
requerido
cross comparte el margen entre posiciones. isolated limita el margen a esta posición.Opciones disponibles: cross, isolated
integer
requerido
Multiplicador aplicado al margen de la posición, como 10 para 10x.
object | null
requerido
Precio de liquidación estimado en USD, o null cuando Hyperliquid no informa de ninguno.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Margen asignado a la posición, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string
requerido
Rentabilidad sobre el capital como cadena de ratio decimal, como 0.1 para el 10 %.
string
requerido
Símbolo del mercado en el proveedor, como ETH.
string
requerido
object
requerido
Valor actual de la posición en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string
requerido
Opciones disponibles: long, short
string
requerido
Tamaño absoluto de la posición como cadena decimal.
object
requerido
Ganancia o pérdida no realizada en USD. Negativa en caso de pérdida.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object[]
requerido
Suscripciones para recibir actualizaciones de la cuenta en tiempo real. Envía cada message sin cambios después de conectarte a websocket_url.

Propiedades

string
requerido
El flujo de actualizaciones en tiempo real que abre esta suscripción.Opciones disponibles: clearinghouse_state, open_orders, order_updates, user_fills, user_events
string
requerido
Mensaje de suscripción JSON que se debe enviar sin cambios por el WebSocket de Hyperliquid.
string
requerido
URL del WebSocket de Hyperliquid a la que conectarse directamente para recibir actualizaciones en tiempo real.
string
requerido
string
requerido
Plataforma de trading que contiene las posiciones y las órdenes.Opciones disponibles: hyperliquid
object | null
requerido
Activos al contado en la billetera de Whop con su precio de entrada y sus ganancias y pérdidas. null cuando no se pudo leer.

Propiedades

object[]
requerido
Cada activo al contado que la billetera aún contiene, con su precio de entrada medio y sus ganancias y pérdidas. La base de coste considera que las unidades más antiguas se venden primero e incluye los activos que llegaron desde fuera de Whop.

Propiedades

object | null
requerido
El precio medio pagado por unidad de lo que aún se mantiene, en USD, considerando que las unidades más antiguas se venden primero. null cuando no se conoce.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Lo que se pagó en USD por las unidades que aún se mantienen.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string
requerido
El id del mercado al contado de GET /trades/markets, como BTC, XAUT o el ticker de una acción tokenizada, como AAPL.
object
requerido
Ganancias y pérdidas ya consolidadas mediante ventas, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
El valor de las unidades que aún se mantienen menos su cost_basis, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
number | null
requerido
unrealized_pnl como porcentaje de cost_basis, donde 2 significa una subida del 2 %. null cuando no se conoce.
string | null
requerido
El usuario propietario de esta cuenta de trading, con el prefijo user_. null cuando la posee una cuenta.
boolean
requerido
Si la cuenta usa su logotipo como imagen Open Graph de respaldo.
object
requerido
Estado de verificación de identidad de la cuenta para los perfiles individual (KYC) y business (KYB). Cada uno es null hasta que se crea; en caso contrario, un status de not_started, pending, manual_review, approved o rejected.
number | null
requerido
Volumen a través de la cuenta en los últimos 30 días (GMV de recibos pagados), normalizado a USD. Solo se calcula en list para quienes llaman con stats:read en la cuenta; null en caso contrario.
number | null
requerido
Volumen a través de la cuenta durante toda su vida (ventas más transferencias recibidas), normalizado a USD. Solo se calcula en list para quienes llaman con stats:read en la cuenta; null en caso contrario.
object | null
requerido
Billetera de criptomonedas principal de la cuenta, o null si no se ha aprovisionado ninguna.

Propiedades

string
requerido
ID de la billetera, con el prefijo wallet_.
string
requerido
La dirección on-chain de la billetera
string
requerido
La red blockchain en la que se encuentra la billeteraOpciones disponibles: solana, ethereum, bitcoin
string | null
requerido
La URL del sitio web comercial de la cuenta, o null si no se ha proporcionado ninguna. Definirla también añade una entrada website a social_links.
string | null
Cuándo activó la cuenta el modo Whop Partner, como marca de tiempo ISO 8601. Presente en las lecturas de una sola cuenta y en las respuestas de actualización; null hasta que la cuenta activa el modo Whop Partner enviando whop_partner_enabled: true al actualizar.
Account

Tipos de negocio e industrias

Tres campos clasifican las cuentas: business_type, industry_group e industry_type. La taxonomía completa se encuentra en su propia página:

Tipos de negocio e industrias