@nure/conekta

Conekta node Wrapper

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
3121May 7, 2021May 11, 2015Minified + gzip package size for @nure/conekta in KB

Readme

README Cover Image

Conekta Node v 3.5.1

Wrapper to connect with https://api.conekta.io.

Install

npm install conekta

This last release works with API 2, if you are using 1.0 type:

npm install conekta@3.5.1

Usage

var conekta = require('conekta');

conekta.api_key = '9YxqfRnx4sMQDnRsqdYn';
conekta.locale = 'es';

conekta.Order.create({
    "currency": "MXN",
    "customer_info": {
        "name": "Jul Ceballos",
        "phone": "+5215555555555",
        "email": "jul@conekta.io"
    },
    "line_items": [{
        "name": "Box of Cohiba S1s",
        "description": "Imported From Mex.",
        "unit_price": 35000,
        "quantity": 1,
        "tags": ["food", "mexican food"],
        "type": "physical"
    }]
  }, function(err, res) {
    if (err) {
        console.log(err.type);
        return;
    }
    console.log(res.toObject());
});

Endpoints


Conekta.Order.create
Conekta.Order.update
Conekta.Order.find
Conekta.Order.where
Conekta.Order.createCharge
Conekta.Order.createLineItem
Conekta.Lineitem.update
Conekta.Order.createTaxLine
Conekta.TaxLine.update
Conekta.Order.createShippingLine
Conekta.ShippingLine.update
Conekta.Order.createDiscountLine
Conekta.DiscountLine.update
Conekta.Customer.create
Conekta.Customer.update
Conekta.Customer.find
Conekta.Customer.where
Conekta.Customer.destroy
Conekta.Customer.createSource
Conekta.Source.update
Conekta.Customer.createShippingContact
Conekta.ShippingContact.update
Conekta.Customer.createFiscalEntity
Conekta.FiscalEntity.update

Documentation

Please see https://developers.conekta.com/api?language=node for up-to-date documentation.

Contribute

Clone repo

$ git clone https://github.com/conekta/conekta-node
$ cd conekta-node

Install dependencies

$ npm install

Run interactive mode

$ bin/console
Welcome to Conekta node console!
Help: exit() to quit

> conekta.api_key = '9YxqfRnx4sMQDnRsqdYn';
'9YxqfRnx4sMQDnRsqdYn'
> conekta.locale = 'es';
'es'
> 

Run tests

Codeship Status

$ npm test

Send pull requests

We love pull requests, send them from your fork to branch dev into conekta/conekta-node

License

Developed in Mexico by Conekta. Available with MIT License.


We are always hiring!

If you are a comfortable working with a range of backend languages (Java, Python, Ruby, PHP, etc) and frameworks, you have solid foundation in data structures, algorithms and software design with strong analytical and debugging skills. Send us your CV and GitHub to quieroser@conekta.com

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.