These docs are intended for a developer audience.
Set up Plaid
This topic describes how to use FramePay to tokenize payments made using Plaid.
1. Obtain IDs and a publishable API key
- Obtain your organization ID and website ID:
- In the left navigation bar, click Settings .
- In the Management section, click My organization & websites.
- In the Organization details section, note the ID value.
- 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.
- Obtain your publishable API key:
- In the left navigation bar, click Automations .
- In the Development section, click API keys.
- Optionally, if you have not created a publishable key:
- In top right of the screen, click Add API.
- In the API key type section, select Publishable, then complete the form and click Save API key.
- Go back to the API Keys page.
- 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.
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.
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
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.
Configure FramePay
This step describes the basic set up for mounting.
Initialize
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. Plaid requires amount and currency.
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. - Framepay.on('ready', ...) - Framepay.plaid.mount(...)
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.
For more information, see Framepay.on('token-ready', ...).
Basic set up complete
To learn more about Plaid and FramePay, see: - Configuration reference - Create a Plaid integration
- HTML
- JavaScript
1<!doctype HTML>2<HTML>3<head>4 <link href="https://framepay.rebilly.com/framepay.css" rel="stylesheet">5 <script src="https://framepay.rebilly.com/framepay.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>1Framepay.initialize({2 publishableKey: 'pk_sandbox_123',3 organizationId: 'org-123',4 websiteId: 'website-123',5 transactionData: {6 currency: 'USD',7 amount: 10,8 },9});10Framepay.on('ready', function () {11 const form = document.getElementById('plaid-form');12 const extraData = {};13 const plaid = Framepay.plaid.mount('#mounting-point',14 {form, extraData});15});16Framepay.on('token-ready', (data) => {17 // At this point you can handle the payment token18 // the way you normally would19 console.log('Payment token:', data);20});