Payment Widget - iOS
El Payment Widget es una herramienta integrada que permite a los comercios ofrecer múltiples métodos de pago a sus clientes de manera sencilla y eficiente. Este widget es compatible tanto con Métodos de Pago Alternativos (APMs) como con tarjetas de crédito y débito, proporcionando flexibilidad en las opciones de pago para los usuarios.
El Payment Widget soporta:
- Métodos de Pago Alternativos (APMs): como OXXO, KueskiPay, entre otros.
- Tarjetas de Crédito y Débito: MasterCard, Visa, American Express, etc.
Paso 1: Completar los Primeros Pasos
Antes de integrar el Payment Widget, es necesario que completes la sección de primeros pasos. En esta sección, te explicamos los requisitos necesarios y cómo inicializar el SDK. Puedes encontrar más información en Primeros Pasos con el SDK de iOS.
Una vez que hayas completado estos pasos, podrás continuar con el paso 2.
Paso 2: Mostrar el Widget
Para mostrar el Payment Widget, llama a la función initPaymentWidget pasando los siguientes datos:
deunaSDK.initPaymentWidget(
orderToken: "<DEUNA order token>",
userToken: "<DEUNA user token>", // optional
cssFile: "<DEUNA theme ID to customize the look and feel of the widget>", // optional
callbacks: PaymentWidgetCallbacks(
onSuccess: { order in
self.deunaSDK.close() // Cierra el widget de pago
},
onError: { type in
// Manejo de errores
},
onClosed: { action in
// Widget cerrado
},
onCardBinDetected: { metadata in
guard metadata != nil else {
// Tu código aquí
}
}
)
)
Parámetros
Atributos | Descripción |
---|---|
orderToken | El orderToken es un token único generado para la orden de pago. Este token es generado a través del API de DEUNA y debes implementar el endpoint correspondiente en tu backend para obtener esta información. IMPORTANTE: Al momento de crear la orden con la API de DEUNA no se debe definir una URL de redirección (redirect_url) para que el callback onSuccess se ejecute correctamente. |
userToken (Opcional) | El bearer token del usuario de DEUNA. Cuando este es enviado, todas las acciones dentro del widget van a hacer sobre este usuario de DEUNA. Importante: para que este userToken sea usado y se le muestren las tarjetas guardadas al cliente, el correo asociado a ese userToken debe ser el mismo que se envía al crear la orden en billing_address.email . En caso que ambos correos no coincidan, se usará el flujo sin mostrar las tarjetas por seguridad. |
callbacks | Los callbacks son funciones de retorno que se encargan de escuchar y manejar los eventos del widget de pago. Estos eventos permiten gestionar acciones específicas basadas en el estado del pago. Los principales callbacks incluyen: onSuccess , onError , onClosed , onCanceled , onCardBinDetected , onInstallmentSelected |
styleFile (Opcional) | UUID proporcionado por DEUNA. Esto aplica si quieres configurar un archivo custom styles personalizado (Cambiar colores, textos, logo, etc). Si se proporciona un valor válido para styleFile el payment widget utilizará la configuración de la UI proporcionada por la configuración del tema que coincida con el UUID proporcionado. |
paymentMethods (Opcional) | Una lista métodos de pago permitidos. Este parámetro determina qué tipo de widget se debe renderizar. |
IMPORTANTE: Configuración para Descarga de Vouchers en iOS
En iOS, para métodos de pago que generan la descarga de un voucher o comprobante (por ejemplo, pagos con OXXO PAY), es necesario realizar una configuración adicional en tu aplicación.
Debes agregar la clave NSPhotoLibraryUsageDescription en el archivo Info.plist. Esto permitirá que tu app tenga los permisos necesarios para descargar y almacenar comprobantes en el dispositivo del usuario.
Ejemplo de configuración en Info.plist:
<key>NSPhotoLibraryUsageDescription</key> <string>La aplicación necesita acceso a la galería para descargar y almacenar comprobantes de pago.</string>
2.1. Mostrar u ocultar métodos de pago
El Payment Widget puede desplegar varios métodos de pago disponibles para una orden, sin que el comercio tenga que agregar individualmente cada botón de APM en su Frontend.
Al invocar la función initPaymentWidget, el parámetro paymentMethods define los métodos de pago que el widget mostrará:
-
Si se pasa 1 solo método en paymentMethods el widget abre automáticamente el formulario del método de pago sin mostrar botones de otros AMPs.
deunaSDK.initPaymentWidget(
orderToken: "<DEUNA order token>",
userToken: ..., // optional
styleFile: ..., // optional
callbacks: ...,
paymentMethods: [
[
"paymentMethod": "voucher",
"processors": ["payu_oxxo_cash"]
]
]
)
-
Si se especifica más de 1 método de pago en el parámetro paymentMethods, el widget solo mostrará esos métodos habilitados los cuales deben estar configurados a nivel comercio.
deunaSDK.initPaymentWidget(
orderToken: "<DEUNA order token>",
userToken: ..., // optional
styleFile: ..., // optional
callbacks: ...,
paymentMethods: [
[
"paymentMethod": "bnpl",
"processors": ["kueski"]
],
[
"paymentMethod": "voucher",
"processors": ["payu_oxxo_cash"]
]
]
)
-
Si no se especifica una lista de métodos en paymentMethods y no se utilizó el parámetro include_payment_options al crear la orden, el widget mostrará todos los métodos de pago configurados para el comercio.
deunaSDK.initPaymentWidget( orderToken: "<DEUNA order token>", userToken: ..., // optional styleFile: ..., // optional callbacks: ... )
2.2. Tabla de Prioridades de Configuración de Métodos de Pago
La siguiente tabla muestra como el payment widget decide que formas de pago debe mostrar cuando no se pasa el parámetro paymentMethods.
Prioridad | Fuente de Configuración | Descripción | Comportamiento en caso de un solo método de pago |
---|---|---|---|
1 | Métodos de pago pasados al ejecutar la función .initPaymentWidget | Los métodos de pago se muestran según los que se pasan al iniciar el widget, siempre y cuando estén activados y configurados a nivel comercio. | Si solo se pasa un método de pago, el widget abre automáticamente el formulario del método de pago sin mostrar botones. |
2 | Orden e include_payment_options | Se revisa la orden para verificar si include_payment_options tiene métodos de pago que estén configurados y activados a nivel comercio. Los métodos no configurados no se muestran. | Si solo se pasa un método de pago, el widget abre automáticamente el formulario del método de pago sin mostrar botones. |
3 | Métodos configurados a nivel comercio (API /payment-methods ) | Si no se pasa ningún método de pago ni en la función .initPaymentWidget ni en include_payment_options al momento de crear la order, se toman los métodos configurados a nivel comercio. | Si solo se pasa un método de pago, el widget abre automáticamente el formulario del método de pago sin mostrar botones. |
Paso 3: Escuchar los Eventos del Widget de Pago
Cuando una transacción es exitosa o falla, es importante actualizar tu interfaz para notificar a los usuarios sobre el resultado de la transacción. Esto lo puedes realizar escuchando los eventos del widget de pago mediante los callbacks.
La instancia de la clase PaymentWidgetCallbacks
pasada a la función initPaymentWidget
te permite escuchar los eventos del widget mediante callbacks. Define los callbacks respectivos para actualizar la interfaz de tu app.
3.1. Callbacks
Callback | ¿Cuándo se dispara? |
---|---|
onSuccess | Se ejecuta cuando se completó el pago. Este callback contiene un parámetro de tipo [String:Any] con la información de la orden. |
onError | Se ejecuta cuando ocurre un error. Este callback contiene un parámetro tipo PaymentsError el cual identifica el tipo de error producido. Consulta un ejemplo de la respuesta del callback aquí. |
onClosed (Opcional) | Se ejecuta cuando se cierra el widget de pago. Este callback contiene un parámetro de tipo enum CloseAction con los siguientes valores:- .userAction : Cuando el widget fue cerrado manualmente por el usuario (presionando en el botón cerrar X o deslizando el modal hacia abajo) sin que la operación se haya completado.- .systemAction : Cuando el widget se cierra debido a la ejecución de la función close . |
onCardBinDetected (Opcional) | Se ejecuta cuando el widget de pago detecta el BIN de una tarjeta de crédito o débito ingresada o cuando el usuario borra el número de la tarjeta ingresada. Este callback contiene un parámetro de tipo [String:Any] con la información del bin y la marca de la tarjeta ingresada. NOTA: El parámetro de tipo CardBinMetadata será nulo cuando el usuario elimina el texto ingresado en el campo del número de tarjeta. |
onInstallmentSelected (Opcional) | Si la orden se puede diferir, este callback se ejecutará cuando el usuario seleccione los meses a diferir. Este callback contiene un parámetro de tipo [String:Any] con la información de los meses a diferir seleccionados por el usuario. |
onPaymentProcessing (Opcional) | Este callback se ejecutará cuando el usuario presiona en el botón pagar y se esta procesando el pago. NOTA: Si existe algún campo incorrecto en el formulario de pago este evento no se ejecutará. |
onEventDispatch (Opcional) | Se ejecuta en todas los eventos que pueda producir el widget. Este callback contiene un parámetro de tipo CheckoutEvent y la data asociada a dicho evento. |
NOTA: Utiliza el callback onError para identificar si el widget no puedo ser mostrado o si ocurrió un error al procesar el pago.
onError: { error in // The widget could not be loaded if error.type == .initializationFailed { self.deunaSDK.close() // close the widget return } // The payment was failed if(error.type == .paymentError){ // YOUR CODE HERE } }
Paso 4 (Opcional): Cerrar el Widget
Por defecto, el widget de pago solo se cierra cuando el usuario presiona el botón de cerrar del widget o cuando presiona el botón de "retroceso" en iOS. Para cerrar el modal cuando un pago es exitoso o cuando ocurre un error, debes llamar a la función close
.
El siguiente código de ejemplo muestra cómo cerrar el widget cuando un pago es exitoso:
deunaSDK.initPaymentWidget(
orderToken: "<DEUNA order token>",
userToken: "<DEUNA user token>", // optional
callbacks: PaymentWidgetCallbacks(
onSuccess: { order in
self.deunaSDK.close() // Cierra el widget de pago
// Tu código adicional
},
onError: nil,
...
)
)
Paso 5 (Opcional): Personalizar la apariencia del widget
Si el payment widget esta visible y quieres personalizar la apariencia del mismo utiliza la función setCustomStyle
.
Consulta la siguiente documentación para conocer más a detalle todas las opciones de personalización del payment widget.
A continuación se muestra un ejemplo de como cambiar los colores y el logo del payment widget mediante setCustomStyle
// Extension to convert a String to a Dictionary(JSON)
extension String {
func toDictionary() -> [String: Any]? {
guard let data = data(using: .utf8) else {
return nil
}
do {
let dictionary = try JSONSerialization.jsonObject(with: data, options: []) as? [String: Any]
return dictionary
} catch {
print("Error: \(error.localizedDescription)")
return nil
}
}
}
.
.
.
deunaSDK.initPaymentWidget(
orderToken: "<DEUNA order token>",
userToken: "<DEUNA user token>", // optional
callbacks: PaymentWidgetCallbacks(
onCardBinDetected: { metadata in
self.deunaSDK.setCustomStyle(data: """
{
"theme": {
"colors": {
"primaryTextColor": "#023047",
"backgroundSecondary": "#8ECAE6",
"backgroundPrimary": "#8ECAE6",
"buttonPrimaryFill": "#FFB703",
"buttonPrimaryHover": "#FFB703",
"buttonPrimaryText": "#000000",
"buttonPrimaryActive": "#FFB703"
}
},
"HeaderPattern": {
"overrides": {
"Logo": {
"props": {
"url": "https://images-staging.getduna.com/ema/fc78ef09-ffc7-4d04-aec3-4c2a2023b336/test2.png"
}
}
}
}
}
""".toDictionary() ?? [:]
)
}
...
)
)
Paso6 (Opcional): Refrescar el widget de pago
La función refetchOrder
actualiza el widget de pago y retorna los datos de la orden actualizada.
Esta función es útil, por ejemplo, cuando el comercio ofrece promociones. Un caso común es una "promoción del 20% al pagar con Mastercard". En este escenario, el comercio escucha el evento onCardBinDetected para identificar la franquicia de la tarjeta. Luego, el comercio actualiza la orden en DEUNA (siendo el responsable de calcular las promociones) y, a través de esta función, notifica al widget para que se actualice, ya que el monto de la orden podría haber cambiado.
A continuación se muestra un ejemplo del uso de la función refetchOrder
.
deunaSDK.initPaymentWidget(
orderToken: "<DEUNA order token>",
userToken: "<DEUNA user token>", // optional
callbacks: PaymentWidgetCallbacks(
onCardBinDetected: { metadata in
if let cardBrand = metadata["cardBrand"] as? String, cardBrand == "Mastercard" {
self.deunaSDK.refetchOrder { order in
print("ORDER: \(order)")
}
}
}
...
)
)
Paso 7 (Opcional): Revisar Ejemplo Demo App
Para comprender mejor la integración del Payment Widget, revisa el proyecto de ejemplo proporcionado por DEUNA. Este ejemplo te ayudará a entender mejor cómo implementar el widget en tu aplicación iOS.
Para acceder al proyecto de ejemplo y obtener más información, Consulta la documentación del Ejemplo de Proyecto para iOS.
Updated 20 days ago