checkbook-api-ts

library1.0.0jsnpmunverified

A Node.js library for integrating with the Checkbook.io API to send digital, physical, and direct checks, manage invoices and subscriptions, and handle ACH payments. Version 1.0.0 is stable with a callback-based API. Requires Node >=4, no external runtime dependencies. Key differentiators: supports multiple check types (digital, physical, direct), CSV batch sending, idempotency keys, and OAuth bearer tokens. Release cadence is unknown. Alternatives include direct REST calls or other libraries, but this is the official Checkbook.io wrapper.

payments http-networking communication

npm install checkbook-api-ts

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · CHECKBOOK-API-TS

checkbook-api-ts

paymentsjavascriptv1.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

CheckbookAPI

✓ const checkbook = require('checkbook-api');

✗ import checkbook from 'checkbook-api';

Package uses CommonJS; no default export for ESM.

CheckbookAPI constructor

✓ const Checkbook = new CheckbookAPI({ api_key: '...', api_secret: '...' });

✗ const Checkbook = new Checkbook();

Constructor requires api_key and api_secret (or bearer) object.

checks.sendDigitalCheck

✓ Checkbook.checks.sendDigitalCheck(params, callback);

✗ Checkbook.sendDigitalCheck(params, callback);

Methods are namespaced under endpoints like Checkbook.checks.

Initializes the Checkbook.io client with demo credentials and sends a digital check via callback.

Debug

Known issues

gotchaAll API methods use callbacks, not promises. Use util.promisify or wrap for async/await.

fix

Wrap with new Promise: new Promise((resolve, reject) => Checkbook.checks.sendDigitalCheck(params, (err, res) => err ? reject(err) : resolve(res)))

affects: >=1.0.0

gotchaEnvironment parameter 'env' defaults to production if omitted, but demo sandbox keys only work with env: 'demo' or 'sandbox'.

fix

Always specify env when using test credentials: env: 'demo'

affects: >=1.0.0

gotchaOAuth bearer token is set as 'bearer' property, not 'api_key' and 'api_secret'.

fix

Use bearer in constructor: new CheckbookAPI({ bearer: '...', env: 'demo' })

affects: >=1.0.0

gotchaIdempotency key is optional third argument; passing it as part of params will be ignored.

fix

Call method with three arguments: sendDigitalCheck(params, callback, idempotencyKey)

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: Checkbook is not a constructor

Using import instead of require with CommonJS package.

fix

Use const CheckbookAPI = require('checkbook-api');

Error: Invalid API credentials

Using demo credentials without setting env: 'demo'.

fix

Add env: 'demo' to the constructor options.

UnhandledPromiseRejectionWarning: TypeError: callback is not a function

Calling a method without a callback function.

fix

Provide a callback function as the last argument.

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

41 hits · last 30 days

node

Perplexity

Resources

githubhttps://github.com/Precise-Finance/checkbook_node ↗

packagehttps://www.npmjs.com/package/checkbook-api-ts ↗

homepagehttps://checkbook.io ↗