ach-node-sdk

library1.12.0jsnpmunverified

The ACH Node SDK is a generated TypeScript client for the moov-io/ach REST API, providing typed access to ACH file operations. Current stable version is 1.12.0, released on a monthly cadence. It differs from other ACH libraries by being auto-generated from the OpenAPI spec, ensuring API parity, and shipping with full TypeScript definitions for type safety. Designed for Node.js and TypeScript projects, it simplifies integration with moov-io/ach services for creating, parsing, and managing ACH files.

payments

npm install ach-node-sdk

package ↗

INSTALL

IMPORT

SIG · ACH-NODE-SDK

ach-node-sdk

paymentsjavascriptv1.12.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

ACHFilesApi

✓ import { ACHFilesApi } from 'ach-node-sdk'

✗ const ACHFilesApi = require('ach-node-sdk').ACHFilesApi

CommonJS require works but ESM import is preferred for TypeScript support.

Configuration

✓ import { Configuration } from 'ach-node-sdk'

✗ const { Configuration } = require('ach-node-sdk')

Both import and require are supported. Ensure basePath option is provided.

AchFile

✓ import { AchFile } from 'ach-node-sdk'

Type export used for creating ACH file objects.

Demonstrates setting up the configuration and API client, then listing ACH files asynchronously.

import { ACHFilesApi, Configuration } from 'ach-node-sdk'; const configuration = new Configuration({ basePath: 'https://ach.mycompany.com' }); const api = new ACHFilesApi(configuration); async function listFiles() { try { const response = await api.getFiles(); console.log('Files:', response.data); } catch (error) { console.error('Error fetching files:', error); } } listFiles();

Debug

Known issues

breakingVersion 1.0.0 changed the package name from 'ach-sdk' to 'ach-node-sdk'. All imports must be updated.

fix

Update package.json and imports to use 'ach-node-sdk'.

affects: >=1.0.0

deprecatedThe `BaseAPI` class is deprecated in favor of specific API classes like `ACHFilesApi`.

fix

Replace `BaseAPI` with the appropriate typed API class.

affects: >=1.5.0

gotchaThe `basePath` property in Configuration must include the protocol (https://) and no trailing slash.

fix

Ensure basePath is e.g., 'https://ach.mycompany.com' not 'ach.mycompany.com/'.

affects: >=0.1.0

Errors

Common errors & fixes

TypeError: Cannot read properties of undefined (reading 'request')

SDK not configured properly; missing or invalid basePath.

fix

Instantiate Configuration with a valid basePath.

Module not found: Can't resolve 'ach-node-sdk'

Package not installed or import path incorrect.

fix

Run 'npm install ach-node-sdk' and verify import path.

Property 'getFiles' does not exist on type 'ACHFilesApi'

Using wrong version of the SDK; method may have been renamed.

fix

Check generated docs for correct method name (e.g., listFiles).

Upgrade

Version history

1.12.0latest on npm

Audit

Dependencies

axiosrequiredHTTP client for API requests

Agent activity

59 hits · last 30 days

node

OpenAI (training)

Perplexity

Resources

packageach-node-sdk ↗