application_context

Customizes the payer experience during the approval process for the payment with PayPal.

Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values.

localestring<language>Optional

The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Length2 <= length <= 10

landing_pageenumOptionalDeprecated

DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site for customer checkout. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.landing_page`). Please specify this field in the `experience_context` object instead of the `application_context` object. DEPRECATED

See	Since Version
payment_source.paypal.experience_context.landing_page	2.9

Allowed values

"LOGIN"
"BILLING"
"NO_PREFERENCE"Default

shipping_preferenceenumOptionalDeprecated

DEPRECATED. DEPRECATED. The shipping preference:

Displays the shipping address to the customer.
Enables the customer to choose an address on the PayPal site.
Restricts the customer from changing the address during the payment-approval process.

. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.shipping_preference`). Please specify this field in the `experience_context` object instead of the `application_context` object. DEPRECATED

See	Since Version
payment_source.paypal.experience_context.shipping_preference	2.9

Allowed values

"GET_FROM_FILE"Default
"NO_SHIPPING"
"SET_PROVIDED_ADDRESS"

user_actionenumOptional

DEPRECATED. Configures a Continue or Pay Now checkout flow. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.user_action`). Please specify this field in the `experience_context` object instead of the `application_context` object.

Allowed values

"CONTINUE"Default
"PAY_NOW"

payment_methodobject<payment_method>Optional

The customer and merchant payment preferences.

stored_payment_sourceobject<stored_payment_source>OptionalDeprecated

DEPRECATED. Provides additional details to process a payment using a `payment_source` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:

`payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`.
`usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`.
`previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`.
Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request.

. The fields in `stored_payment_source` are now available in the `stored_credential` object under the `payment_source` which supports them (eg. `payment_source.card.stored_credential.payment_initiator`). Please specify this field in the `payment_source` object instead of the `application_context` object. DEPRECATED

See	Since Version
payment_source.card.stored_credential	2.9

Provides additional details to process a payment using a `payment_source` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:

`payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`.
`usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`.
`previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`.
Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request.

stored_payment_source properties

4 properties

payment_typeenum<stored_payment_source_payment_type>Required

Indicates the type of the stored payment_source payment.

Allowed values

"ONE_TIME"
"RECURRING"
"UNSCHEDULED"

usageenum<stored_payment_source_usage_type>Optional

Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file).

Allowed values

"FIRST"
"SUBSEQUENT"
"DERIVED"Default

previous_network_transaction_referenceobject<network_transaction_reference>Optional

Reference values used by the card network to identify a transaction.

See

Since Version

payment_source.paypal.experience_context.landing_page

2.9

See

Since Version

payment_source.paypal.experience_context.shipping_preference

2.9

See

Since Version

payment_source.card.stored_credential

2.9

application_context

payment_method properties

stored_payment_source properties

network_transaction_reference properties

Back to top

On this page

On this page

application_context

payment_method properties

stored_payment_source properties

network_transaction_reference properties

Back to top

On this page

application_context

payment_method properties

stored_payment_source properties

network_transaction_reference properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

application_context

payment_method properties

stored_payment_source properties

network_transaction_reference properties

Back to top

On this page