On this page
No Headings
A payment web experience profile.
objectidstringThe ID of the web experience profile.
namerequiredstringThe web experience profile name. Must be unique for a set of profiles for a merchant.
temporarybooleanIndicates whether the profile persists for three hours or permanently. To persist the profile permanently, set to false. To persist the profile for three hours, set to true.
flow_configobjectThe flow configuration parameters.
landing_page_typestring"login", "billing"The type of landing page to display on the PayPal site for user checkout. To use the non-PayPal account landing page, set to Billing. To use the PayPal account login landing page, set to Login.
bank_txn_pending_urlstringuriThe merchant site URL to display after a bank transfer payment. In Germany, valid only for the Giropay payment method or bank transfer payment method.
user_actionstring"COMMIT"Presents either the Continue or Pay Now checkout flow to the customer.
Default is Continue, or user_action=continue. When you do not know the final payment amount, accept this default flow, which redirects the customer to the PayPal payment page with the Continue button. When the customer clicks Continue, the customer can change the payment amount.
When you know the final payment amount, set user_action=commit to choose the Pay Now flow, which redirects the customer to the PayPal payment page with the Pay Now button. When the customer clicks Pay Now, the payment is processed immediately.
return_uri_http_methodstring"GET", "POST"The HTTP method to use to redirect the customer to a return URL. Value is GET or POST.
input_fieldsobjectThe input field customization parameters.
no_shippingintegerIndicates whether PayPal displays shipping address fields on the experience pages. Value is:
0. Displays the shipping address on the PayPal pages.1. Redacts shipping address fields from the PayPal pages. For digital goods, this field is required and must be 1.2. Gets the shipping address from the customer's account profile.address_overrideintegerIndicates whether to display the shipping address that is passed to this call rather than the one on file for this buyer on the PayPal experience pages. Value is:
0. Displays the shipping address on file.1. Displays the shipping address specified in this call. the customer cannot edit this shipping address.presentationobjectThe style and presentation parameters.
brand_namestringA label that overrides the business name in the PayPal account on the PayPal pages. Character length and limitations: 127 single-byte alphanumeric characters.
logo_imagestringA URL to the logo image. A valid media type is .gif, .jpg, or .png. The image's maximum width is 190 pixels and maximum height is 60 pixels. PayPal crops images that are larger. PayPal places your logo image at the top of the cart review area. PayPal recommends that you store the image on a secure (HTTPS) server. Otherwise, web browsers display a message that checkout pages contain non-secure items. Character length and limitations: 127 single-byte alphanumeric characters.
locale_codestringThe locale of pages that the PayPal payment experience displays. A valid value is AU, AT, BE, BR, CA, CH, CN, DE, ES, GB, FR, IT, NL, PL, PT, RU, or US. A 5-character code is also valid for languages in these countries: 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.