Code Monkey home page Code Monkey logo

cashflows-clientlib-js's Introduction

Cashflows logo

Cashflows Client Library for JS

Total Downloads Latest Version License

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.

cashflows-clientlib-js's People

Contributors

bobcashflows avatar

Stargazers

Fellownet avatar

Forkers

fellownet

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.