Help center / Opening the pop-up with JavaScript

Opening the pop-up with JavaScript

You can open the payment pop-up on your website with JavaScript. This means you can attach it to any element, click, mouse event, state change and so on.

Start by adding the pop-up script to your site

Checkout Page will add a checkoutPage object to the window. Inspect it by running window.checkoutPage.

To open a checkout, execute this:

  window.checkoutPage.open({
    seller: "{SELLER_NAME}",
    checkout: "{CHECKOUT_SLUG}"
  });

To close any open checkouts, execute this:

  window.checkoutPage.close();

Using query parameters in the pop-up

To store additional details to payments, you can use query parameters. You can store query parameters in the JavaScript pop-up by adding a query object to the open function:

  window.checkoutPage.open({
    seller: "{SELLER_NAME}",
    checkout: "{CHECKOUT_SLUG}",
    query: { variant: "green" }
  });

Note that the query object can be only one level deep: arrays and objects are omitted, and other values are converted to strings.

Checking if the Checkout Page script is loaded

In more advanced scenario's, you may have to check if the window and window.checkoutPage exists before executing the open and close functions. We recommend using the following function:

  if (typeof window !== "undefined" && typeof window.checkoutPage !== "undefined) {
    window.checkoutPage.open({
      seller: "{SELLER_NAME}",
      checkout: "{CHECKOUT_SLUG}"
    });
  }

  if (typeof window !== "undefined" && typeof window.checkoutPage !== "undefined") {
    window.checkoutPage.close()
  }

Need more help?

Contact us via the Chat in the bottom-right corner or via email on support@checkoutpage.co