Last updated

Set up PayPal

This topic describes how to use FramePay to tokenize payments made using PayPal.

1. Obtain IDs and a publishable API key

  1. Obtain your organization ID and website ID:
    1. In the left navigation bar, click Settings .
    2. In the Management section, click My organization & websites.
    3. In the Organization details section, note the ID value.
    4. In the Website section, note the ID value. When you first log in to Rebilly, you create an organization as part of the setup process. A default website is created when a new organization is created. For more information, see Organizations and websites.
  2. Obtain your publishable API key:
    1. In the left navigation bar, click Automations .
    2. In the Development section, click API keys.
    3. Optionally, if you have not created a publishable key:
      1. In top right of the screen, click Add API.
      2. In the API key type section, select Publishable, then complete the form and click Save API key.
      3. Go back to the API Keys page.
    4. Select a publishable key and copy the Key value.

2. Set up PayPal

This step describes how to use FramePay to tokenize payments made using PayPal.


Initial set up

Set up the library and provide the HTML.

Include the FramePay stylesheet

This adds default styles to FramePay elements on the page.


Include the FramePay script

This exposes FramePay in the global JS scope as Framepay.


Include the HTML mounting points

You must specify an empty HTML element where FramePay renders the PayPal button.

Edit your checkout form to add new HTML element with a unique ID.


Configure FramePay

This step describes the basic set up for mounting.


Initialize FramePay with a configuration object.

For more information, see FramePay configuration reference.


Rebilly data

Provide your publishable API key, organization ID, and website ID to connect with the Rebilly API.


Transaction data

Provide the transaction data. PayPal requires amount and currency.


Get the payment token

Mount FramePay onto your page and listen for a payment token.

Mount the PayPal button

After initialization, mount the PayPal button in the container element. - Framepay.on('ready', ...) - Framepay.paypal.mount(...)


Listen for the generated payment token

When a customer submits the PayPal form, Rebilly creates a payment token.

To retrieve it, listen for the token-ready event.

For more information, see Framepay.on('token-ready', ...).


Basic set up complete

To learn more about PayPal and FramePay, see: - Configuration reference - Add a PayPal gateway account

Copy to clipboard
  • HTML
  • JavaScript
1<!doctype HTML>
3 <head>
4 <link href="" rel="stylesheet">
5 <script src=""></script>
6 </head>
7 <body>
8 <form>
9 <div id="paypal-mount"></div>
10 </form>
11 </body>

Interactive example