https://github.com/mercadopago/sdk-nodejs
Mercado Pago's Official Node.js SDK
https://github.com/mercadopago/sdk-nodejs
backend-sdk mercadopago node nodejs sdk
Last synced: about 1 month ago
JSON representation
Mercado Pago's Official Node.js SDK
- Host: GitHub
- URL: https://github.com/mercadopago/sdk-nodejs
- Owner: mercadopago
- License: mit
- Created: 2016-12-18T20:28:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T17:28:53.000Z (12 months ago)
- Last Synced: 2024-05-17T20:48:49.109Z (12 months ago)
- Topics: backend-sdk, mercadopago, node, nodejs, sdk
- Language: TypeScript
- Homepage: https://developers.mercadopago.com/
- Size: 1.63 MB
- Stars: 299
- Watchers: 40
- Forks: 109
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.MD
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Mercado Pago SDK for NodeJS
[](http://npmjs.com/package/mercadopago)
[](http://npmjs.com/package/mercadopago)
This library provides developers with a simple set of bindings to help you integrate Mercado Pago APIs to a website and start receiving payments.
## 💡 Requirements
The SDK Supports NodeJS version 16 or higher.
## 📲 Installation
First time using Mercado Pago? Create your [Mercado Pago account](https://www.mercadopago.com), if you don’t have one already.
1. Install NodeJS SDK for MercadoPago running in command line:
```sh
$ npm install --save mercadopago
```
2. Copy the access_token in the [credentials](https://www.mercadopago.com/developers/en/docs/your-integrations/credentials) section of the page and replace YOUR_ACCESS_TOKEN with it.
That's it! Mercado Pago SDK has been successfully installed.
## 🌟 Getting Started
Simple usage looks like:
```javascript
// Step 1: Import the parts of the module you want to use
import { MercadoPagoConfig, Order } from "mercadopago";
// Step 2: Initialize the client object
const client = new MercadoPagoConfig({
accessToken: "",
options: { timeout: 5000 },
});
// Step 3: Initialize the API object
const order = new Order(client);
// Step 4: Create the request object
const body = {
type: "online",
processing_mode: "automatic",
total_amount: "1000.00",
external_reference: "ext_ref_1234",
payer: {
email: "",
},
transactions: {
payments: [
{
amount: "1000.00",
payment_method: {
id: "master",
type: "credit_card",
token: "",
installments: 1,
statement_descriptor: "Store name",
},
},
],
},
};
// Step 5: Create request options object - Optional
const requestOptions = {
idempotencyKey: "",
};
// Step 6: Make the request
order.create({ body, requestOptions }).then(console.log).catch(console.error);
```
### Step 1: Import the parts of the module you want to use
Import `MercadoPagoConfig` and API objects from the MercadoPago module.
```javascript
import { MercadoPagoConfig, Order } from "mercadopago";
```
### Step 2: Initialize the client object
Initialize the client object, passing the following:
- `accessToken`: Application's private key.
- `options`: These are optional fields,
- `timeout`: Are the timeout of requests
- `idempotencyKey`: [Idempotency](https://en.wikipedia.org/wiki/Idempotence) Is for retrying requests without accidentally performing the same operation twice
For example:
```javascript
const client = new MercadoPagoConfig({
accessToken: "",
options: { timeout: 5000, idempotencyKey: "" },
});
```
### Step 3: Initialize the API object
Initialize the API object you want to use, passing the `client` object from the previous step.
```javascript
const order = new Order(client);
```
### Step 4: Create the request object
Create the request object. For example, for a request to the `/v1/orders` endpoint:
```javascript
const body = {
type: "online",
processing_mode: "automatic",
total_amount: "1000.00",
external_reference: "ext_ref_1234",
payer: {
email: "",
},
transactions: {
payments: [
{
amount: "1000.00",
payment_method: {
id: "master",
type: "credit_card",
token: "",
installments: 1,
statement_descriptor: "Store name",
},
},
],
},
};
```
### Step 5: Make the request
Use the API object's method to make the request. For example, to make a request to the `/v1/orders` endpoint using the `order` object:
```javascript
order.create({ body }).then(console.log).catch(console.error);
```
## 📚 Documentation
Visit our Dev Site for further information regarding:
- Order API: [Spanish](https://mercadopago.com/developers/es/docs/order/landing) / [Portuguese](https://mercadopago.com/developers/pt/docs/order/landing) / [English](https://mercadopago.com/developers/en/docs/order/landing)
## 🤝 Contributing
All contributions are welcome, ranging from people wanting to triage issues, others wanting to write documentation, to people wanting to contribute with code.
Please read and follow our [contribution guidelines](CONTRIBUTING.md). Contributions not following these guidelines will be disregarded. The guidelines are in place to make all of our lives easier and make contribution a consistent process for everyone.
### Patches to version 1.x.x
Since the release of version 2.0.0, version 1 is deprecated and will not be receiving new features, only bug fixes. If you need to submit PRs for that version, please do so by using develop-v1 as your base branch.
## ❤️ Support
If you require technical support, please contact our support team at our developers
site: [English](https://www.mercadopago.com/developers/en/support/center/contact)
/ [Portuguese](https://www.mercadopago.com/developers/pt/support/center/contact)
/ [Spanish](https://www.mercadopago.com/developers/es/support/center/contact)
## 🏻 License
```
MIT license. Copyright (c) 2024 - Mercado Pago / Mercado Libre
For more information, see the LICENSE file.
```