Package-level declarations

Types

Link copied to clipboard

PaymentMethodNonce representing a PayPal account.

Link copied to clipboard
data class PayPalBillingCycle @JvmOverloads constructor(val isTrial: Boolean, val numberOfExecutions: Int, var interval: PayPalBillingInterval? = null, var intervalCount: Int? = null, var sequence: Int? = null, var startDate: String? = null, var pricing: PayPalBillingPricing? = null) : Parcelable

PayPal recurring billing cycle details.

Link copied to clipboard

The interval at which the payment is charged or billed.

Link copied to clipboard
data class PayPalBillingPricing @JvmOverloads constructor(val pricingModel: PayPalPricingModel, val amount: String? = null, var reloadThresholdAmount: String? = null) : Parcelable

PayPal Recurring Billing Agreement pricing details.

Link copied to clipboard

Exception for whenever the browser has returned an 'error' in its response.

Link copied to clipboard
class PayPalCheckoutRequest @JvmOverloads constructor(val amount: String, val hasUserLocationConsent: Boolean, var intent: PayPalPaymentIntent = PayPalPaymentIntent.AUTHORIZE, var userAction: PayPalPaymentUserAction = PayPalPaymentUserAction.USER_ACTION_DEFAULT, var currencyCode: String? = null, var shouldRequestBillingAgreement: Boolean = false, var shouldOfferPayLater: Boolean = false, var localeCode: String? = null, var billingAgreementDescription: String? = null, var isShippingAddressRequired: Boolean = false, var isShippingAddressEditable: Boolean = false, var shippingAddressOverride: PostalAddress? = null, var landingPageType: PayPalLandingPageType? = null, var displayName: String? = null, var merchantAccountId: String? = null, var riskCorrelationId: String? = null, var userAuthenticationEmail: String? = null, var userPhoneNumber: PayPalPhoneNumber? = null, var lineItems: List<PayPalLineItem> = emptyList()) : PayPalRequest

Represents the parameters that are needed to start the PayPal Checkout flow

Link copied to clipboard

Used to tokenize PayPal accounts. For more information see the documentation

Link copied to clipboard

Represents the PayPal credit financing response.

Link copied to clipboard

The currency and amount in a PayPal credit financing response

Link copied to clipboard

Responsible for launching PayPal user authentication in a web browser

Link copied to clipboard
data class PayPalLineItem @JvmOverloads constructor(val kind: PayPalLineItemKind, val name: String, val quantity: String, val unitAmount: String, var description: String? = null, var imageUrl: String? = null, var productCode: String? = null, var unitTaxAmount: String? = null, var upcCode: String? = null, var upcType: PayPalLineItemUpcType? = null, var url: String? = null) : Parcelable

Line item for PayPal checkout flows.

Link copied to clipboard

The type of PayPal line item.

Link copied to clipboard

The upc type of PayPal line item.

Link copied to clipboard

Callback for receiving result of PayPalClient.createPaymentAuthRequest.

Link copied to clipboard

A request used to launch the continuation of the PayPal payment flow.

Link copied to clipboard

Result of the PayPal web flow received from PayPalLauncher.handleReturnToApp.

Link copied to clipboard

The payment intent in the PayPal Checkout flow

Link copied to clipboard

The call-to-action in the PayPal Checkout flow

Link copied to clipboard

A pending request for the PayPal web-based authentication flow created by invoking PayPalLauncher.launch. This pending request should be stored locally within the app or on-device and used to deliver a result of the browser flow in PayPalLauncher.handleReturnToApp

Link copied to clipboard
data class PayPalPhoneNumber(var countryCode: String, var nationalNumber: String) : Parcelable

Representation of a user phone number.

Link copied to clipboard

The interval at which the payment is charged or billed.

Link copied to clipboard
data class PayPalRecurringBillingDetails @JvmOverloads constructor(val billingCycles: List<PayPalBillingCycle>, val totalAmount: String, val currencyISOCode: String, var productName: String? = null, var oneTimeFeeAmount: String? = null, var productDescription: String? = null, var productAmount: String? = null, var productQuantity: Int? = null, var shippingAmount: String? = null, var taxAmount: String? = null) : Parcelable

PayPal recurring billing product details

Link copied to clipboard

PayPal recurring billing plan type, or charge pattern.

Link copied to clipboard
abstract class PayPalRequest : Parcelable

Represents the parameters that are needed to tokenize a PayPal account. See PayPalCheckoutRequest and PayPalVaultRequest.

Link copied to clipboard
sealed class PayPalResult

Result of tokenizing a PayPal account

Link copied to clipboard

Callback for receiving result of PayPalClient.tokenize.

Link copied to clipboard
class PayPalVaultRequest @JvmOverloads constructor(val hasUserLocationConsent: Boolean, var shouldOfferCredit: Boolean = false, var recurringBillingDetails: PayPalRecurringBillingDetails? = null, var recurringBillingPlanType: PayPalRecurringBillingPlanType? = null, var enablePayPalAppSwitch: Boolean = false, var localeCode: String? = null, var billingAgreementDescription: String? = null, var isShippingAddressRequired: Boolean = false, var isShippingAddressEditable: Boolean = false, var shippingAddressOverride: PostalAddress? = null, var landingPageType: PayPalLandingPageType? = null, var displayName: String? = null, var merchantAccountId: String? = null, var riskCorrelationId: String? = null, var userAuthenticationEmail: String? = null, var userPhoneNumber: PayPalPhoneNumber? = null, var lineItems: List<PayPalLineItem> = emptyList()) : PayPalRequest

Represents the parameters that are needed to start the PayPal Vault flow