This is the client-side JS library for billing customers with Paystack. It makes it easy to create custom, secure payment experiences for merchant apps and websites. Checkout JS handles payment data encryption and transmission, this allows merchants to collect sensitive information such as credit card information without violating compliance.
It is used in Checkout, Paystack's proprietary checkout form.
See the Checkout JS public docs and development docs
Clone this repository
git clone git@github.com:PaystackHQ/checkout-js.git
Install dependencies with:
npm install
The source code can be found in the src/ folder.
Testing is done with Jest. To test your changes, run
npm test
To run tests in watch mode, run
npm run test:watch
Checkout JS is built with Rollup. To build, run the command
npm run build
You can also specify an environment to build for: dev, staging, or production. Configuration variables are set in src/config.js.
Checkout JS is deployed to three environments:
- Staging: https://js-studio.paystack.co/v1/checkout.js
- Production: https://js.paystack.co/v1/checkout.js
- npm: @paystack/checkout-js
Checkout JS is automatically packaged and published to the NPM registry on every push to the master and dev branches.
The master branch is publised under the latest tag and can be installed by running npm i @paystack/checkout-js@latest while the dev branch is published under the dev tag and can be installed using npm i @paystack/checkout-js@dev
All published versions are listed here on NPM https://www.npmjs.com/package/@paystack/checkout-js