View on GitHub
BTPayPalRequest
@objcMembers
open class BTPayPalRequest : NSObjectBase options for PayPal Checkout and PayPal Vault flows.
Note
Do not instantiate this class directly. Instead, use BTPayPalCheckoutRequest or BTPayPalVaultRequest.-
Defaults to false. When set to true, the shipping address selector will be displayed.
Declaration
Swift
public var isShippingAddressRequired: Bool -
Defaults to false. Set to true to enable user editing of the shipping address.
Note
Only applies whenshippingAddressOverrideis set.Declaration
Swift
public var isShippingAddressEditable: Bool -
Optional: A locale code to use for the transaction.
Declaration
Swift
public var localeCode: BTPayPalLocaleCode -
Optional: A valid shipping address to be displayed in the transaction flow. An error will occur if this address is not valid.
Declaration
Swift
public var shippingAddressOverride: BTPostalAddress? -
Optional: Landing page type. Defaults to
.none.Note
Setting the BTPayPalRequest’s landingPageType changes the PayPal page to display when a user lands on the PayPal site to complete the payment..loginspecifies a PayPal account login page is used..billingspecifies a non-PayPal account landing page is used.Declaration
Swift
public var landingPageType: BTPayPalRequestLandingPageType -
Optional: The merchant name displayed inside of the PayPal flow; defaults to the company name on your Braintree account
Declaration
Swift
public var displayName: String? -
Optional: A non-default merchant account to use for tokenization.
Declaration
Swift
public var merchantAccountID: String? -
Optional: The line items for this transaction. It can include up to 249 line items.
Declaration
Swift
public var lineItems: [BTPayPalLineItem]? -
Optional: Display a custom description to the user for a billing agreement. For Checkout with Vault flows, you must also set
requestBillingAgreementtotrueon yourBTPayPalCheckoutRequest.Declaration
Swift
public var billingAgreementDescription: String? -
Optional: A risk correlation ID created with Set Transaction Context on your server.
Declaration
Swift
public var riskCorrelationID: String?