![SDK Node Mercado Pago](https://github.com/lucmkz/sdk-nodejs/assets/31546923/84211022-6fc5-4db1-8772-117eca84f2d9)
Mercado Pago SDK for NodeJS
![License](https://img.shields.io/apm/l/vim-mode)
This library provides developers with a simple set of bindings to help you integrate Mercado Pago API 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, if you don’t have one already.
- Install NodeJS SDK for MercadoPago running in command line:
$ npm install --save mercadopago
- Copy the access_token in the 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:
import { MercadoPagoConfig, Payment } from 'mercadopago';
const client = new MercadoPagoConfig({ accessToken: 'access_token', options: { timeout: 5000, idempotencyKey: 'abc' } });
const payment = new Payment(client);
const body = {
transaction_amount: 12.34,
description: '<DESCRIPTION>',
payment_method_id: '<PAYMENT_METHOD_ID>',
payer: {
email: '<EMAIL>'
},
};
const requestOptions = {
idempotencyKey: '<IDEMPOTENCY_KEY>',
};
payment.create({ body, requestOptions }).then(console.log).catch(console.log);
Step 1: Import the parts of the module you want to use
Import MercadoPagoConfig
and API objects from the MercadoPago module.
import { MercadoPagoConfig, Payment } 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 requestsidempotencyKey
: Idempotency Is for retrying requests without accidentally performing the same operation twice
For example:
const client = new MercadoPagoConfig({ accessToken: 'access_token', options: { timeout: 5000, idempotencyKey: 'abc' } });
Step 3: Initialize the API object
Initialize the API object you want to use, passing the client
object from the previous step.
const payment = new Payment(client);
Step 4: Create the request object
Create a the request object. For example, for a request to the /v1/payments
endpoint:
const body = {
transaction_amount: 12.34,
description: '<DESCRIPTION>',
payment_method_id: '<PAYMENT_METHOD_ID>',
payer: {
email: '<EMAIL>'
},
};
Step 5: Make the request
Use the API object's method to make the request. For example, to make a request to the /v1/payments
endpoint using the payment
object:
payment.create({ body }).then(console.log).catch(console.log);
📚 Documentation
Visit our Dev Site for further information regarding:
🤝 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. 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
/ Portuguese
/ Spanish
🏻 License
MIT license. Copyright (c) 2024 - Mercado Pago / Mercado Libre
For more information, see the LICENSE file.