Set up Plaid

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

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.
    2. Click API keys & webhooks, then 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 Plaid

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

1

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.

HTML

Include the FramePay script

This exposes FramePay in the global JS scope as Rebilly.

HTML

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.

HTML

Include the HTML mounting points

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

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

HTML
2

Configure FramePay

This step describes the basic set up for mounting.

Initialize

Initialize FramePay with a configuration object.

FramePay configuration reference

JavaScript

Rebilly data

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

Transaction data

Provide the transaction data. Plaid requires amount and currency.

JavaScript
3

Get the payment token

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

Mount the Plaid button

After initialization, mount the Plaid button in the container element.

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

Rebilly.plaid.mount(...)

JavaScript

Listen for the generated payment token

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

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

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

JavaScript

Basic set up complete

To learn more about Plaid and FramePay, see:

Copy to clipboard
  • JavaScript
  • HTML
1<!doctype HTML>
2<HTML>
3<head>
4 <link href="https://framepay.rebilly.com/rebilly.css" rel="stylesheet">
5 <script src="https://framepay.rebilly.com/rebilly.js"></script>
6</head>
7<body>
8<form id="plaid-form">
9 <input data-rebilly="firstName" placeholder="First Name" />
10 <input data-rebilly="lastName" placeholder="Last Name" />
11 <input data-rebilly="address" placeholder="Address" />
12 <input data-rebilly="city" placeholder="City" />
13 <div id="mounting-point"></div>
14</form>
15</body>
16</HTML>

Interactive example