Cashflows Client Library for JS

Installation

The Cashflows Client Library for JS can be installed via NPM. To install, simply add it to your package.json file:

{
    "dependencies": {
        "cashflows-clientlib-js": "^1.0.0"
    }
}

And run npm to update your dependencies:

$ npm install

You may also git clone or download the files manually, and include the client library in your project. Use a script tag in the of the HTML page.

<script src="cashflows-clientlib-browser.js"></script>

Basic Usage

Create a new Cashflows instance with the intent that was created server side. The Cashflows instance can be configured to use the integration environment (true) or production (false). Initialise the card payment fields- and checkout button on your checkout page. Optionally initialise all other payment methods you'd like to support. Start the checkout by calling the checkout method.

var cashflows = new Cashflows('<payment intent goes here>', true);
cashflows.initCard('#card-number', '#card-name', '#card-expiration', '#card-cvc', '#pay-with-card');
cashflows.checkout()
.then(() => {
    // successful transaction
})
.catch(e => {
    // failed transaction
});

Stored Cards Usage

In addition to the payment fields, include a checkbox and a div element to enable the stored cards feature. The checkbox can be used by the customer to request storing the card details. The div element will be pupulated with the list of stored cards.

var cashflows = new Cashflows('<payment intent goes here>', true);
cashflows.initCard('#card-number', '#card-name', '#card-expiration', '#card-cvc', '#pay-with-card', '#store-card-details', '#stored-card-list');
cashflows.checkout()
.then(() => {
    // successful transaction
})
.catch(e => {
    // failed transaction
});

Examples

There are examples on how to generate a payment intent in the examples folder.

Support

If you believe you have found a bug, please report it using the GitHub issue tracker or contact us at [email protected].

Changelog

v1.0.1-34

• First public beta release and setting up infrastructure.

v1.0.36

• Added GooglePay support.

v1.0.37-43

• Added ApplePay support.

v1.0.44-47

• Added Stored Cards support.
• Improved status change handling.
• Better handling of GooglePay initialisation failures.
• Added logging.

v1.0.48

• Improved ui handling to prevent invalid states.

v1.0.49

• Fixed a bug where creating a payment from intent could result in an expired result if not all preparations were processed before the attempt was made.
• Fixed an issue that could cause a loop when using the library for transactions when auto-capture was turned off.

v1.0.50

• Added a new parameter 'gatewayMerchantId' to the initGooglePay method. This parameter is passed to Google as part of the GooglePay flow.