BTPayPalCheckoutRequest

@objcMembers
open class BTPayPalCheckoutRequest : BTPayPalRequest

Options for the PayPal Checkout flow.

Show on GitHub

Public Properties

amount
Used for a one-time payment.

Amount must be greater than or equal to zero, may optionally contain exactly 2 decimal places separated by ‘.’ and is limited to 7 digits before the decimal point.
Declaration
Swift

public var amount: String
Show on GitHub
intent
Optional: Payment intent. Defaults to .authorize. Only applies to PayPal Checkout.
Declaration
Swift

public var intent: BTPayPalRequestIntent
Show on GitHub
userAction
Optional: Changes the call-to-action in the PayPal Checkout flow. Defaults to .none.
Declaration
Swift

public var userAction: BTPayPalRequestUserAction
Show on GitHub
offerPayLater
Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.
Declaration
Swift

public var offerPayLater: Bool
Show on GitHub
currencyCode
Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

Note
See https://developer.paypal.com/docs/api/reference/currency-codes/ for a list of supported currency codes.
Declaration
Swift

public var currencyCode: String?
Show on GitHub
requestBillingAgreement
Optional: If set to true, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement during checkout. Defaults to false.
Declaration
Swift

public var requestBillingAgreement: Bool
Show on GitHub
userAuthenticationEmail
Optional: User email to initiate a quicker authentication flow in cases where the user has a PayPal Account with the same email.
Declaration
Swift

public var userAuthenticationEmail: String?
Show on GitHub

Initializer


                    
                    
                    init(amount:intent:userAction:offerPayLater:currencyCode:requestBillingAgreement:)

Initializes a PayPal Native Checkout request

Declaration

Swift

public init(
    amount: String,
    intent: BTPayPalRequestIntent = .authorize,
    userAction: BTPayPalRequestUserAction = .none,
    offerPayLater: Bool = false,
    currencyCode: String? = nil,
    requestBillingAgreement: Bool = false
)

Parameters

`amount`	Used for a one-time payment. Amount must be greater than or equal to zero, may optionally contain exactly 2 decimal places separated by ‘.’
`intent`	Optional: Payment intent. Defaults to `.authorize`. Only applies to PayPal Checkout. and is limited to 7 digits before the decimal point.
`userAction`	Optional: Changes the call-to-action in the PayPal Checkout flow. Defaults to `.none`.
`offerPayLater`	Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to `false`. Only available with PayPal Checkout.
`currencyCode`	Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set. See https://developer.paypal.com/docs/api/reference/currency-codes/ for a list of supported currency codes.
`requestBillingAgreement`	Optional: If set to `true`, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement during checkout. Defaults to `false`.

Show on GitHub