Skip to content

COINQVEST/ruby-merchant-sdk

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 

COINQVEST Merchant SDK (Ruby)

Official COINQVEST Merchant API SDK for Ruby by www.coinqvest.com

This SDK implements the REST API documented at https://www.coinqvest.com/en/api-docs

For SDKs in different programming languages, see https://www.coinqvest.com/en/api-docs#sdks

Read our Merchant API development guide and the examples below to help you get started.

Requirements

  • Ruby >= 2.0.0
  • rest-client >= 2.1.0
  • json >= 2.3.0

Installation with gem

gem install coinqvest_merchant_sdk

Usage Client

require 'coinqvest_merchant_sdk/client'

client = CoinqvestMerchantSDK::Client.new(
    'YOUR-API-KEY',
    'YOUR-API-SECRET',
    '/var/log/coinqvest-ruby.log' # an optional log file location
)

Get your API key and secret here: https://www.coinqvest.com/en/api-settings

Examples

Create a Customer (https://www.coinqvest.com/en/api-docs#post-customer)

Creates a customer object, which can be associated with checkouts, payments, and invoices. Checkouts associated with a customer generate more transaction details, help with your accounting, and can automatically create invoices for your customer and yourself.

response = client.post('/customer', {:customer => {
    :email => 'john@tester-1.com',
    :firstname => 'John',
    :lastname => 'Doe',
    :company => 'ACME Inc.',
    :adr1 => '810 Beach St',
    :adr2 => 'Finance Department',
    :zip => 'CA 94103',
    :city => 'San Francisco',
    :countrycode => 'US'
}})
print "Status Code: " + response.code.to_s + "\n"
print "Response Body: " + response.body + "\n"

Create a Hosted Checkout (https://www.coinqvest.com/en/api-docs#post-checkout-hosted)

Hosted checkouts are the simplest form of getting paid using the COINQVEST platform.

Using this endpoint, your server submits a set of parameters, such as the payment details including optional tax items, customer information, and settlement currency. Your server then receives a checkout URL in return, which is displayed back to your customer.

Upon visiting the URL, your customer is presented with a checkout page hosted on COINQVEST servers. This page displays all the information the customer needs to complete payment.

response = client.post('/checkout/hosted', {
    :charge => {
        :customerId => customer_id, # associates this charge with a customer as crated by POST /customer
        :billingCurrency => 'USD', # a billing currency as given by GET /currencies
        :lineItems => [{ # a list of line items included in this charge
            :description => 'T-Shirt',
            :netAmount => 10, # denominated in the currency specified above
            :quantity => 1
        }],
        :discountItems => [{ # an optional list of discounts
            :description => 'Loyalty Discount',
            :netAmount => 0.5
        }],
        :shippingCostItems => [{ # an optional list of shipping and handling costs
            :description => 'Shipping and Handling',
            :netAmount => 3.99,
            :taxable => FALSE # sometimes shipping costs are taxable
        }],
        :taxItems => [{ # an optional list of taxes
            :name => 'CA Sales Tax',
            :percent => 0.0825 # 8.25% CA sales tax
        }]
    },
    :settlementAsset => 'USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN' # your settlement asset as given by GET /assets (or ORIGIN to omit conversion)
})
print "Status Code: " + response.code.to_s + "\n"
print "Response Body: " + response.body + "\n"

Monitor Payment State (https://www.coinqvest.com/en/api-docs#get-checkout)

Once the payment is captured we notify you via email, webhook. You can also poll GET /checkout for payment status updates:

response = client.get('/checkout', {:id => checkout_id})
if response.code == 200
  data = JSON.parse(response.body)
  state = data["checkout"]["state"]
  if state == 'COMPLETED'
    print "The payment has completed and your account was credited. You can now ship the goods."
  else
    # try again in 30 seconds or so...
  end
end

Query your USD Wallet (https://www.coinqvest.com/en/api-docs#get-wallet)

response = client.get('/wallet', {:assetCode => 'USD'})

Query all Wallets (https://www.coinqvest.com/en/api-docs#get-wallets)

response = client.get('/wallets')

Withdraw USDC to your Bitcoin Account (https://www.coinqvest.com/en/api-docs#post-withdrawal)

response = client.post('/withdrawal', {
  :sourceAsset => 'USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN', #withdraw from your USDC wallet
  :sourceAmount => '100',
  :targetNetwork => 'BITCOIN', # a target network as given by GET /networks
  :targetAccount => {
    :address => 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
  }
})

Withdraw USDC to your Stellar Account (https://www.coinqvest.com/en/api-docs#post-withdrawal)

response = client.post('/withdrawal', {
  :sourceAsset => 'USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN', #withdraw from your USDC wallet
  :sourceAmount => '100',
  :targetNetwork => 'STELLAR', # a target network as given by GET /networks
  :targetAccount => {
    :account => 'GDONUHZKLSYLDOZWR2TDW25GFXOBWCCKTPK34DLUVSOMFHLGURX6FNU6',
    :memo => 'Exodus',
    :memoType => 'text'
  }
})

Update a Customer (https://www.coinqvest.com/en/api-docs#put-customer)

response = client.put('/customer', {:customer => {
    :id => customer_id,
    :email => 'john@tester-2.com'
}})

Delete a Customer (https://www.coinqvest.com/en/api-docs#delete-customer)

response = client.delete('/customer', {:id => customer_id})

List your 250 newest customers (https://www.coinqvest.com/en/api-docs#get-customers)

response = client.get('/customers', {:limit => 250})

List all available assets (https://www.coinqvest.com/en/api-docs#get-assets)

response = client.get('/assets')

List all available networks (https://www.coinqvest.com/en/api-docs#get-networks)

response = client.get('/networks')

Please inspect https://www.coinqvest.com/en/api-docs for detailed API documentation or email us at service@coinqvest.com if you have questions.

Support and Feedback

We'd love to hear your feedback. If you have specific problems or bugs with this SDK, please file an issue on GitHub. For general feedback and support requests please email service@coinqvest.com.

Contributing

  1. Fork it ( https://github.com/COINQVEST/ruby-merchant-sdk/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request