svb-book-transfers/README.md

Helper API to issue wire transfers

# svb-book-transfers

A NodeJS helper library to create, cancel, and retrieve records of book
transfers between Silicon Valley Bank accounts.

Uses SVB-Client module and your API credentials.

## Usage

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

// initiate a book transfer
Transfers.create({ ... }, (err, record) => {
  console.log(record.id);
});

// retrieve details of a book transfer (including status)
Transfers.get(transfer_id, (err, record) => { });

// get all of my book transfers
Transfers.all((err, list) => { });

// cancel a book transfer
// you cannot change a book transfer to any other status
Transfers.updateStatus(transfer_id, 'canceled', (err) => { });
```

## Installation

```npm install svb-book-transfers --save```