VGSCheckoutAddCardConfiguration

public struct VGSCheckoutAddCardConfiguration : VGSCheckoutBasicConfigurationProtocol, VGSCheckoutPayoptBasicConfiguration

Holds configuration with predefined setup for work with payment orchestration app, confirms to VGSCheckoutBasicConfigurationProtocol.

Show on GitHub

defaultPayoptRouteId
Default Inbound route route id created in vault during default integration with payopt on dashboard.
Declaration
Swift

public static let defaultPayoptRouteId: String
Show on GitHub


                    
                    
                    CreateConfigurationSuccessCompletion

A callback to be run with a VGSCheckoutAddCardConfiguration on configuration setup succeed.

Declaration

Swift

public typealias CreateConfigurationSuccessCompletion = (_ configuration: inout VGSCheckoutAddCardConfiguration) -> Void

Parameters


                                configuration

VGSCheckoutAddCardConfiguration object, configuration.

Show on GitHub


                    
                    
                    CreateConfigurationFailCompletion

A callback to be run with an error when configuration setup fail.

Declaration

Swift

public typealias CreateConfigurationFailCompletion = (_ error: Error) -> Void

Parameters


                                error

Error object, the error on configuration setup fail.

Show on GitHub

Attributes

tenantId
String object, payment orchestration tenant id.
Declaration
Swift

public let tenantId: String
Show on GitHub
environment
String object, organization vault environment with data region.(e.g. “live”, “live-eu1”, “sandbox”). Default is sandbox.
Declaration
Swift

public let environment: String
Show on GitHub
routeId
String?, organization vault inbound route id, could be nil when vault has only one route.
Declaration
Swift

public let routeId: String?
Show on GitHub
subAccountId
String?, organization sub-acccount id, default nil.
Declaration
Swift

public var subAccountId: String?
Show on GitHub
isSaveCardOptionEnabled
Enable save card option. If enabled - button with option to save card for future payments will be displayed. Default is true. Default save card button state is selected. NOTE User choice for save card option will not be stored on VGS side.
Declaration
Swift

public var isSaveCardOptionEnabled: Bool
Show on GitHub
isRemoveCardOptionEnabled
A boolean flag indicating whether user can remove saved cards. Default is true.
Declaration
Swift

public var isRemoveCardOptionEnabled: Bool
Show on GitHub

Public


                    
                    
                    createConfiguration(accessToken:tenantId:environment:routeId:options:success:failure:)

Creates Add Card config.

Declaration

Swift

public static func createConfiguration(accessToken: String, tenantId: String, environment: String = "sandbox", routeId: String? = defaultPayoptRouteId, options: VGSCheckoutPaymentOptions? = nil, success: @escaping CreateConfigurationSuccessCompletion, failure: @escaping CreateConfigurationFailCompletion)

Parameters

`accessToken`	`String` object, should be valid access token for payment orchestration.
`tenantId`	`String` object, payment orchestration tenant id.
`environment`	`String` object, organization vault environment with data region.(e.g. “live”, “live-eu1”, “sandbox”). Default is `sandbox`.
`routeId`	`String?`, organization vault inbound route id, default is route id created during integration with payopt on VGS dashboard.
`options`	`VGSCheckoutPaymentOptions` object, additional checkout options, default is `nil`.
`success`	`CreateConfigurationSuccessCompletion` object, callback for configuration setup succeed.
`failure`	`CreateConfigurationFailCompletion` object, callback for configuration setup fail.

Show on GitHub

UI Configuration

uiTheme
Checkout UI elements configuration.
Declaration
Swift

public var uiTheme: VGSCheckoutThemeProtocol
Show on GitHub


                    
                    
                    billingAddressVisibility

Billing address visibility.

Declaration

Swift

public var billingAddressVisibility: VGSCheckoutBillingAddressVisibility { get set }

Show on GitHub


                    
                    
                    billingAddressCountryFieldOptions

Billing address country field options.

Declaration

Swift

public var billingAddressCountryFieldOptions: VGSCheckoutBillingAddressCountryOptions { get set }

Show on GitHub


                    
                    
                    billingAddressLine1FieldOptions

Billing address line 1 field options.

Declaration

Swift

public var billingAddressLine1FieldOptions: VGSCheckoutBillingAddressLine1Options { get set }

Show on GitHub


                    
                    
                    billingAddressLine2FieldOptions

Billing address line 2 field options.

Declaration

Swift

public var billingAddressLine2FieldOptions: VGSCheckoutBillingAddressLine2Options { get set }

Show on GitHub


                    
                    
                    billingAddressCityFieldOptions

Billing address city field options.

Declaration

Swift

public var billingAddressCityFieldOptions: VGSCheckoutBillingAddressCityOptions { get set }

Show on GitHub


                    
                    
                    billingAddressPostalCodeFieldOptions

Billing address postal code field options.

Declaration

Swift

public var billingAddressPostalCodeFieldOptions: VGSCheckoutBillingAddressPostalCodeOptions { get set }

Show on GitHub

formValidationBehaviour
Form validation behavior, default is .onSubmit.
Declaration
Swift

public var formValidationBehaviour: VGSCheckoutFormValidationBehaviour { get set }
Show on GitHub