NodeJS SDK

Official COINQVEST SDK for Ruby. Accept digital currencies like Bitcoin, Ether, or Stellar Lumens and settle in your national currency.

README.md


COINQVEST Merchant SDK (NodeJS)

Official COINQVEST Merchant API SDK for NodeJS 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

  • NodeJS >= 10.14.0
  • axios >= 0.19.2

Installation with npm

npm install coinqvest-merchant-sdk

Usage Client

require('coinqvest-merchant-sdk');

const client = new CoinqvestClient(
    'YOUR-API-KEY',
    'YOUR-API-SECRET'
);

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.

client.post('/customer',
    {
        customer:{
            email: 'john@doe.com',
            firstname: 'John',
            lastname: 'Doe',
            company: 'ACME Inc.',
            adr1: '810 Beach St',
            adr2: 'Finance Department',
            zip: 'CA 94133',
            city: 'San Francisco',
            countrycode: 'US'
        }
    },
    function (response) {

        console.log(response.status);
        console.log(response.data);

        if (response.status !== 200) {
            // something went wrong, let's abort and debug by looking at our log file
            console.log('Could not create customer. Inspect above log entry.');
            return;
        }

        let customerId = response.data['customerId']; // store this persistently in your database
    }
);

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.

client.post('/checkout/hosted',
    {
        charge:{
            customerId: customerId, // associates this charge with a customer
            currency: 'USD', // specifies the billing currency
            lineItems: [{ // a list of line items included in this charge
                description: 'T-Shirt',
                netAmount: 10,
                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: [{
                name: 'CA Sales Tax',
                percent: 0.0825 // 8.25% CA sales tax
            }]
        },
        settlementCurrency: 'EUR' // specifies in which currency you want to settle
    },
    function (response) {

        console.log(response.status);
        console.log(response.data);

        if (response.status !== 200) {
            // something went wrong, let's abort and debug by looking at our log file
            console.log('Could not create checkout.');
            return;
        }

        // the checkout was created
        // response.data now contains an object as specified in the success response here: https://www.coinqvest.com/en/api-docs#post-checkout
        let checkoutId = response.data['checkoutId']; // store this persistently in your database
        let url = response.data['url']; // redirect your customer to this URL to complete the payment

    }
);

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

Once the payment is captured we notify you via email, WEBHOOK /payment, or you can poll GET /checkout for payment status updates:

client.get('/checkout',
    {id: checkoutId},
    function(response) {
        console.log(response.status);
        console.log(response.data);

        if (response.status === 200) {
            let state = response.data['checkout']['state'];
            if (['COMPLETED', 'DELAYED_COMPLETED', 'RESOLVED'].includes(state)) {
                console.log("The payment has completed and your account was credited. You can now ship the goods.");
            } else {
                // try again in 30 seconds or so...
            }
        }
    }
);

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

client.get('/wallet',
    {assetCode: 'USD'},
    function(response) {
        console.log(response.status);
        console.log(response.data);
    }
);

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

client.get('/wallets',
    null,
    function(response) {
        console.log(response.status);
        console.log(response.data);
    }
);

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

client.post('/withdrawal',
    {
        sourceAsset: 'USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX', // withdraw from your USD wallet
        sourceAmount: 100,
        targetNetwork: 'NGN', // send to an NGN bank account
        targetAccount: {
            nuban: '3080494548',
            bankName: 'FirstBank'
        }
    },
    function (response) {
        console.log(response.status);
        console.log(response.data);
    }
);

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

client.post('/withdrawal',
    {
        sourceAsset: 'USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX', // withdraw from your USD wallet
        sourceAmount: 100,
        targetNetwork: 'BTC', // send to a BTC address
        targetAccount: {
            address: 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
        }
    },
    function (response) {
        console.log(response.status);
        console.log(response.data);
    }
);

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

client.post('/withdrawal',
    {
        sourceAsset: 'USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX', // withdraw from your USD wallet
        sourceAmount: 100,
        targetNetwork: 'XLM', // send to a Stellar account
        targetAccount: {
            account: 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23',
            memo: 'Exodus',
            memoType: 'text'
        }
    },
    function (response) {
        console.log(response.status);
        console.log(response.data);
    }
);

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

client.put('/customer',
    {customer:{id: 'CUSTOMER-ID', email: 'john@doe-2.com'}},
    function (response) {
        console.log(response.status);
        console.log(response.data);
    }
);

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

client.delete('/customer',
    {id: 'CUSTOMER-ID'},
    function (response) {
        console.log(response.status);
        console.log(response.data);
    }
);

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

client.get('/wallet',
    {limit: 250},
    function(response) {
        console.log(response.status);
        console.log(response.data);
    }
);

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

client.get('/blockchains',
    null,
    function(response) {
        console.log(response.status);
        console.log(response.data);
    }
);

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

client.get(
    '/fiat-currencies',
    null,
    function(response) {
        console.log(response.status);
        console.log(response.data);
    }
);

The response object (axios HTTP response as given to your callback function)

{
  // `data` is the response that was provided by the server
  data: {},

  // `status` is the HTTP status code from the server response
  status: 200,

  // `statusText` is the HTTP status message from the server response
  statusText: 'OK',

  // `headers` the HTTP headers that the server responded with
  // All header names are lower cased and can be accessed using the bracket notation.
  // Example: `response.headers['content-type']`
  headers: {},

  // `config` is the config that was provided to `axios` for the request
  config: {},

  // `request` is the request that generated this response
  // The last ClientRequest instance in node.js (in redirects)
  request: {}
}

Please inspect https://www.coinqvest.com/en/api-docs for detailed API documentation or send us an email to service@coinqvest.com.

Support and Feedback

Your feedback is appreciated! If you have specific problems or bugs with this SDK, please file an issue on Github. For general feedback and support requests, send an email to service@coinqvest.com.

Contributing

  1. Fork it ( https://github.com/COINQVEST/nodejs-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
View on GitHub View API Docs