OrderApplicationContext

@objc(PPCOrderApplicationContext)
@objcMembers
class OrderApplicationContext
extension OrderApplicationContext : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Encodable, Equatable, Hashable, NSObjectProtocol

A class that represents the possible values to be passed as part of the application context object. OrderApplicationContext object documentation guide

  • The possible value of network types

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextNetwork)
enum Network
    extension OrderApplicationContext.Network : Equatable, Hashable, RawRepresentable

  • Describes possible merchant-preferred payment methods.

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextPayeePreferred)
enum PayeePreferred
    extension OrderApplicationContext.PayeePreferred : Equatable, Hashable, RawRepresentable

  • The customer-selected payment method on the merchant site.

    Possible values are:

    • PayPal
    • PayPal Credit
    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextPayerSelected)
enum PayerSelected
    extension OrderApplicationContext.PayerSelected : Equatable, Hashable, RawRepresentable

  • Describes the person or party who initiated or triggered the payment.

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextPaymentInitiator)
enum PaymentInitiator
    extension OrderApplicationContext.PaymentInitiator : Equatable, Hashable, RawRepresentable

  • The customer and merchant payment preferences.

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextPaymentMethod)
@objcMembers
class PaymentMethod
    extension OrderApplicationContext.PaymentMethod : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Encodable, Equatable, Hashable, NSObjectProtocol

  • Describes the type of payment

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextPaymentType)
enum PaymentType
    extension OrderApplicationContext.PaymentType : Equatable, Hashable, RawRepresentable

  • Reference values used by the card network to identify a transaction.

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextPreviousNetworkTransactionReference)
@objcMembers
class PreviousNetworkTransactionReference
    extension OrderApplicationContext.PreviousNetworkTransactionReference : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Encodable, Equatable, Hashable, NSObjectProtocol

  • Shipping preference set by the merchant. Affects the ability of the payer to change their shipping information within the PayPal SDK

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextShippingPreference)
enum ShippingPreference
    extension OrderApplicationContext.ShippingPreference : Equatable, Hashable, RawRepresentable

  • Describes the possible entry class codes

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextStandardEntryClassCode)
enum StandardEntryClassCode
    extension OrderApplicationContext.StandardEntryClassCode : Equatable, Hashable, RawRepresentable

  • Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextStoredPaymentSource)
@objcMembers
class StoredPaymentSource
    extension OrderApplicationContext.StoredPaymentSource : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Encodable, Equatable, Hashable, NSObjectProtocol

  • Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextUsage)
enum Usage
    extension OrderApplicationContext.Usage : Equatable, Hashable, RawRepresentable

  • Defines whether to present the customer with a Continue or Pay Now checkout flow.

    See more

    Declaration

    Swift

    @objc(PPCOrderApplicationContextUserAction)
enum UserAction
    extension OrderApplicationContext.UserAction : Equatable, Hashable, RawRepresentable

  • The label that overrides the business name in the PayPal account on the PayPal site. Maximum length: 127.

    Declaration

    Swift

    let brandName: String?

  • The URL where the customer is redirected after the customer cancels the payment.

    Declaration

    Swift

    let cancelUrl: String?

  • Undocumented

    Declaration

    Swift

    init(brandName: String? = nil, locale: String? = nil, shippingPreference: OrderApplicationContext.ShippingPreference = .none, userAction: OrderApplicationContext.UserAction = .none, paymentMethod: OrderApplicationContext.PaymentMethod? = nil, returnUrl: String? = nil, cancelUrl: String? = nil, storedPaymentSource: OrderApplicationContext.StoredPaymentSource? = nil)

  • The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.

    • Minimum length: 2
    • Maximum length: 10
    • Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$

    Declaration

    Swift

    let locale: String?

  • The customer and merchant payment preferences.

    Declaration

    Swift

    let paymentMethod: OrderApplicationContext.PaymentMethod?

  • The URL where the customer is redirected after the customer approves the payment.

    Declaration

    Swift

    let returnUrl: String?

  • The shipping preference

    • Displays the shipping address to the customer.
    • Enables the customer to choose an address on the PayPal site.
    • Restricts the customer from changing the address during the payment-approval process.

    Declaration

    Swift

    let shippingPreference: OrderApplicationContext.ShippingPreference

  • Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).

    Declaration

    Swift

    let storedPaymentSource: OrderApplicationContext.StoredPaymentSource?

  • Configures a Continue or Pay Now checkout flow.

    Declaration

    Swift

    let userAction: OrderApplicationContext.UserAction