- TransactionConfig
- PaymentMethodSelected
- TransactionData
TransactionConfig es el objeto de configuración que se pasa al constructor de Transaction. Define la sesión, la configuración regional, los controladores y los indicadores de comportamiento de una sola transacción.En web,
TransactionConfig es un objeto simple que se pasa directamente a sdkPayments.transaction(config).Campos
- Web
- iOS
- Android
- React Native
En web no existe el campo
controller: conecta los eventos (onStatus, showLoading, createPayment) directamente como campos de la configuración. Consulta controller. Sin onStatus, el SDK registra una advertencia en la consola y nunca entrega el resultado. createPayment debe ser una función cuando está presente. De lo contrario, el constructor lanza un error.Campos solo de pago en web. Una configuración de inscripción no los admite, ni tampoco admite createPayment, showPayButton ni autoContinuePayment.checkoutSession o customerSession, pero no ambos. Consulta Validación.checkoutSession
ID de sesión para un flujo de pago. Pasa el valor que devuelve tu backend después de llamar a POST /v1/checkout/sessions.Mutuamente excluyente con customerSession.Consulta Sesiones para más información.customerSession
ID de sesión para un flujo de inscripción. Pasa el valor que devuelve tu backend después de llamar a POST /v1/customers/sessions.Mutuamente excluyente con checkoutSession.Consulta Sesiones para más información.countryCode
Código de país ISO para el pago (por ejemplo, US, CO).En iOS, Android y React Native, el SDK no valida el valor. En web, un start() de pago que monta un formulario o ejecuta un flujo headless comprueba el valor contra la lista de países del SDK. Un valor fuera de esa lista hace que start() se rechace con countryCode=<value> is not valid. Un start() de inscripción solo comprueba que el valor sea una cadena no vacía. Consulta Cobertura por país para ver la lista de países admitidos.language
Código de idioma ISO-639. Si se omite, usa el idioma del dispositivo o del navegador.Consulta Idiomas admitidos.controller (iOS, Android)
Objeto que implementa la interfaz TransactionController. Se usa para recibir los eventos de la transacción (onStatus, showLoading, createPayment).En iOS y Android, controller es obligatorio: onStatus es el único mecanismo para recibir el resultado de la transacción, por lo que una configuración sin controlador no entregaría ningún resultado a ningún lado. En iOS el SDK mantiene la referencia de forma débil, así que conserva la instancia viva mientras dure la transacción.En React Native, controller es un objeto simple con los métodos que necesitas. Solo onStatus es obligatorio: sin él, new Transaction(config) lanza TransactionConfig.controller must implement onStatus.En web, los controladores se conectan directamente como campos de la configuración (onStatus, showLoading, createPayment). En iOS y Android, pasas un único objeto controlador mediante el campo controller.Consulta Controladores.showStatusScreen
Indicador que controla si el SDK muestra su pantalla de resultado integrada cuando finaliza la transacción.false(predeterminado en iOS, Android y React Native). El SDK no muestra una pantalla de resultado. Recibes el estado final medianteonStatusy muestras tu propia interfaz.true(predeterminado en web). El SDK muestra su pantalla de resultado. En iOS la pantalla no se muestra paraUSER_CANCEL.
onStatus siempre se invoca, sin importar este indicador.autoContinuePayment
Controla si el SDK continúa automáticamente el flujo de pago después de crearlo. Cuando es true (predeterminado), el SDK gestiona internamente 3DS y la consulta periódica del estado. Establécelo en false si quieres controlar manualmente el flujo posterior a la creación.En web, el indicador se aplica solo cuando pasas createPayment. Sin un manejador, el SDK crea y continúa el pago por sí mismo. PayPal ignora false y siempre continúa, porque su ventana emergente se completa dentro del paso de continuación del SDK.En iOS el indicador se aplica tanto si sobrescribes createPayment como si no. Con false y el manejador predeterminado, el SDK crea el pago, cierra sus propias vistas y se detiene.Con false, el SDK se detiene una vez creado el pago: no consulta el estado, no ejecuta 3DS y no se invoca onStatus para la transacción.saveCardEnabled (iOS)
Indicador que controla si el formulario de tarjeta ofrece la casilla de guardar tarjeta en los pagos. El valor predeterminado es false.false(predeterminado). El formulario de tarjeta no tiene casilla de guardar tarjeta.true. El formulario de tarjeta muestra la casilla, sin marcar. Si el usuario la marca, la tarjeta se almacena cuando el pago es exitoso.
card. Consulta card.elementSelector (Web only)
Selector CSS, o el propio HTMLElement, del nodo en el que el SDK renderiza un formulario. Es obligatorio cuando start({ paymentMethod }) monta un formulario de pago. Sin él, start() se rechaza con elementSelector=undefined is not valid. Es opcional para el formulario de inscripción, que de lo contrario se renderiza en un contenedor que el SDK agrega a <body>. Los flujos headless y los secure fields lo ignoran. Las vistas de billeteras y de lista usan su propio elementSelector en .mount().showPayButton (Web only)
Indica si el formulario que monta el SDK muestra el botón de pago propio del SDK. Establécelo en false para usar tu propio botón: monta el formulario con transaction.start({ paymentMethod }) y llama a transaction.submit() cuando el usuario confirme.Solo para flujos de pago. Los formularios de inscripción siempre muestran el botón del SDK.onChange (Web only)
Callback al que el SDK llama con { form: { isValid } } cada vez que cambia la validez del formulario montado. isValid es true cuando todos los campos obligatorios, incluidos los secure fields, son válidos.card (Web only)
Opciones del formulario de tarjeta: styles, type, saveCardEnabled, vaultOnSuccess, texts, documentEnable, isCreditCardProcessingOnly y fonts, además de los callbacks onChange, onGetInstallments y onInstallmentSelected. Consulta Estilos y onInstallmentSelected.texts (Web only)
Reemplazos de las etiquetas de los botones: customerForm.submitButton y paymentOtp.sendOtpButton.externalButtons (Web only)
Opciones de botón por billetera (googlePay, applePay, samsungPay, paypal, paypalBraintree, revolutPay) y el callback onShippingAddressChanged. El .mount() de la vista de cada billetera acepta las mismas opciones de botón.appearance (iOS, Android)
Objeto de personalización visual para las vistas integradas del SDK: familia tipográfica y colores. No está disponible en web. En React Native, los colores son cadenas hexadecimales.Consulta Estilos para ver el conjunto completo de opciones.viewController (iOS only)
Referencia opcional al UIViewController que el SDK debe usar para presentar su interfaz.Es opcional cuando tu app está construida íntegramente con SwiftUI. Es obligatorio si quieres que el SDK presente desde un view controller de UIKit específico.Cuando pasas nil, el SDK presenta desde el view controller raíz de la ventana principal. Si todavía no hay ventana, por ejemplo cuando start se ejecuta antes de que la escena esté activa, la transacción termina con INTERNAL_ERROR, message.code NO_PRESENTATION_ANCHOR y message.context Transaction.start. Pasa viewController, o inicia después de que exista la ventana.Este campo existe solo en iOS.Validación
La configuración rechaza que se establezcancheckoutSession y customerSession a la vez, o ninguna de las dos. La forma en que cada plataforma lo aplica es distinta:En web, el constructor también lanza un error si falta
countryCode o si createPayment se establece en algo distinto de una función. Si falta onStatus, el constructor no lanza un error. Registra una advertencia en la consola y el resultado de la transacción nunca se entrega.Más allá de esas comprobaciones, el SDK no valida los valores de countryCode, language ni de otros campos. Los valores no válidos pueden aparecer más adelante como errores del backend o comportamiento inesperado. En web, start() comprueba countryCode y elementSelector más adelante. Consulta countryCode y elementSelector.Relacionado
- Objetos que recibes. Lo que el SDK te devuelve:
StatusyOneTimeToken. - Resumen de controladores. Los callbacks que pasas dentro de
TransactionConfig. - Primeros pasos. La guía paso a paso de la API unificada.