Optional Parameters for the Configuration Object

DocsLast updated: October 12th 2021, @ 6:58:00 pm


ParameterDescription
mode: "live"The library that loads the PSP:
  • `live` loads from paypal.com.
  • `sandbox` loads from sandbox.paypal.com.
Note: The library emits a warning to the console if mode is set to `sandbox`. This warning is displayed in `live` mode only for required parameters.
Default is `live`.| |`preselection: "none"`|The payment method or methods that appear:
  • none. nothing
  • paypal. PayPal Wallet
  • `Vorkasse` or any of its synonyms. Synonyms are: `Überweisung`, `Vorauszahlung`, `Vorausbezahlung`, `Vorauskasse`, `Vorabzahlung`, `prepayment`, `advance payment`, `payment in advance`, `pay in advance`.
| |`language: "en_US"`|ISO 639-1 or ISO 3166-1 alpha-2. The language in which to render the PayPal PLUS PSP. To keep the buyer's content consistent, this language must be the language of the merchant's shop.
Note: Use the language code of the shop's front end to set the PSP language code. Unsupported languages default to English.
| |`onContinue: callback`|`callback` or a `string`. The API interprets a string as the ID of a form in the document. The user submits this form when they click the inside **Continue** button.| |`onLoad: callback`|Upon successful load of the iframe, the callback function.| |`enableContinue: callback`|`callback` or a `string`. The API interprets a string as the ID of a form in the document. he user submits this form when they click the inside **Continue** button. For `callback`, the API invokes the callback function.| |`disableContinue: callback`|`callback` or a `string`. The API interprets a string as the ID of a form in the document. he user submits this form when they click the inside **Continue** button. For `callback`, the API invokes the callback function.| |`deselectPaymentMethod`|When all payment methods are deselected, the merchant’s webpage displays a message prompting the buyer to select a payment method to continue. The **Continue** button is disabled.| |`useraction: "commit"`|The merchant-implemented checkout flow. Value is:
  • commit. The buyer must review and confirm payment on the PayPal site.
  • continue. The buyer must review and confirm payment on a review page.
| |`showLoadingIndicator: "false"`|`true` or `false`. Default is `false`.| |`onThirdPartyPaymentMethodSelected : callback`|When a user selects a third-party method, the API invokes the callback function and sends the method name.| |`onThirdPartyPaymentMethodDeselected : callback`|When the user selects another payment method, the API clears the third-party method and invokes the callback function. |