Set up a payment card method

This topic describes how to add FramePay to a checkout form and use it to tokenize payment card information.

1. Obtain IDs and a publishable API key

  1. Obtain your organization ID and website ID:
    1. In the left navigation bar, click Settings icon.
    2. Click My organization & websites.
    3. In the Organization info section, note the ID value.
    4. In the Website section, note the ID value. A website and organization is created automatically when you sign up to Rebilly. For more information, see Organizations and websites.
  2. Obtain your publishable API key:
    1. In the left navigation bar, click Automation icon, then click API keys.
    2. 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.
    3. Select a publishable key and copy the Key value.

2. Set up a payment card method

This step describes how to add FramePay to a checkout form and use it to tokenize payment card information.


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 Rebilly.


Create your checkout form

FramePay automatically gathers data from your checkout form.

To enable this, you must use data-rebilly attributes on your input fields.


Include the HTML mounting points

Add an empty HTML element with a unique ID to your checkout form.

This is where FramePay will render the card field.


Configure FramePay

This step describes the basic set up for mounting.


Initialize FramePay with a configuration object.

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. Payment card requires amount and currency.


Get the payment token

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

Mount the card field

After initialization, mount the card field in the container element.

Rebilly.on('ready', ...)



Create a payment token

When you mount your card element, your customer will be able to complete the form.

To send the form data to FramePay, call Rebilly.createToken().

  • If the collected form data is valid, you will receive a successful result with a new payment token.
  • If the collected form data is not valid, you will receive an error explaining why.



Basic set up complete

To learn more about payment cards and FramePay, see:

Copy to clipboard
  • JavaScript
  • HTML
1<!doctype HTML>
3 <head>
4 <link href="" rel="stylesheet">
5 <script src=""></script>
6 </head>
7 <body>
8 <form id="payment-form">
9 <input data-rebilly="firstName" placeholder="First Name" />
10 <input data-rebilly="lastName" placeholder="Last Name" />
11 <div id="mounting-point"></div>
12 </form>
13 </body>

Interactive example

This is an interactive example of a basic checkout form which uses FramePay to tokenize payment cards. It is the result of the previous steps.

(Open the example in a new window to view console.log messages.):