README.md

gn-api-sdk-node

A nodejs module for integration of your backend with the payment services provided by Gerencianet.

⚠️ This module is under development and is based on the new API that Gerencianet is about to release. It won't work in production by now.

Installation

$ npm install gn-api-sdk-node

Basic usage

Require the module:

var Gerencianet = require('gn-api-sdk-node');

Set your credentials and whether you want to use sandbox or not:

var options = {
  client_id: 'your_client_id',
  client_secret: 'your_client_secret',
  sandbox: true
}

Instantiate the module passing your options:

var gerencianet = new Gerencianet(options);

Create a charge:

var chargeInput = {
  items: [{
    name: 'Product A',
    value: 1000,
    amount: 2
  }]
}

gerencianet
  .createCharge(chargeInput)
  .then(console.log)
  .catch(console.log)
  .done();

Examples

To run the examples, clone this repo and install the dependencies:

$ git clone [email protected]:franciscotfmc/gn-api-sdk-node.git
$ cd gn-api-sdk-node/docs/examples
$ npm install

Set your oauth keys in credentials.js:

module.exports = {
  client_id: 'your_client_id',
  client_secret: 'your_client_secret'
}

Then run the example you want:

$ node createCharge.js

Tests

To run the test suite, first install the dependencies, then run npm test:

$ cd gn-api-sdk-node/
$ npm install
$ npm test

Additional docs

• Creating charges with shippings
• Creating charges associated to customers
• Creating charges with marketplace
• Sending charges via post office service
• Associating customers to charges subsequently
• Subscriptions
• Detailing charges and subscriptions
• Creating and retrieving carnets
• Listing installments in advance
• Paying a charge
• Notifications
• All in one

Changelog

CHANGELOG

License

MIT