Conekta API library for Node.js

This is the officially supported Node.js library for using Conekta's APIs.

Supported API versions

The library supports all APIs under the following services:

| API | Description | Service Name | Supported version | |---------------------------------------------------------------------------------------------| ----------- |-------|-------------------| | Payments API | Our classic integration for online payments. Current supported version | Payments API | v2.1.0 |

For more information, refer to our documentation.

Prerequisites

• Conekta account
• API key. your API credential .
• Install Node.js version 14 or later.

Installation

Install the Node.JS package:

npm install --save conekta

Alternatively, you can download the release on GitHub.

Updating

To update the Node.JS package:

npm update conekta

Check for breaking changes on the releases page.

Using the library

In order to submit http request to Conekta API you need to initialize the client. The following example makes a order request:

import { CustomersApi, Configuration, Customer, CustomerResponse } from "conekta";

const apikey = "key_xxxxx";
const config = new Configuration({ accessToken: apikey });
const client = new CustomersApi(config);

const customer: Customer = {
  name: "John Constantine",
  email: "[email protected]",
  phone: "+5215555555555"
}

client.createCustomer(customer).then(response => {
  const customerResponse = response.data as CustomerResponse;
  console.log(customerResponse.id);
}).catch(error => {
  console.error("here", error);
});

Running the tests

Navigate to conekta-node folder and run the following commands.

npm run build
npm run test

Contributing

We encourage you to contribute to this repository, so everyone can benefit from new features, bug fixes, and any other improvements. Have a look at our contributing guidelines to find out how to raise a pull request.

Support

If you have a feature request, or spotted a bug or a technical problem, create an issue here.

For other questions, contact our Support Team.

Licence

This repository is available under the MIT license.

See also

• Conekta docs