Endpoints
Atributos
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.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
Propiedades
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.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.Hora estimada en la que los fondos estarán disponibles en la cuenta de destino.
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.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
Propiedades
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.Quién asumió la comisión del retiro: la propia cuenta o su plataforma principal.Opciones disponibles:
self, platformEl margen de Whop sobre la comisión del proveedor, en la moneda del retiro, como cadena decimal.
"0.0" cuando no se aplica ninguno.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.
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.Notas libres adjuntadas por quien creó el retiro, o
null cuando no se proporcionó ninguna. Máximo 255 caracteres.El método de retiro guardado utilizado. Requiere payout:destination:read; null sin él.
Propiedades
Propiedades
Detalles de visualización del método de retiro compatible.
Propiedades
Propiedades
Cómo se entregan los fondos al destinatario.Opciones disponibles:
cash_pickup, bank_deposit, home_delivery, mobile_wallet, card, check, bill, cryptocurrency, unknownID 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.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, automaticLa 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.Estado actual del retiro.Opciones disponibles:
requested, in_review, processing, completed, reversed, canceled, failed, deniedLa 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.Payout

