confirmation_token para el método que seleccionó el comprador, o un pago off-session con el método de pago almacenado de un miembro existente.
Usa la API de Payments para cobrar a compradores, listar y recuperar pagos, y reembolsarlos, anularlos, capturarlos o reintentarlos. El cobro se ejecuta en segundo plano, así que la respuesta de creación no es el resultado. Consulta periódicamente Recuperar estado para saber hasta dónde ha avanzado el pago y, mientras esté en requires_action, qué debe hacer el comprador a continuación: seguir una redirección, completar 3D Secure, mostrar instrucciones de transferencia o vincular una cuenta bancaria. Actualiza la return_url del pago para cambiar adónde llega después, hasta que regrese.
Endpoints
Atributos
Lo que se queda la cuenta: el total menos las comisiones de Whop. Null cuando lees el pago como su comprador.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
Lo que se cobra al comprador por este pago: el total más las comisiones del comprador, en la moneda en la que paga el comprador. Los reembolsos no lo reducen;
presentment_refunded_amount los indica en la misma moneda.Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
Cuándo Whop capturará automáticamente este pago con tarjeta autorizado salvo que se anule antes, como marca de tiempo ISO 8601. Null cuando no se solicitó captura automática.
True cuando Whop reembolsó el pago automáticamente, por ejemplo ante una alerta de disputa.
La dirección de facturación que introdujo el comprador, o null.
Propiedades
Propiedades
Por qué se creó el cargo: una primera compra, una renovación, un pago único o un cargo manual.
Cuándo vence la retención de este pago con tarjeta autorizado si no se captura antes, como marca de tiempo ISO 8601. Null cuando el pago no se creó para una captura posterior.
La configuración de checkout a través de la cual pagó el comprador, con el prefijo
ch_, o null.El esquema y el host del sitio web donde el comprador abrió el checkout, como
https://store.example.com. Úsalo para distinguir pagos de distintos sitios web en una misma cuenta. Null cuando no se registró el sitio web, incluidos los pagos realizados sin el comprador presente.La experiencia de checkout que generó este pago, como
embedded_checkout para un checkout en el propio sitio web de la cuenta u off_session para una renovación de suscripción. Null cuando no se registró el checkout.Opciones disponibles: hosted_checkout, embedded_checkout, custom_checkout, modal_checkout, in_app_checkout, mobile_checkout, off_session, card_presentLa credencial que presenta la interfaz de un comprador para consultar este pago, establecer su URL de retorno y reanudarlo cuando el banco pidió al cliente que se autenticara. Solo en pagos creados a partir de un confirmation token o que esperan esa autenticación; null cuando lees el pago como su comprador, y siempre null en las respuestas de lista: recupera el pago para obtenerla.
La moneda en la que se liquida el pago, en ISO 4217 en minúsculas. Todos los campos monetarios siguientes se expresan en ella, salvo que se indique lo contrario.Opciones disponibles:
usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xau, hnlLa dirección de correo electrónico del comprador. Null sin
member:email:read en la cuenta o cuando el comprador no tiene un correo asignado.El número de teléfono que dio el comprador en el checkout, cuando se recopiló uno.
Cuándo se abrió la disputa más reciente de este pago, como marca de tiempo ISO 8601. Null cuando el pago nunca se disputó, o sin el permiso payment:dispute:read.
Las retenciones activas de este pago. Cada retención tiene su propia fecha de liberación, independiente de
settlement_time_at. Vacío cuando no hay nada retenido o lees el pago como su comprador; las retenciones liberadas se omiten.Propiedades
Propiedades
El importe actualmente retenido, en la moneda de la retención.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
El porcentaje de reserva registrado cuando se creó la retención, por ejemplo 3.5 para 3.5%. Null para otros tipos de retención o cuando no se registró ningún porcentaje.
Cuándo está previsto que los fondos retenidos pasen a estar disponibles, como marca de tiempo ISO 8601. Nunca antes de la fecha de liquidación del pago. Null cuando la liberación depende de un evento, como la resolución de un envío, en lugar de una fecha.
La dirección IP del comprador en el checkout: la que identificó el control de fraude de Whop o, si no, la que Whop capturó del navegador del comprador en el checkout. Null cuando el comprador no estuvo presente en el checkout, como en una renovación de suscripción o un cargo realizado sin el comprador presente, o cuando lees el pago como su comprador.
Todo lo que cobró este pago, en el orden de compra, con cantidades y subtotales en la moneda de compra. Los pagos realizados antes de que se registraran instantáneas de artículos devuelven el único artículo implícito en su variante. Vacío cuando no se puede resolver ningún artículo ni variante.
Propiedades
Propiedades
ID de la línea de artículo, con el prefijo
li_. Null cuando el pago es anterior a las instantáneas de artículos y el artículo se lee de la variante del pago.El nombre del artículo tal como se mostró en el checkout (el título del producto o, si no, el título de la variante).
El producto al que pertenece la variante, con el prefijo
prod_. En un pago anterior a las instantáneas de artículos, recurre al producto de la variante, por lo que puede estar establecido aunque el product_id del objeto principal sea null. Null para una variante sin producto.La unidad de mantenimiento de stock (SKU) de la variante, texto libre establecido por el vendedor (p. ej.,
TSHIRT-LARGE-BLUE). Las cuentas con sufijos de SKU por motivo de facturación activados lo reciben marcado con el motivo del cargo: -S para un primer cargo de suscripción, -R para una renovación, -C para una compra única, -U cuando los metadatos del propio pago llevan upsell: true, -F cuando no se cobró nada. Los demás motivos de facturación llevan el SKU sin sufijo. null cuando la variante no tiene SKU o se ha eliminado.El importe registrado para la cantidad completa de este artículo, antes de descuentos, impuestos y comisiones, en su moneda de compra. Devuelve
null cuando no se registró ningún importe de artículo.Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
La variante comprada, con el prefijo
plan_. Null cuando la variante se ha eliminado desde entonces.El registro de miembro del comprador en la cuenta, con el prefijo
mber_. Null sin el permiso member:basic:read, salvo que seas el comprador.La membresía a la que se factura este pago, con el prefijo
mem_. Null para compras puntuales, o sin el permiso member:basic:read salvo que seas el comprador.Tus propios datos clave-valor adjuntados al crear el pago. Null cuando lees el pago como su comprador.
True para un pago pagado con dirección de envío, sin envío y sin reembolso total. Null sin el permiso shipment:basic:read.
True cuando los fondos se retienen hasta que se envía el pedido y aún no se ha añadido ningún número de seguimiento. Null sin el permiso shipment:basic:read.
El instrumento preparado para mostrarse: un nombre visible para el comprador, el conjunto de iconos estándar y, cuando era una tarjeta, la marca de la tarjeta, los últimos cuatro dígitos, el número de identificación del emisor y el id de transacción de red que usa la cuenta para la tarjeta. El id de transacción de red es null cuando lees el pago como su comprador.
Propiedades
Propiedades
Solo pagos con tarjeta, Apple Pay y Google Pay: la red de la tarjeta, los últimos cuatro dígitos, el número de identificación del emisor, la caducidad y el id de transacción de red.
Propiedades
Propiedades
El identificador de la red (
visa, amex, …), que coincide con las entradas de card.networks y con los métodos de pago con tarjeta guardados. Null cuando la bóveda no registró la red.El mes de caducidad de la tarjeta, de 1 a 12. Null cuando la bóveda no lo registró.
El año de caducidad de la tarjeta, de cuatro dígitos. Null cuando la bóveda no lo registró.
El número de identificación del emisor, también llamado BIN: los seis u ocho primeros dígitos de la tarjeta, que identifican al banco emisor. Null cuando el procesador no lo informó.
El id de transacción de red que usa esta cuenta para la tarjeta. Es el id propio de esta cuenta, de su primer cargo o verificación con el cliente presente en la tarjeta, cuando Whop tiene uno. Si no, es un id de transacción de red anterior de esta tarjeta, que puede provenir de una transacción de otra cuenta o haberse aportado con la tarjeta. Cítalo como transacción previa en un cargo posterior iniciado por el comerciante con esta tarjeta en esta cuenta. Null hasta que exista uno. Un webhook enviado cuando se registra por primera vez un pago puede llevar
null, así que recupera el pago para leerlo.Nombre del instrumento visible para el comprador: “Visa •••• 4242” cuando se mostró la tarjeta o, si no, el nombre propio del método (“Klarna”).
El conjunto de iconos estándar: formas cuadrada y de tarjeta, cada una en variantes de color claras y oscuras.
Propiedades
Propiedades
El mosaico con proporciones de tarjeta de crédito (48x30).
Propiedades
Propiedades
La variante de color para superficies oscuras.
La variante de color para superficies claras.
El mosaico cuadrado (32x32).
Propiedades
Propiedades
La variante de color para superficies oscuras.
La variante de color para superficies claras.
Solo métodos de pago a plazos: en cuántos pagos se divide el cargo. Son datos, no texto: compón y traduce la etiqueta en el cliente.
El método de pago almacenado al que se cobró, con el prefijo
payt_. Null cuando el método no se guardó.El tipo de instrumento utilizado, por ejemplo
card, apple_pay, klarna o us_bank_account.Las reglas de pago propias de la cuenta que decidieron este pago, registradas cuando se ejecutaron. Solo se toma una acción por pago, así que una regla que coincidió pero se omitió o fue superada no aparece. Vacío cuando ninguna lo decidió, cuando la cuenta no tenía reglas, cuando Whop bloqueó el pago antes de que se ejecutaran o cuando lees el pago como su comprador.
Cuánto se ha reembolsado hasta ahora, en la moneda presentada al comprador. Cero cuando no se ha reembolsado nada.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
El impuesto sobre las ventas o IVA recaudado, en la moneda presentada al comprador. Null cuando no se aplicaron impuestos.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
El total para la cuenta en la moneda presentada al comprador, antes de la conversión a la moneda de liquidación. Excluye las comisiones del comprador.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
El producto al que pertenece la variante, con el prefijo
prod_. Null para una variante sin producto.La cotización de pago que cobró este pago, con el prefijo
pq_: su compra, código promocional y tax_amount son los de la cotización. Null cuando el pago no indicó ninguna cotización y los impuestos se calcularon en el momento del cobro.URL alojada por Whop donde el comprador puede iniciar sesión y completar 3D Secure para un cargo off-session que el banco desafió: una renovación de suscripción o un pago con tarjeta guardada. Null cuando la recuperación no está disponible, no tienes
member:basic:read, o en las respuestas de lista. Recupera el pago para obtenerla.True cuando el pago está
paid, aún no se ha reembolsado por completo y su procesador admite reembolsos.Cuánto se ha reembolsado hasta ahora, tal como se liquidó: los reembolsos se convierten a la tasa vigente cuando se emitió cada uno, no a la tasa original del pago.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
Cuándo vence la primera respuesta a una disputa o un caso del Resolution Center que espera la respuesta de la cuenta, como marca de tiempo ISO 8601. Null cuando nada espera respuesta, o sin el permiso para leer esa disputa o caso.
True cuando el pago puede reintentarse manualmente con
POST /payments/\{id} /retry. El pago debe estar open y no haberse pagado mediante un enlace de pago de factura. Su membresía debe estar active, trialing o past_due, o el pago debe ser un primer pago fallido en una membresía drafted. No debe haberse agotado su único reintento manual. Un reintento aún puede rechazarse cuando la cuenta no puede aceptar pagos en ese momento.El índice de riesgo publicado por Whop, de 0 (el más bajo) a 100 (el más alto), incluidos los umbrales de decisión aplicados. No es una probabilidad de fraude. Null cuando no hay puntuación disponible o lees el pago como su comprador.
Obsoleto. Ya no se proporcionan explicaciones de la puntuación de riesgo; siempre null. OBSOLETO: ya no se proporcionan explicaciones de la puntuación de riesgo. Siempre null.
Cuándo la parte no incluida en
holds se abona al saldo disponible de la cuenta, a medianoche UTC. El posted_at del webhook financial_activity.funds_available lleva el mismo valor cuando se abona la liquidación que lo libera. Null hasta que el pago esté pagado o cuando lees el pago como su comprador, y siempre null en las respuestas de lista: recupera el pago para obtenerlo.El envío que cumple este pago, con el prefijo
ship_. Null cuando no se envía nada o sin el permiso shipment:basic:read.La dirección de envío para bienes físicos, o null.
Propiedades
Propiedades
El estado del ciclo de vida del cargo:
open mientras el cobro está pendiente, paid una vez movido el dinero, pending mientras se compensa una vía de liquidación, void/uncollectible cuando terminó sin cobrarse.Opciones disponibles: draft, open, authorized, paid, pending, uncollectible, unresolved, voidLa lectura más detallada del pago que hace el dashboard, incorporando reembolsos, disputas y casos del Resolution Center.Opciones disponibles:
succeeded, requires_capture, pending, failed, blocked, past_due, canceled, price_too_low, uncollectible, refunded, auto_refunded, partially_refunded, dispute_warning, dispute_needs_response, dispute_warning_needs_response, resolution_needs_response, dispute_under_review, dispute_warning_under_review, resolution_under_review, dispute_won, dispute_warning_closed, resolution_won, dispute_lost, dispute_closed, resolution_lost, drafted, incomplete, unresolved, open_dispute, open_resolutionEl precio antes de descuentos, impuestos y comisiones.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
El impuesto sobre las ventas o IVA recaudado. Null cuando no se aplicaron impuestos.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
Si
tax_amount se sumó al precio (exclusive) o ya estaba incluido en él (inclusive).Cuánto de los impuestos recaudados se ha devuelto al comprador hasta ahora. Cero cuando el pago no llevaba impuestos o cuando no se ha reembolsado nada.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
El total para la cuenta: el precio tras los descuentos, más cualquier impuesto sumado al precio. Excluye las comisiones del comprador, que este paga por encima de este importe, por lo que no es necesariamente lo que muestra el extracto del comprador;
amount_charged es lo que se cobra al comprador.Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
El total convertido a USD en el momento del cargo, para informes en distintas monedas. Excluye el margen cambiario de adaptive pricing, que la cuenta no conserva. Null cuando lees el pago como su comprador.
Propiedades
Propiedades
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo,
"10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
El comprador. Null cuando el comprador es una cuenta en lugar de un usuario.
Propiedades
Propiedades
El user agent del navegador del comprador en el checkout. Null cuando el comprador no estuvo presente en el checkout, como en una renovación de suscripción, o sin el permiso member:basic:read.
Los resultados de Address Verification Service (AVS), nombre del titular de la tarjeta y Card Verification Value (CVV/CVC), o null cuando el procesador no devolvió ninguno o lees el pago como su comprador.
Propiedades
Propiedades
El resultado de Address Verification Service (AVS) para la dirección de facturación.
El Acquirer Reference Number (ARN) que rastrea este cargo a través de la red de tarjetas, o null cuando el procesador no devolvió ninguno.
El código de autorización del emisor de la tarjeta para este cargo, o null cuando el procesador no devolvió ninguno.
Si el nombre del titular de la tarjeta coincidió con los registros del emisor.
True cuando el pago puede anularse o cancelarse. La solicitud se rechaza si el pago ya no es elegible; consulta
POST /payments/\{id}/void.Payment

