isabella232 / pix-payment-sample-node

Pix payment processing with Checkout API

Português / Español

⚠️ Attention: Pix is a payment method only available in Brazil

💻 Technologies

• Node.js
• NPM (dependency manager)
• Express

💡 Requirements

• Node.js 10 or later (you can download it here).
• Read our instructions on how to create an application at the Mercado Pago Developer Panel in order to acquire your access token. It will grant you access to Mercado Pago's public APIs.
• For detailed information about receiving payments with Pix, please read our guide at Mercado Pago Developers.

⚙️ Installation

1. Clone the project.

git clone https://github.com/mercadopago/pix-payment-sample-node.git

2. Go to the project's folder.

cd pix-payment-sample-node

3. Then install the dependencies.

npm install

🌟 How to run it

1. Run the following command to start the application:

MERCADO_PAGO_SAMPLE_ACCESS_TOKEN=YOUR_ACCESS_TOKEN npm start

2. Remember to replace the value of YOUR_ACCESS_TOKEN with the corresponding credential from your account.

3. Navigate to http://localhost:8080 in your browser.

🧪 Testing

• On our testing instructions you'll find a guide on how to create test users.
• You have to create a Pix key in the seller's account in Mercado Pago (remember you can create and use a test user as a seller).
• IMPORTANT: there are some limitations when testing this payment method with test users. When creating a payment, it will be pending and the corresponding Pix code and QR code will be returned, but it will not be possible to use these codes to end the flow and approve the test payment.

🤝 Contributing

You can contribute to this project by reporting problems and bugs. Before opening an issue, make sure to read our code of conduct.

🔖 License

MIT License. Copyright (c) 2021 - Mercado Pago
For more information, see the LICENSE file.