gn-api-sdk-node

gn-api-sdk-node

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

:warning: Gerencianet API is under BETA version, meaning that it's not available for all users right now. If you're interested, you can always send an email to [e-mail] and we'll enable it for your account

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 [e-mail]:gerencianet/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 documentation

Charges

• Creating charges
• Paying a charge
• Detailing charges
• Updating informations
• Resending billet
• Adding information to charge history

Carnets

• Creating carnets
• Detailing carnets
• Updating informations
• Resending the carnet
• Resending carnet parcel
• Adding information to carnet history
• Canceling the carnet
• Canceling carnet parcel

Subscriptions

• Creating subscriptions
• Paying a subscription
• Detailing subscriptions
• Updating informations

Marketplace

• Creating a marketplace

Notifications

• Getting notifications

Payments

• Getting installments

All in one

• Usage

Changelog

CHANGELOG

License

MIT