ODWConfiguration

@objc
public class ODWConfiguration : NSObject

Configuration parameters required for setting up ApplePay

  • The merchant ID registered with Apple

    Important

    ODWApplePayLauncher.present(...) will throw an error if this is an empty string

    Declaration

    Swift

    public let merchantId: String

  • The company label that will be displayed on the ApplePay payment sheet

    Important

    ODWApplePayLauncher.present(...) will throw an error if this is an empty string

    Declaration

    Swift

    public let companyLabel: String

  • The three-letter ISO 4217 currency code for the payment.

    Important

    ODWApplePayLauncher.present(...) will throw an error if this is not a three character string

    Declaration

    Swift

    public let currencyCode: String

  • The merchant’s two-letter ISO 3166 country code.

    Important

    ODWApplePayLauncher.present(...) will throw an error if this is not a two character string

    Declaration

    Swift

    public let countryCode: String

  • Whether Apple Pay collects and returns a full billing address when processing transactions If false, only postal code and country code will be provided.

    Declaration

    Swift

    public let fullBillingAddressRequired: Bool

  • Whether Apple Pay collects and returns a phone number when processing transactions

    Declaration

    Swift

    public let phoneNumberRequired: Bool

  • Whether Apple Pay collects and returns a name when processing transactions

    Declaration

    Swift

    public let fullNameRequired: Bool

  • Whether Apple Pay collects and returns a phonetic name when processing transactions

    Declaration

    Swift

    public let fullPhoneticNameRequired: Bool

  • Whether Apple Pay collects and returns an email address when processing transactions

    Declaration

    Swift

    public let emailRequired: Bool

  • The list of card networks that are allowed for Apple Pay transactions

    Declaration

    Swift

    public let allowedCardNetworks: [PKPaymentNetwork]

  • Initializes a new ODWConfiguration object with the above parameters

    Declaration

    Swift

    @objc
public init(
    merchantId: String,
    companyLabel: String,
    currencyCode: String = "USD",
    countryCode: String = "US",
    emailRequired: Bool = false,
    phoneNumberRequired: Bool = false,
    fullNameRequired: Bool = false,
    fullPhoneticNameRequired: Bool = false,
    fullBillingAddressRequired: Bool = false,
    allowedCardNetworks: [PKPaymentNetwork] = [.visa, .amex, .masterCard, .discover]
)

    Parameters

    merchantId

    The merchant ID registered with Apple
    companyLabel

    The company label that will be displayed on the ApplePay payment sheet
    currencyCode

    The three-letter ISO 4217 currency code for the payment
    countryCode

    The merchant’s two-letter ISO 3166 country code
    emailRequired

    Whether Apple Pay collects and returns an email address when processing transactions
    phoneNumberRequired

    Whether Apple Pay collects and returns a phone number when processing transactions
    fullNameRequired

    Whether Apple Pay collects and returns a name when processing transactions
    fullPhoneticNameRequired

    Whether Apple Pay collects and returns a phonetic name when processing transactions
    fullBillingAddressRequired

    Whether Apple Pay collects and returns a full billing address when processing transactions
    allowedCardNetworks

    The list of card networks that are allowed for Apple Pay transactions