Rebilly JS Token Library (Deprecated)

Rebilly.js powers your checkout form and removes the need to send sensitive customer information directly to your servers. Use the library to generate payment tokens to reduce the scope of PCI DSS compliance.

Deprecation Notice

This library is deprecated in favor of FramePay, a tool that allows you to build your checkout flow by offloading strict PCI Compliance requirements directly to Rebilly while maintaining the same look and feel your customers are used to.

---

Rebilly API Spec

The library uses the payment token endpoint from the Rebilly API. See the Rebilly API spec for more details.

Documentation

Visit the GitHub pages for detailed documentation.

Including Rebilly.js

Add Rebilly.js to your page using the following CDN provider, preferably at the bottom before the </body>.

Always use HTTPS when including the library.

Rebilly CDN

<script src="https://cdn.rebilly.com/[email protected]/rebilly.js"></script>

The library is then available in the global scope as Rebilly.

Usage

After including the library into your page, you must authenticate your API requests then define the data to use for the token and provide callback function.

Authentication

Once included in your checkout page, authenticate your token requests using a publishable API key generated in Rebilly.

Rebilly.setPublishableKey('pk_live_...');

Creating a token

To create a token you must provide two parameters: the form or object literal with the payment instrument data (payment card or bank account) and a callback function that will receive the resulting token from the Rebilly API.

Optionally you can also include an object literal defining extraData to combine to the main payload. This is useful when using a form to include information about the lead source.

Tip: when creating a token, prevent the default submission of the form until a value is returned by the API and injected into your page.

// payload, callback, extraData
Rebilly.createToken(Node|Object, Function[, Object])

Building the payment instrument data

The first parameter will be the payment instrument data. You can use either a form node in your page or a plain object literal.

Parse a form for the payment instrument

The library can look for field with the data-rebilly attribute and compile the data from your form directly. Specify the field name associated in Rebilly as data-rebilly="fieldName".

You can omit providing a method field, the library will detect it based on which fields you specified.

PCI Compliance Note: never define name attributes for the payment card fields in your form. This will prevent field data from showing up in your server logs.

<form>
    <input data-rebilly="pan">
    <input type="number" data-rebilly="expYear">
    <input type="number" data-rebilly="expMonth">
    <input type="number" data-rebilly="cvv">
</form>

Using the form above the library will detect a payment card.

var form = document.getElementsByTagName('form')[0];
Rebilly.createToken(form, callback);

Use an object literal

var payload = {
    method: 'payment-card',
    paymentInstrument: {
        pan: '4111111111111111',
        expYear: '2022',
        expMonth: '12',
        cvv: '123'
    }
};
Rebilly.createToken(payload, callback);

Define the callback

The callback function should be used to inject the token returned by the API into your form. Once submitted, use the value in conjunction with one of the server-side SDKs to create the customer.

// the token is returned as response.data.id
var callback = function (response) {
    // create a hidden input field
    var tokenField = document.createElement('input');
    tokenField.setAttribute('type', 'hidden');
    tokenField.setAttribute('name', 'payment-token');
    tokenField.value = response.data.id;
    // append to the form and submit to the server
    form.appendChild(tokenField);
    form.submit();
};

Rebilly.createToken(form, callback);

Callback Argument

The argument received by the callback contains additional information on the API request and can be used to detect validation errors.

Property	Type	Description
error	boolean	Defines whether there was an error with the request or not.
message	string	The response message. Returns success if there was no errors, or the error message.
status	number	The status code returned by the response.
data	Object	The response data as returned by the API. The token is exposed as data.id.
xhr	Object	The raw XHR request object.

Development Commands

Build development dist folder without sourcemap

yarn run build:dev

Build release dist folder with sourcemap (release)

yarn run build:prod

Run all unit tests

yarn run test

Watch unit tests and re-run on change

yarn run test:watch