BTPayPalCheckoutRequest

Objective-C

@interface BTPayPalCheckoutRequest : BTPayPalRequest

Swift

class BTPayPalCheckoutRequest : BTPayPalRequest

Undocumented

Show on GitHub

  • Unavailable

    Please use initWithAmount:

    Undocumented

    Declaration

    Objective-C

    + (instancetype)new __attribute__((unavailable("Please use initWithAmount:")));
    Show on GitHub

  • Unavailable

    Please use initWithAmount:

    Base initializer - do not use.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
    Show on GitHub

  • Initialize a PayPal request with an amount for a one-time payment.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAmount:(nonnull NSString *)amount;

    Swift

    init(amount: String)

    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 ‘.’ and is limited to 7 digits before the decimal point.

    Return Value

    A PayPal Checkout request.

    Show on GitHub

  • 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

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull amount;

    Swift

    var amount: String { get }
    Show on GitHub

  • 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

    Objective-C

    @property (nonatomic, copy, nullable) NSString *currencyCode;

    Swift

    var currencyCode: String? { get set }
    Show on GitHub

  • Optional: Payment intent. Defaults to BTPayPalRequestIntentAuthorize. Only applies to PayPal Checkout.

    Declaration

    Objective-C

    @property (nonatomic) BTPayPalRequestIntent intent;

    Swift

    var intent: BTPayPalRequestIntent { get set }
    Show on GitHub

  • Optional: Changes the call-to-action in the PayPal Checkout flow. Defaults to BTPayPalRequestUserActionDefault.

    Declaration

    Objective-C

    @property (nonatomic) BTPayPalRequestUserAction userAction;

    Swift

    var userAction: BTPayPalRequestUserAction { get set }
    Show on GitHub

  • Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.

    Declaration

    Objective-C

    @property (nonatomic) BOOL offerPayLater;

    Swift

    var offerPayLater: Bool { get set }
    Show on GitHub

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) BOOL requestBillingAgreement;

    Swift

    var requestBillingAgreement: Bool { get set }
    Show on GitHub