ODWPaymentDataProtocol

@objc
public protocol ODWPaymentDataProtocol : NSObjectProtocol

Represents the payment data authorized by Apple Pay

  • Encrypted token string from Apple Pay that represents the selected payment method.

    Declaration

    Swift

    @objc
var token: String { get }

  • The payment network used for this transaction

    Important

    APIs within Olo’s ordering ecosystem have specific values that need to be passed to API endpoints. Use PKPaymentNetwork.oloDescription() or the oloPaymentNetworkDescription property for that

    Declaration

    Swift

    @objc
var paymentNetwork: PKPaymentNetwork? { get }

  • The description of the payment network used for this transaction as required by Olo’s ordering ecosystem.

    Important

    If this has a value of "Unsupported" then attempting to process the payment with Olo’s ordering ecosystem will fail

    Declaration

    Swift

    @objc
var oloPaymentNetworkDescription: String { get }

  • The description of the card. This is commonly the payment network and the last four digits of the payment account number.

    Declaration

    Swift

    @objc
var cardDescription: String { get }

  • The billing address associated with the transaction. The ODWAddressProtocol.countryCode and ODWAddressProtocol.postalCode fields will always be set. Other fields will only be provided if ODWConfiguration.fullBillingAddressRequired is true.

    Declaration

    Swift

    @objc
var billingAddress: ODWAddressProtocol { get }

  • The email associated with the transaction or an empty string if unavailable. Will only be provided if ODWConfiguration.emailRequired is true.

    Declaration

    Swift

    @objc
var email: String { get }

  • The last four digits of the payment account number, if they are returned by Apple, otherwise an empty string.

    Declaration

    Swift

    @objc
var lastFour: String { get }

  • The phone number associated with the transaction or an empty string if unavailable. Will only be provided if ODWConfiguration.phoneNumberRequired is true.

    Declaration

    Swift

    @objc
var phoneNumber: String { get }

  • The full name associated with the transaction or an empty string if unavailable. Will only be provided if ODWConfiguration.fullNameRequired is true.

    Declaration

    Swift

    @objc
var fullName: String { get }

  • The full phonetic name associated with the transaction or an empty string if unavailable. Will only be provided if ODWConfiguration.fullPhoneticNameRequired is true.

    Declaration

    Swift

    @objc
var fullPhoneticName: String { get }