CoinGate Ruby Gem

CoinGate Bitcoin payment gateway.

Installation

Sign up for CoinGate account at https://coingate.com for live (production) and https://sandbox.coingate.com for testing (sandbox) environment.

Please note, that for Sandbox you must generate separate API credentials on https://sandbox.coingate.com. API credentials generated on https://coingate.com will not work for Sandbox mode.

Add this line to your application's Gemfile:

gem 'coingate'

And then execute:

$ bundle

Or install it yourself by executing:

$ gem install coingate

Usage

Create API credentials

To create API credentials go to https://coingate.com for production or https://sandbox.coingate.com for testing environment

Setup CoinGate library

You can set default configuration like this:

CoinGate.config do |config|
  config.auth_token  = 'get_your_auth_token_at_coingatecom'
  config.environment = 'live' # live or sandbox. Default: live
end

order = CoinGate::Merchant::Order.find(1)

Or you can pass authentication params individually, for example:

order = CoinGate::Merchant::Order.find(1, {auth_token: 'coingate', environment: 'sandbox'})

Create Order

CoinGate::Merchant::Order#create

post_params = {
  order_id:         'ORDER-1412759367',
  price_amount:     1050.99,
  price_currency:   'USD',
  receive_currency: 'EUR',
  callback_url:     'https://example.com/payments/callback?token=6tCENGUYI62ojkuzDPX7Jg',
  cancel_url:       'https://example.com/cart',
  success_url:      'https://example.com/account/orders',
  description:      'Apple Iphone 6'
}

order = CoinGate::Merchant::Order.create(post_params)

if order
  # success
else
  # order is not valid
end

CoinGate::Merchant::Order#create!

post_params = {
  order_id:         'ORDER-1412759367',
  price_amount:     1050.99,
  price_currency:   'USD',
  receive_currency: 'EUR',
  callback_url:     'https://example.com/payments/callback?token=6tCENGUYI62ojkuzDPX7Jg',
  cancel_url:       'https://example.com/cart',
  success_url:      'https://example.com/account/orders',
  description:      'Apple Iphone 6'
}

# Raises exception if order is not valid.
order = CoinGate::Merchant::Order.create!(post_params)

Find Order

CoinGate::Merchant::Order.find

order = CoinGate::Merchant::Order.find(1)

if order
  # success
else
  # order not found
end

CoinGate::Merchant::Order.find!

# Raises exception when order is not found
order = CoinGate::Merchant::Order.find!(1)