This library provides developers with a simple set of bindings to help you integrate Mercado Pago API to a website and start receiving payments.
The SDK Supports NodeJS version 12 or higher.
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.
Simple usage looks like:
// Step 1: Import the parts of the module you want to use
import MercadoPago, { CardToken } from 'mercadopago';
// Step 2: Initialize the client object
const client = new MercadoPago({ accessToken: 'access_token', options: { timeout: 5000, idempotencyKey: 'abc' } });
// Step 3: Initialize the API object
const cardToken = new CardToken(client);
// Step 4: Create the request object
const body = {
card_id : 'card_id',
security_code : 'security_code'
};
// Step 5: Make the request
cardToken.create({ cardTokenBody : body })
.then((result) => console.log(result));
Import MercadoPago
and API objects from the MercadoPago module.
import MercadoPago, { CardToken } from 'mercadopago';
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 MercadoPago({ accessToken: 'access_token', options: { timeout: 5000, idempotencyKey: 'abc' } });
Initialize the API object you want to use, passing the client
object from the previous step.
const cardToken = new CardToken(client);
Create a the request object. For example, for a request to the /v1/card_tokens
endpoint:
const body = {
card_id : 'card_id',
security_code : 'security_code'
};
Use the API object's method to make the request. For example, to make a request to the /v1/card_tokens
endpoint using the CardToken
object:
cardToken.create({ cardTokenBody : body })
.then((result) => console.log(result))
.catch(error => console.log(error));
Visit our Dev Site for further information regarding:
- Payments APIs: Spanish / Portuguese
- Mercado Pago checkout: Spanish / Portuguese
- Web Tokenize checkout: Spanish / Portuguese
Check our official code reference to explore all available functionalities.
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.
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.
If you require technical support, please contact our support team at our developers site: English / Portuguese / Spanish
MIT license. Copyright (c) 2023 - Mercado Pago / Mercado Libre
For more information, see the LICENSE file.