Skip to content

README.md

Latest commit

 

History

History
38 lines (23 loc) · 1.16 KB

README.md

File metadata and controls

38 lines (23 loc) · 1.16 KB

Checkbook.io API

Checkbook.io API for sending checks online and offline.

This module lets you send, query, charge, and interact with the checkbook.io API in your Node.js applications.

Install

$ npm i -s git+ssh://git@github.com:Villa-Rentals/checkbook.io-sdk.git

Usage

Configure Strategy

The Checkbook.io sdk API authenticates using the a key and secret. These tokens are obtained through the Checkbook.io portal. The SDK requires the realm of the API (test, sandbox, live) and long with the previously mentioned tokens.

new Checkbook('stage', key, secret);

Making Requests

See the documentation for more information about the SDK.

Tests

The key and secret are required for the tests to pass. These can be obtained through the Checkbook.io portal. Once these tokens have been acquired, create a .env file from the .env.example file and provide the tokens. These will be used to authenticate your requests.

$ npm install --dev
$ npm test

License

The MIT License