GUIDE.md

Using BitPay with Node.js

Prerequisites

You must have a BitPay merchant account to use this library. It's free to sign-up for a BitPay merchant account.

Once you have a BitPay merchant account, you will need a working BitPay Access Token – this can be done either via the library or manually in the BitPay Dashboard.

Node.js Quick Start

Using BitPay with your Node.js project is extremely simple. Once you've registered a BitPay account, install the bitpay project via npm:

$ cd <your project folder>
$ npm install bitpay --save

You'll notice that we've added the --save parameter to automatically save the BitPay library to your package.json file.

Now, in your Node application, creating an Invoice is as simple as follows:

Creating An Invoice

var BitPay  = require('bitpay');
var privkey = fs.readFileSync('path/to/private.key');
var bitpay  = BitPay.createClient( privkey );

bitpay.on('ready', function() {
  bitpay.post('invoices', function(err, invoice) {
    console.log(err || invoice);
  });
});

You will receive either an err if any error took place, or an invoice if the invoice was successfully created.

Issuing A Refund

Every Invoice on BitPay has a "refunds" subcollection. To create a refund request, POST into it:

bitpay.post('invoices/:invoiceID/:refunds', function(err, refundRequest) {
  
});

Create a Recurring Bill

bitpay.post('subscriptions', {
  billData: {/*...*/},// type: Bill.  See the Bill Schema.
  schedule: 'monthly' // type: enumerable, ['weekly', 'monthly', 'quarterly', 'yearly']
})

Bill Schema: https://bitpay.com/api#resource-Bills