Developer tools

Card vault - iOS

The Card vault integrates functionalities like wallets and tokenization without processing the payment.

DEUNA's Payment Vault contains different types of widgets that allow you to:

  • Save credit and debit cards securely in the Vault.
  • Make payments with Click To Pay using the Click To Pay Widget.

Initialize the Widget

Before integrating the Payment Widget, complete the First Steps - iOS.

1. Display the Widget

Display the Payment Vault Widget in two ways:

  • Modal: Call a function to show the Widget.
  • SwiftUI: Show the embedded Widget.

Show in a Modal

To show the Payment Widget in a modal (pageSheet) call the initElements function passing the following data:

let callbacks = ElementsCallbacks(
  onSuccess: { response in
    self.deunaSDK.close() // Close the Vault Widget
  },
  onError: { error in
    // Error handling
    self.deunaSDK.close() // Close the Vault Widget
  },
  onClosed: { action in
    // The Vault Widget was closed
  },
  onEventDispatch: { type, response in
    // Listen to events
  }
)

// Show the Vault Widget
deunaSDK.initElements(
  userToken = "<DEUNA user token>", // optional
  userInfo = DeunaSDK.UserInfo("Esteban", "Posada", "[email protected]"), // optional
  callbacks: callbacks,
  types: ...// optional, If this value is not passed, the VAULT Widget will be shown by default.
  widgetExperience: ElementsWidgetExperience( // Optional
      userExperience: ElementsWidgetExperience.UserExperience(
        showSavedCardFlow: true, // Optional
        defaultCardFlow: true // Optional
      )
   )
)

Show Embedded Widget (SwiftUI)

Use the DeunaWidget view to show the payment widget embedded in your app with SwiftUI.

import DeunaSDK
import SwiftUI

struct YourView: View {
    let deunaSDK: DeunaSDK
    var body: some View {
        VStack {
            DeunaWidget(
                deunaSDK: deunaSDK,
                configuration: ElementsWidgetConfiguration(
                    ...
                    callbacks: PaymentWidgetCallbacks(
                        onSuccess: { res in
                           // NOTE: Explicitly release widget resources
                           // when no longer needed
                           // to prevent memory leaks and ensure proper cleanup.
                            deunaSDK.dispose()
                        },
                        onError: { error in
                            
                        },
                        onEventDispatch: { event, data in
                            
                        }
                    )
                )
            )
        }
    }
}

Parameters

ParameterModalEmbeddedDescription
callbacks✅✅An instance of the ElementsCallbacks class, which contains callbacks that will be called in case of success, error, or when the widget is closed.
userToken (Optional)✅✅The DEUNA user bearer token. When this is sent, all actions within the widget will be performed on this DEUNA user.

Important: if this field is used, the userInfo field should not be sent.
orderToken(Optional)✅✅The orderToken is a unique token generated for the payment order. This token is generated through DEUNA's API and you must implement the corresponding endpoint in your backend to obtain this information.

IMPORTANT: User information available in billing_address can be extracted to use within the widget.
userInfo (Optional)✅✅Instance of the DeunaSDK.ElementsUserInfo class that contains firstName, lastName and email.

Important: in case the userToken is not sent or is an empty string (""), this parameter is required.
styleFile (Optional)✅✅UUID provided by DEUNA. This applies if you want to configure a custom custom styles file (Change colors, texts, logo, etc). If a valid value is provided for styleFile the vault widget will use the UI configuration provided by the theme configuration that matches the provided UUID.
types(Optional)✅✅An instance of type [[String:Any]] with a list of widget types that the initElements function should render.

Allowed values are: vault and click_to_pay.

Example: [ [ "name": ElementsWidget.vault ] ]

NOTE: If this parameter is not passed, DEUNA's Vault Widget for saving credit and debit cards will be shown by default.
language(Optional)✅✅This parameter allows you to specify the language in which the widget interface will be displayed. It must be provided as a valid language code (for example, "es" for Spanish, "en" for English, "pt" for Portuguese).

Behavior:

- If provided: The widget will use the language specified in this parameter, regardless of the merchant configuration.
- If not provided: The widget will use the language configured by the merchant.
widgetExperience(Optional)✅✅Overrides merchant configurations. Currently supported by the widget are the following:

userExperience.showSavedCardFlow: Shows card saving toggle.

userExperience.defaultCardFlow: Shows toggle to save the card as default.

Click To Pay Widget

Make payments with Click to Pay using the types parameter of the initElements function.

📘

The userInfo parameter is mandatory to be able to show the ClickToPay Widget.

        deunaSDK.initElements(
            callbacks: ElementsCallbacks(
                onSuccess: { data in 
                },
                onError: { error in 
                },
                onClosed: nil,
                onEventDispatch: { type, data in
                }
            ),
            userInfo: DeunaSDK.UserInfo(// required for Click To Pay
              firstName: "Esteban", 
              lastName: "Posada",
              email: "[email protected]"
            ),
            types: [
                [
                    "name": ElementsWidget.clickToPay // PASS THIS FOR CLICK TO PAY
                ]
            ]
        )

2. Listen to Widget Events

It is crucial to properly handle Widget events to offer a smooth experience to users. Define the necessary callbacks to update your application interface.

Callbacks

CallbackModalEmbeddedWhen is it triggered?
onSuccess✅✅Executed when a card is saved successfully or when the Click to Pay payment was successful.
This callback contains a parameter of type [String:Any]
onError✅✅Executed when an error occurs while processing the operation of the displayed widget.
This callback contains a parameter of type ElementsError.
onClosed✅❌Executed when the payment widget is closed.

This callback contains a parameter of enum type CloseAction with the following values:

- .userAction: When the widget was manually closed by the user (by pressing the close X button or swiping the modal down) without the operation being completed.

- .systemAction: When the widget closes due to the execution of the close function.
onEventDispatch✅✅Executed when specific events are detected in the widget. This callback contains a parameter of type ElementsEvent and the data [String:Any] linked to the event.

3. Close the Widget

When the widget is shown in a modal, it only closes when the user presses the widget's close button or when they press the "back" button on iOS.

To close the modal when an operation is successful or when an error occurs, you must call the close function.

The following example code shows how to close the widget:

let callbacks = ElementsCallbacks(
  onSuccess: { response in
    self.deunaSDK.close() // Close the Vault Widget
    // Your additional code
  }
)

// Show the Vault Widget
deunaSDK.initElements(
  userToken = "<DEUNA user token>", // optional
  userInfo = DeunaSDK.UserInfo("Esteban", "Posada", "[email protected]"), // optional
  callbacks: callbacks
)

Optional Features

In addition to the mandatory steps to operate the widget, you have the following customization options:

Customize Widget Appearance

Use the setCustomStyle function to customize the Widget appearance.

await DeunaSDK.setCustomStyle({...});

📘

For more information, go to Style Customization.

Example

// 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
        }
    }
}

.
.
.
let callbacks = ElementsCallbacks(
  onSuccess: ...,
  onError: ...,
  onClosed: ...,
  onEventDispatch: { type, response in
    // Listen to events
           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() ?? [:]
        )     
  }
)
.
.
.

deunaSDK.initElements(
  userToken = "<DEUNA user token>", // optional
  userInfo = DeunaSDK.UserInfo("Esteban", "Posada", "[email protected]"), // optional
  callbacks: callbacks
)

Check Demo App Example

To better understand the Vault Widget integration, review the example project provided by DEUNA. This example will help you better understand how to implement the widget in your iOS application.

To access the example project and get more information, check the iOS Project Example documentation.

Hide Pay Button (Embedded Widget)

When the widget is shown embedded with the DeunaWidget view, you can hide the widget's pay button using the hidePayButton: true parameter.

DeunaWidget(
  deunaSDK: deunaSDK,
  configuration: ElementsWidgetConfiguration(
    hidePayButton: true // Set true to hide the pay button
    ...
  )
)

If DEUNA's widget pay button is hidden, you must use the .isValid {} and .submit{} functions to complete the payment flow.

MethodDescriptionResponse
deunaSdk.isValid{}Validates if the entered information is correct and if the payment can be processed.true if the information is valid, false otherwise.
deunaSdk.submit{}Executes the payment process, equivalent to pressing the pay button. Performs the same internal validations.{ status: "success", message: "Payment processed successfully" } or { status: "error", message: "The submit flow is not available" }

Considerations:

  • If hidePayButton is false or not defined, the pay button will be visible and the payment flow will work automatically.
  • If hidePayButton is true, the pay button will not be shown and payment must be managed with submit{}.
  • It is recommended to use isValid{} before calling submit{} to avoid errors in the payment process.
  • If the payment flow is not yet available, submit{} will always return an error with the message "The submit flow is not available"