Bitpay - Bitcoin Payment Library for Node.js
I want a simple way to use the Bitpay Bitcoin API in node.js,
and npm -- Node Package Manager -- is the standard way to distribute
javascript libraries for Node.js.
Like other HTTP client libraries a
Client object will manage authentication
and connection to Bitpay's servers. All requests to the API will ultimately be
made using the Client object initialized with the Bitpay account credentials.
Installation
npm install bitpay-node
Example Usage
#### Initialzing a Client object with Bitpay Api Key
var Bitpay = require('bitpay-node');
var client = new Bitpay.Client({ apiKey: process.env.BITPAY_API_KEY });
#### Creating an Invoice
var invoiceOptions = {
price: 0.001,
currency: 'BTC'
};
client.createInvoice(invoiceOptions, function(err, invoice) {
console.log(invoice);
})
The call to createInvoice above should produce a JSON response as per the official
Bitpay API
documenation
{ id: '2Rpei3aKcJZUDWDSJ92oSq',
url: 'https://bitpay.com/invoice?id=2Rpei3aKcJZUDWDSJ92oSq',
status: 'new',
btcPrice: '0.0010',
price: 0.001,
currency: 'BTC',
invoiceTime: 1390253166402,
expirationTime: 1390254066402,
currentTime: 1390253166452 }
#### Retrieving an Invoice with Status
Once an invoice has been created a call can be made to get its info and status.
client.getInvoice('2Rpei3aKcJZUDWDSJ92oSq', function(err, invoice) {
console.log(invoice);
});
Which will return the same structure as the call to createInvoice, except now
the status may have transitioned to either
paid,
confirmed,
complete,
expired or
invalid.
Tests
Run the tests wiith Mocha, and make sure to specify your Bitpay API Key in environment.
On the Bitpay account
API keys page your can generate multiple API keys
for your various applications. Enable API key access and generate a key to use in the tests:
BITPAY_API_KEY=46beb6dc657d4ceff4219a8e691b5015 mocha test/