Skip to main content
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

Atributos

string
requerido
ID del retiro, con el prefijo wdrl_.
string
requerido
El importe del retiro en unidades enteras de moneda, como cadena decimal.
boolean
requerido
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.
object | null
requerido
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.

Propiedades

string
requerido
El importe que la conversión tomó del saldo, como cadena decimal.
string
requerido
La moneda del saldo del que la conversión tomó el importe.
number
requerido
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.
string
requerido
Cuándo se creó el retiro.
string
requerido
Moneda del retiro.
string | null
requerido
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.
string | null
requerido
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.
string | null
requerido
Hora estimada en la que los fondos estarán disponibles en la cuenta de destino.
number | null
requerido
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.
object | null
requerido
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.

Propiedades

string | null
requerido
Código de error clasificado del catálogo de errores mantenido.
string | null
requerido
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.
string | null
requerido
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.
string
requerido
La comisión cobrada por el retiro, en la moneda del retiro, como cadena decimal.
string
requerido
Quién asumió la comisión del retiro: la propia cuenta o su plataforma principal.Opciones disponibles: self, platform
string
requerido
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.
object
requerido
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.
string
requerido
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.
string | null
requerido
Notas libres adjuntadas por quien creó el retiro, o null cuando no se proporcionó ninguna. Máximo 255 caracteres.
string
requerido
string | null
requerido
Nombre de la entidad que procesa el retiro.
object | null
requerido
El método de retiro guardado utilizado. Requiere payout:destination:read; null sin él.

Propiedades

string | null
requerido
Alias del método de retiro guardado.
object | null
requerido
Detalles de visualización del método de retiro compatible.

Propiedades

string
requerido
Cómo se entregan los fondos al destinatario.Opciones disponibles: cash_pickup, bank_deposit, home_delivery, mobile_wallet, card, check, bill, cryptocurrency, unknown
string | null
requerido
URL del icono del método de retiro compatible.
string | null
requerido
Nombre visible del método de retiro compatible.
string
requerido
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
string | null
requerido
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.
string | null
requerido
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
string
requerido
Velocidad de entrega del retiro.Opciones disponibles: standard, instant
string | null
requerido
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.
string
requerido
Estado actual del retiro.Opciones disponibles: requested, in_review, processing, completed, reversed, canceled, failed, denied
string
requerido
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.
string | null
requerido
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.
Payout