Powerful, flexible, lightweight interface to the BitPay Bitcoin Payment Gateway API.
gem install bitpay-client
In your Gemfile:
gem 'bitpay-client', :require => 'bitpay'
Or directly:
require 'bitpay'
To create an invoice:
client = BitPay::Client.new 'YOUR_API_KEY'
invoice = client.post 'invoice', {:price => 10.00, :currency => 'USD'}
With invoice creation, price and currency are the only required fields. If you are sending a customer from your website to make a purchase, setting redirectURL will redirect the customer to your website when the invoice is paid.
Response will be a hash with information on your newly created invoice. Send your customer to the url to complete payment:
{
"id" => "DGrAEmbsXe9bavBPMJ8kuk",
"url" => "https://bitpay.com/invoice?id=DGrAEmbsXe9bavBPMJ8kuk",
"status" => "new",
"btcPrice" => "0.0495",
"price" => 10,
"currency" => "USD",
"invoiceTime" => 1383265343674,
"expirationTime" => 1383266243674,
"currentTime" => 1383265957613
}
There are many options available when creating invoices, which are listed in the BitPay API documentation.
To get updated information on this invoice, make a get call with the id returned:
invoice = client.get 'invoice/DGrAEmbsXe9bavBPMJ8kuk'
During development and testing, take advantage of the Bitcoin TestNet by passing a custom api_uri option on initialization:
BitPay::Client.new("myAPIKey", {api_uri: "https://test.bitpay.com/api"})
Note that you will need a separate API key for test.bitpay.com which can be obtained by registering for a test account at https://test.bitpay.com/start
API Documentation is available on the BitPay site.
The code has been fully code documented, and the latest version is always available at the Rubydoc Site.
$ bundle install
$ bundle exec rake
In addition to a full test suite, there is Travis integration for MRI 1.9, JRuby and Rubinius.
Let us know! Send a pull request or a patch. Questions? Ask! We're here to help. We will respond to all filed issues.
Click here to see a list of the contributors to this library.