ApplePayComponent

public class ApplePayComponent : NSObject, PaymentComponent, PresentableComponent, Localizable

extension ApplePayComponent: PKPaymentAuthorizationViewControllerDelegate

A component that handles Apple Pay payments.

Error
Describes the error that can occur during Apple Pay payment.
See more
Declaration
Swift

public enum Error : Swift.Error, LocalizedError


                    
                    
                    delegate

The delegate of the component.

Declaration

Swift

public weak var delegate: PaymentComponentDelegate?

paymentMethod
The Apple Pay payment method.
Declaration
Swift

public let paymentMethod: PaymentMethod
summaryItems
The line items for this payment.
Declaration
Swift

public let summaryItems: [PKPaymentSummaryItem]
requiredBillingContactFields
A list of fields that you need for a billing contact in order to process the transaction. Ignored on iOS 10.*.
Declaration
Swift

public let requiredBillingContactFields: Set<PKContactField>
requiredShippingContactFields
A list of fields that you need for a shipping contact in order to process the transaction. Ignored on iOS 10.*.
Declaration
Swift

public let requiredShippingContactFields: Set<PKContactField>


                    
                    
                    init(paymentMethod:payment:merchantIdentifier:summaryItems:requiredBillingContactFields:requiredShippingContactFields:)

Initializes the component.

Warning

stopLoading() must be called before dismissing this component.

Throws

ApplePayComponent.Error.userCannotMakePayment. if user can’t make payments on any of the payment request’s supported networks.

Throws

ApplePayComponent.Error.deviceDoesNotSupportApplyPay if the current device’s hardware doesn’t support ApplePay.

Throws

ApplePayComponent.Error.emptySummaryItems if the summaryItems array is empty.

Throws

ApplePayComponent.Error.negativeGrandTotal if the grand total is negative.

Throws

ApplePayComponent.Error.invalidSummaryItem if at least one of the summary items has an invalid amount.

Throws

ApplePayComponent.Error.invalidCountryCode if the payment.countryCode is not a valid ISO country code.

Throws

ApplePayComponent.Error.invalidCurrencyCode if the payment.amount.currencyCode is not a valid ISO currency code.

Declaration

Swift

public init(paymentMethod: ApplePayPaymentMethod,
            payment: Payment,
            merchantIdentifier: String,
            summaryItems: [PKPaymentSummaryItem],
            requiredBillingContactFields: Set<PKContactField> = [],
            requiredShippingContactFields: Set<PKContactField> = []) throws

Parameters

`paymentMethod`	The Apple Pay payment method.
`payment`	A description of the payment. Must include an amount and country code.
`merchantIdentifier`	The merchant identifier.
`summaryItems`	The line items for this payment.
`requiredBillingContactFields`	A list of fields that you need for a billing contact in order to process the transaction. Ignored on iOS 10.*.
`requiredShippingContactFields`	A list of fields that you need for a shipping contact in order to process the transaction. Ignored on iOS 10.*.


                    
                    
                    init(paymentMethod:merchantIdentifier:summaryItems:)

Initializes the component.

Declaration

Swift

@available(*, deprecated, message: "Use init(paymentMethod:payment:merchantIdentifier:summaryItems:﹚ instead.")
public init?(paymentMethod: ApplePayPaymentMethod, merchantIdentifier: String, summaryItems: [PKPaymentSummaryItem])

Parameters

`paymentMethod`	The Apple Pay payment method.
`merchantIdentifier`	The merchant identifier.
`summaryItems`	The line items for this payment.

PKPaymentAuthorizationViewControllerDelegate


                    
                    
                    paymentAuthorizationViewControllerDidFinish(_:)

Declaration

Swift

public func paymentAuthorizationViewControllerDidFinish(_ controller: PKPaymentAuthorizationViewController)


                    
                    
                    paymentAuthorizationViewController(_:didAuthorizePayment:completion:)

Declaration

Swift

public func paymentAuthorizationViewController(_ controller: PKPaymentAuthorizationViewController,
                                               didAuthorizePayment payment: PKPayment,
                                               completion: @escaping (PKPaymentAuthorizationStatus) -> Void)