svb-ach/README.md

Helper API to issue ACH money transfers

# node-svb-ach

A NodeJS helper library to create, cancel, and retrieve records of ACH requests
transferring money in and out of Silicon Valley Bank accounts.

Uses SVB-Client module and your API credentials.

## Usage

```javascript
let client = new SVBClient({
  API_KEY: '',
  HMAC_SECRET: ''
});
let ACH = new ACHClient(client);

// initiate an ACH
ACH.create({ ... }, (err, record) => {
  console.log(record.id);
});

// retrieve details of an ACH (including status)
ACH.get(ach_id, (err, record) => { });

// get all of my ACHs
ACH.all((err, list) => { });

// get all of my pending ACHs
// valid statuses are: pending, processing, canceled, failed, succeeded
ACH.find({ status: 'pending' }, (err, list) => {  });

// YYYY-MM-DD
ACH.find({ effective_date: '2017-05-31' }, callback);

// cancel an ACH
// you cannot change an ACH to any other status
ACH.updateStatus(ach_id, 'canceled', (err) => { });
```

## Installation

```npm install svb-ach --save```