On this page
No Headings
Customizes the payer experience during the approval process for the payment with PayPal.
Note: Partners and Marketplaces might configurebrand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
objectbrand_namestring^[\S\s]*$DEPRECATED. The label that overrides the business name in the PayPal account on the PayPal site. 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.brand_name). Please specify this field in the experience_context object instead of the application_context object.
localeobject^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$The language tag 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, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
DEPRECATED. The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW. 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.locale). Please specify this field in the experience_context object instead of the application_context object.
landing_pagestring"LOGIN", "BILLING", "NO_PREFERENCE""NO_PREFERENCE"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 |
shipping_preferencestring"GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS""GET_FROM_FILE"DEPRECATED. DEPRECATED. The shipping preference:
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 |
user_actionstring"CONTINUE", "PAY_NOW""CONTINUE"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.
payment_methodobjectThe customer and merchant payment preferences.
DEPRECATED. The customer and merchant payment preferences. 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.payment_method_selected). Please specify this field in the experience_context object instead of the application_context object..
payee_preferredstring"UNRESTRICTED", "IMMEDIATE_PAYMENT_REQUIRED""UNRESTRICTED"The merchant-preferred payment methods.
standard_entry_class_codestring"TEL", "WEB", "CCD", "PPD""WEB"NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, partners) obtain the consumer’s explicit authorization before initiating a transaction. To stay compliant, you’ll need to make sure that you retain a compliant authorization for each transaction that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.
return_urlstringuriDEPRECATED. The URL where the customer is redirected after the customer approves the payment. 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.return_url). Please specify this field in the experience_context object instead of the application_context object.
cancel_urlstringuriDEPRECATED. The URL where the customer is redirected after the customer cancels the payment. 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.cancel_url). Please specify this field in the experience_context object instead of the application_context object.
stored_payment_sourceobjectProvides 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.previous_transaction_reference and previous_network_transaction_reference - can be present in the request.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.previous_transaction_reference and previous_network_transaction_reference - can be present in the request.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 |
payment_initiatorrequiredstring"CUSTOMER", "MERCHANT"The person or party who initiated or triggered the payment.
payment_typerequiredstring"ONE_TIME", "RECURRING", "UNSCHEDULED"Indicates the type of the stored payment_source payment.
usagestring"FIRST", "SUBSEQUENT", "DERIVED""DERIVED"Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
previous_network_transaction_referenceobjectReference values used by the card network to identify a transaction.
idrequiredstring^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.
datestring^[0-9]+$The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date". For some specific networks, such as MasterCard and Discover, this date field is mandatory when the previous_network_transaction_reference_id is passed.
networkobject"VISA", "MASTERCARD", "DISCOVER", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFIGOGA", "CONFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "DINERS", "ELO", "HIPER", "HIPERCARD", "RUPAY", "GE", "SYNCHRONY", "EFTPOS", "CARTE_BANCAIRE", "STAR_ACCESS", "PULSE", "NYCE", "ACCEL", "UNKNOWN"The card network or brand. Applies to credit, debit, gift, and payment cards.
Name of the card network through which the transaction was routed.
acquirer_reference_numberstring^[a-zA-Z0-9]+$Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.