On this page
No Headings
The application context. Set these properties to customize the payment flow experience for your customers.
objectbrand_namestringA label that overrides the business name in the merchant's PayPal account on the PayPal checkout pages.
localestringThe locale of pages that the PayPal payment experience displays. Please refer here for list of supported local codes. Defaulted to en_US if not provided or invalid.
landing_pagestringThe type of landing page to show on the PayPal site for customer checkout. To use the non-PayPal account landing page, set to Billing. To use the PayPal account log in landing page, set to Login.
shipping_preferencestring"NO_SHIPPING", "GET_FROM_FILE", "SET_PROVIDED_ADDRESS""GET_FROM_FILE"The shipping preference.
user_actionstringThe user action. Presents the customer with either the Continue or Pay Now checkout flow:
| Flow | Action | Description |
|---|---|---|
| Pay Now | user_action=commit | After the customer is redirected to the PayPal payment page, shows the Pay Now button. Use this option when you know the final amount when checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now. |
| Continue | user_action=continue | After the customer is redirected to the PayPal payment page, shows the Continue button. Use this option when you do not know the final amount when you initiate the checkout flow and you want to redirect the customer to the merchant page without processing the payment. |
preferred_payment_sourceobjectThe preferred payment source for the payer. Currently supported only for PayPal Billing Agreements. If provided, checkout experience will have this payment source pre-selected for the payer.
tokenobjectThe tokenized payment source to fund a payment.
idrequiredstringThe PayPal-generated ID for the token.
typerequiredstring"BILLING_AGREEMENT"^[0-9A-Z_-]+$The tokenization method that generated the ID.
payment_patternstring"CUSTOMER_PRESENT_ONETIME_PURCHASE", "CUSTOMER_NOT_PRESENT_RECURRING", "CUSTOMER_PRESENT_RECURRING_FIRST", "CUSTOMER_PRESENT_ONETIME_PURCHASE_VAULTED", "CUSTOMER_NOT_PRESENT_ONETIME_PURCHASE_VAULTED", "MAIL_ORDER_TELEPHONE_ORDER"^[A-Z_]+$Provides context (e.g. frequency of payment (Single, Recurring) along with whether (Customer is Present, Not Present) for the payment being processed. For Card and PayPal Vaulted/Billing Agreement transactions, this helps specify the appropriate indicators to the networks (e.g. Mastercard, Visa) which ensures compliance as well as ensure a better auth-rate. For bank processing, indicates to clearing house whether the transaction is recurring or not depending on the option chosen.