PayPal/com.braintreepayments.api.paypal/PayPalCheckoutRequest

PayPalCheckoutRequest

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 enablePayPalAppSwitch: Boolean = false, var shippingCallbackUrl: Uri? = null, var contactInformation: PayPalContactInformation? = null, var contactPreference: PayPalContactPreference? = null, 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(), var recurringBillingDetails: PayPalRecurringBillingDetails? = null, var recurringBillingPlanType: PayPalRecurringBillingPlanType? = null, var amountBreakdown: AmountBreakdown? = null, var shouldOfferCredit: Boolean = false) : PayPalRequest

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

Constructors

@JvmOverloads

constructor(amount: String, hasUserLocationConsent: Boolean, intent: PayPalPaymentIntent = PayPalPaymentIntent.AUTHORIZE, userAction: PayPalPaymentUserAction = PayPalPaymentUserAction.USER_ACTION_DEFAULT, currencyCode: String? = null, shouldRequestBillingAgreement: Boolean = false, shouldOfferPayLater: Boolean = false, enablePayPalAppSwitch: Boolean = false, shippingCallbackUrl: Uri? = null, contactInformation: PayPalContactInformation? = null, contactPreference: PayPalContactPreference? = null, localeCode: String? = null, billingAgreementDescription: String? = null, isShippingAddressRequired: Boolean = false, isShippingAddressEditable: Boolean = false, shippingAddressOverride: PostalAddress? = null, landingPageType: PayPalLandingPageType? = null, displayName: String? = null, merchantAccountId: String? = null, riskCorrelationId: String? = null, userAuthenticationEmail: String? = null, userPhoneNumber: PayPalPhoneNumber? = null, lineItems: List<PayPalLineItem> = emptyList(), recurringBillingDetails: PayPalRecurringBillingDetails? = null, recurringBillingPlanType: PayPalRecurringBillingPlanType? = null, amountBreakdown: AmountBreakdown? = null, shouldOfferCredit: Boolean = false)

Properties

amount

val amount: String

The transaction amount in currency units (as * determined by setCurrencyCode). For example, "1.20" corresponds to one dollar and twenty cents. Amount must be a non-negative number, may optionally contain exactly 2 decimal places separated by '.' and is limited to 7 digits before the decimal point.

amountBreakdown

var amountBreakdown: AmountBreakdown?

Breakdown of items associated to the total cost

billingAgreementDescription

open override var billingAgreementDescription: String?

Display a custom description to the user for a billing agreement. This property is optional.

contactInformation

var contactInformation: PayPalContactInformation?

Contact information of the recipient for the order

contactPreference

var contactPreference: PayPalContactPreference?

Preference for the contact information section within the payment flow. Defaults to PayPalContactPreference.NO_CONTACT_INFORMATION if not set.

currencyCode

var currencyCode: String?

A valid ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

displayName

open override var displayName: String?

The merchant name displayed in the PayPal flow; defaults to the company name on your Braintree account.

enablePayPalAppSwitch

open override var enablePayPalAppSwitch: Boolean

Used to determine if the customer will use the PayPal app switch flow. Defaults to false.

hasUserLocationConsent

open override val hasUserLocationConsent: Boolean

is a required property that informs the SDK if your application has obtained consent from the user to collect location data in compliance with Google Play Developer Program policies This flag enables PayPal to collect necessary information required for Fraud Detection and Risk Management.

intent

var intent: PayPalPaymentIntent

Payment intent. Must be set to PayPalPaymentIntent.SALE for immediate payment, PayPalPaymentIntent.AUTHORIZE to authorize a payment for capture later, or PayPalPaymentIntent.ORDER to create an order.

isShippingAddressEditable

open override var isShippingAddressEditable: Boolean

Whether to allow the the shipping address to be editable. Defaults to false. Set to true to enable user editing of the shipping address. Only applies when PayPalRequest.shippingAddressOverride is set with a PostalAddress.

isShippingAddressRequired

open override var isShippingAddressRequired: Boolean

Whether to hide the shipping address in the flow. Defaults to false. When set to true, the shipping address selector will be displayed.

landingPageType

open override var landingPageType: PayPalLandingPageType?

Use this option to specify the PayPal page to display when a user lands on the PayPal site to complete the payment.

lineItems

open override var lineItems: List<PayPalLineItem>

The line items for this transaction. It can include up to 249 line items.

localeCode

open override var localeCode: String?

A locale code to use for the transaction. Supported locales are:

da_DK, de_DE, en_AU, en_GB, en_US, es_ES, es_XC, fr_CA, fr_FR, fr_XC, id_ID, it_IT, ja_JP, ko_KR, nl_NL, no_NO, pl_PL, pt_BR, pt_PT, ru_RU, sv_SE, th_TH, tr_TR, zh_CN, zh_HK, zh_TW, zh_XC.

merchantAccountId

open override var merchantAccountId: String?

Specify a merchant account Id other than the default to use during tokenization.

recurringBillingDetails

open override var recurringBillingDetails: PayPalRecurringBillingDetails?

Recurring billing product details.

recurringBillingPlanType

open override var recurringBillingPlanType: PayPalRecurringBillingPlanType?

Recurring billing plan type, or charge pattern.

riskCorrelationId

open override var riskCorrelationId: String?

A risk correlation ID created with Set Transaction Context on your server.

shippingAddressOverride

open override var shippingAddressOverride: PostalAddress?

a custom PostalAddress, A valid shipping address to be displayed in the transaction flow. An error will occur if this address is not valid.

shippingCallbackUrl

var shippingCallbackUrl: Uri?

Server side shipping callback URL to be notified when a customer updates their shipping address or options. A callback request will be sent to the merchant server at this URL.

shopperSessionId

open var shopperSessionId: String?

the shopper session ID returned from your shopper insights server SDK integration

shouldOfferCredit

open override var shouldOfferCredit: Boolean

Offers PayPal Credit if the customer qualifies. Defaults to false.

shouldOfferPayLater

var shouldOfferPayLater: Boolean

Offers PayPal Pay Later if the customer qualifies. Defaults to false.

shouldRequestBillingAgreement

var shouldRequestBillingAgreement: Boolean

Whether to request billing agreement during checkout.