Skip to main content
Créalo a partir de un confirmation token que los payment elements recopilaron en modo de configuración, o a partir de un método de pago ya registrado para volver a verificarlo. Ejecuta el mismo flujo de recopilación que un pago, por lo que es posible que el comprador todavía deba completar un paso: 3D Secure en una tarjeta, una inscripción alojada o la vinculación de una cuenta bancaria. La respuesta de creación es el setup intent tal como se creó, no su resultado. Pasa su client_secret a handleNextAction de los elements, o consulta periódicamente Obtener estado para ver cuánto ha avanzado la configuración y qué queda pendiente. Una vez que llega a succeeded, payment_method_id identifica el método guardado y Create Payment lo cobra.

Endpoints

Atributos

string
requerido
ID del setup intent, con el prefijo sint_.
string | null
requerido
La cuenta para la que se guarda el método de pago, con el prefijo biz_.
string | null
requerido
La configuración de checkout a través de la cual se creó esta configuración, con el prefijo ch_. Es null para una configuración creada mediante esta API en lugar de un checkout alojado.
string | null
requerido
La credencial que presenta la interfaz del comprador para consultar esta configuración y definir su URL de retorno; pásala a handleNextAction de los elements. Solo está en configuraciones creadas mediante esta API, y siempre es null en las respuestas de listado; obtén el setup intent para conseguirla.
string
requerido
Cuándo se creó el setup intent, como marca de tiempo ISO 8601.
object | null
requerido
Por qué la configuración terminó donde terminó, o null cuando nada ha fallado. Está presente en canceled: un comprador que abandonó no tiene código, uno rechazado por el proveedor sí. Se elimina una vez que la configuración se completa correctamente.

Propiedades

string | null
requerido
Una clasificación del fallo legible por máquina, p. ej. enrollment_declined. Ausente cuando el comprador simplemente abandonó la configuración.
string | null
requerido
Una explicación del fallo legible por humanos.
string | null
requerido
El registro de miembro del comprador en la cuenta, con el prefijo mber_. Es null sin el permiso member:basic:read, a menos que quien llama sea el comprador.
object | null
requerido
Tus propios datos clave-valor adjuntados cuando se creó el setup intent.
object | null
requerido
El método detrás de esta configuración preparado para mostrarse: un nombre visible para el comprador, el conjunto de iconos estándar y la marca de la tarjeta, los últimos cuatro dígitos, el número de identificación del emisor, el vencimiento y el ID de transacción de la red cuando era una tarjeta. Es null hasta que se recopila un método.

Propiedades

object | null
requerido
Solo para 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, el vencimiento y el ID de transacción de la red.

Propiedades

string | null
requerido
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. Es null cuando la bóveda no registró la red.
number | null
requerido
El mes de vencimiento de la tarjeta, de 1 a 12. Es null cuando la bóveda no lo registró.
number | null
requerido
El año de vencimiento de la tarjeta, de cuatro dígitos. Es null cuando la bóveda no lo registró.
string | null
requerido
El número de identificación del emisor, también llamado BIN: los primeros seis u ocho dígitos de la tarjeta, que identifican al banco emisor. Es null cuando el procesador no lo informó.
string | null
requerido
Los últimos cuatro dígitos de la tarjeta, cuando se capturaron.
string | null
requerido
El ID de transacción de la red que esta cuenta usa para la tarjeta. Es el propio ID de esta cuenta, de su primer cargo o verificación con el cliente presente en la tarjeta, cuando Whop tiene uno. De lo contrario, es un ID de transacción de la red anterior para esta tarjeta, que puede provenir de la transacción de otra cuenta o haberse traído con la tarjeta. Cítalo como la transacción previa en un cargo posterior iniciado por el comerciante con esta tarjeta en esta cuenta. Es null hasta que exista uno. Un webhook enviado cuando se registra un pago por primera vez puede incluir null, así que obtén el pago para leerlo.
string
requerido
Nombre del instrumento visible para el comprador: “Visa •••• 4242” cuando se obtuvo la tarjeta; de lo contrario, el propio nombre del método (“Klarna”).
object
requerido
El conjunto de iconos estándar: formas cuadrada y de tarjeta, cada una en variantes de color claras y oscuras.

Propiedades

object
requerido
El mosaico con proporciones de tarjeta de crédito (48x30).

Propiedades

object
requerido
La variante de color para superficies oscuras.

Propiedades

string
requerido
Alternativa rasterizada al tamaño nativo de la forma.
string
requerido
Alternativa rasterizada a doble densidad.
string
requerido
Alternativa rasterizada a cuádruple densidad.
string
requerido
El archivo vectorial. Úsalo preferentemente en cualquier lugar donde se renderice SVG.
object
requerido
La variante de color para superficies claras.

Propiedades

string
requerido
Alternativa rasterizada al tamaño nativo de la forma.
string
requerido
Alternativa rasterizada a doble densidad.
string
requerido
Alternativa rasterizada a cuádruple densidad.
string
requerido
El archivo vectorial. Úsalo preferentemente en cualquier lugar donde se renderice SVG.
object
requerido
El mosaico cuadrado (32x32).

Propiedades

object
requerido
La variante de color para superficies oscuras.

Propiedades

string
requerido
Alternativa rasterizada al tamaño nativo de la forma.
string
requerido
Alternativa rasterizada a doble densidad.
string
requerido
Alternativa rasterizada a cuádruple densidad.
string
requerido
El archivo vectorial. Úsalo preferentemente en cualquier lugar donde se renderice SVG.
object
requerido
La variante de color para superficies claras.

Propiedades

string
requerido
Alternativa rasterizada al tamaño nativo de la forma.
string
requerido
Alternativa rasterizada a doble densidad.
string
requerido
Alternativa rasterizada a cuádruple densidad.
string
requerido
El archivo vectorial. Úsalo preferentemente en cualquier lugar donde se renderice SVG.
number | null
requerido
Solo para 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.
string
requerido
El identificador del tipo de método de pago, p. ej. card, klarna, apple_pay.
string | null
requerido
El método de pago guardado, con el prefijo payt_, listo para cobrarse con Create Payment. Es null hasta que la configuración tenga el estado succeeded.
string | null
requerido
El tipo de instrumento que se guarda, por ejemplo card o us_bank_account.
string | null
requerido
A dónde llega el comprador después de completar un paso externo, o null para dejarlo donde está.
string
requerido
Cuánto ha avanzado la configuración. Un 201 o 200 significa que respondimos, no que el método se haya guardado: ramifica siempre según este campo. requires_action: el comprador tiene un paso pendiente; pasa client_secret a los elements o consulta periódicamente Retrieve setup status. processing: el procesador está decidiendo. succeeded: el método está guardado, y solo este estado significa guardado. canceled: abandonado o rechazado; consulta last_setup_error.Opciones disponibles: processing, succeeded, canceled, requires_action
string | null
requerido
Comportamiento de 3D Secure para los pagos con tarjeta en sesión admitidos. 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 $1,000 o más usan mandate_if_required a menos que se seleccione mandate_challenge. Los requisitos de riesgo y de recuperación de autenticación pueden anular la preferencia. Es la configuración solicitada para esta configuración, o null cuando no está definida.Opciones disponibles: mandate_challenge, mandate_if_required, frictionless_if_required
boolean
requerido
True cuando el comprador completó 3D Secure al guardar este método de pago.
string
requerido
Cuándo se actualizó el setup intent por última vez, como marca de tiempo ISO 8601.
object | null
requerido
El usuario que guarda el método de pago. Es null cuando el comprador es una cuenta en lugar de un usuario.

Propiedades

string
requerido
ID de 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 definió 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 definió ninguna imagen.
string
requerido
Nombre de usuario público.
SetupIntent