README.md

Libreria Node.js para el API de Nequi

Proporciona acceso al API de Nequi para aplicaciones Node.js

Tenga en cuenta que esta libreria es para usar del lado del servidor ya que requiere las claves secretas de Nequi. No debe usarse directamente en el browser.

Instalación

Instalar el paquete con:

npm install nequi --save

Servicios soportados

• Pagos con Notificación
• Pagos con QR code
• Pagos con suscripción

Documentación

• Wiki.
• Nequi.
• Nequi API.

Uso

El paquete debe configurarse con las credenciales de su cuenta.

var nequiClient = require('nequi')('Your Access Key', 'Your Secret Key', 'Your API Key');

var payment = await nequiClient.pushPayments.create({
  phoneNumber: '3009871234',
  code: '1',
  value: '5000'
});

O con versiones anteriores a Node.js v7.9

var nequiClient = require('nequi')('Your Access Key', 'Your Secret Key', 'Your API Key');

nequiClient.pushPayments.create(
  {
    phoneNumber: '3009871234',
    code: '1',
    value: '5000'
  },
  function(err, response) {
    err; // null si no hay errores
    response; // respuesta del servicio
  }
);

O usando modulos ES:

import nequi from 'nequi';
const nequiClient = nequi('Your Access Key', 'Your Secret Key', 'Your API Key');
//…

Promesas

Cada método devuelve una promesa encadenable que se puede utilizar en lugar de un callback:

// Crea y consultar una nueva suscripción:
nequi.subscriptionPayments.subscribe({
  phoneNumber: '3009871234',
  code: '1',
  name: 'Company/Service name'
})
.then(function(subscription) {
  return nequi.subscriptionPayments.getSubscription({
    phoneNumber: '3009871234',
    code: '1',
    token: subscription.token
  });
})
.then(function(subscription) {
  // new subscription
}).catch(function(err) {
  // Deal with an error
});

Desarrollo

Ejecutar pruebas:

$ npm install
$ npm test

Ejecutar solo un archivo:

$ npm run mocha -- test/Error.spec.js

Ejecutar un caso de prueba:

$ npm run mocha -- test/Error.spec.js --grep 'Populates with type'

_{^{Desarrollo basado en la Libreria Node.js de Stripe}}