Awesome
<p align="center"> <a href="http://nestjs.com/" target="blank"> <img src="https://avatars.githubusercontent.com/u/28507035?s=200&v=4" width="200" alt="Nest Logo" /> </a> <a href="http://developers.mercadopago.com" target="blank"> <img src="https://avatars.githubusercontent.com/u/900583?s=200&v=4" width="200" alt="MercadoPago Logo" /> </a> <hr> </p>| MercadoPago API Template | |
|---|---|
| ⚡️ | Launch your api instantly watching changes with live-reload |
| 📈 | Highly scalable using Repository design pattern to access the database even easier |
| 😎 | OpenAPI with Swagger to describe your RESTful APIs |
| ✨ | KISS principle make everything as simple as possible, but not simpler |
| 📱 | Mobile friendly supporting Cross-origin resource sharing (CORS) with a list of domains for restricted resources |
| 🔑 | Security using JWT authentication strategy with Passport and other techniques to increase the security of your applications |
| 👥 | Made for Users. Easily validate permissions for specific routes using Guards with a Role-based access control |
| ⏱ | Don't repeat yourself, Single responsibility principle. |
| 🔗 | Validation: provides pipes available right out-of-the-box with class-validator to enforce validation rules for all incoming client payloads |
| ⚠️ | Logger with Winston using different levels to track exceptions easily |
| 🔄 | Migrations using TypeORM to apply incremental updates to the database |
Introduction
Link: https://mercadopago-e-commerce.herokuapp.com/ecommerce
Credentials
Son las claves que MercadoPago proporciona para poder configurar tus integraciones, es una llave que identifica a tu usario (No compartir). Ejemplo:
- Public Key
- Access Token
- Client ID (Used with SDKs or plugins)
- Client Secret (Used with SDKs or plugins)
Link: https://www.mercadopago.com.co/settings/account/credentials
Es un dato obligatorio. Sirven para validar la identidad de la cuenta por medio de un token.
Checkout
Crear preferencia de pago
Permite iniciar el proceso de pago, al crear una preferencia se obtiene una url init_point para redireccionar los usuarios a un flujo de checkout.
Al finalizar el proceso de pago se recibe una notificación por medio de un Webhook que se configura en la creación de la preferencia, con una url notification_url de la API de nuestro negocio.
Link: https://www.mercadopago.com.co/developers/es/reference/preferences/_checkout_preferences/post
Notificaciones
Es necesario definir un endpoint donde se notificará el resultado del proceso de pago. La notificación se realizará a un Webhook el cual es un POST request unidireccional que MercadoPago envía a nuestro endpoint definido al momento de crear la preferencia de pago.
Acciones:
payment.created: Pago creado, pendiente de pago.payment.updated: Pago aprobado o rechazado.
Es necesario retornar un HTTP Status 200 (OK) o 201 (Created), de lo contrario MercadoPago seguirá reintentando notificar el cambio con su política de reintentos hasta 4 días después del primer intento mediante una cola de notificaciones.
Las notificaciones también se pueden configurar de manera global en el panel de desarrolladores, tanto para modo Sandbox como Producción.
Link: https://www.mercadopago.com.co/developers/es/guides/notifications/webhooks
Back Urls
Reflejan los estados finales de una transacción, las urls a la que serán redireccionados nuestros usuarios:
success: Pagos éxitosos.failure: Pagos rechazados.pending: Pagos en estado pendiente.
auto_return: Parámetro por el cual se puede habilitar el retorno automático según el estado de la transacción.
Devoluciones
Se permite realizar devoluciones parciales (en el caso de ingresar un monto menor al total del pago) o totales independientemente del medio de pago.
Link: https://www.mercadopago.com.co/developers/es/guides/manage-account/account/cancellations-and-refunds
Medios de Pago
Es posible establecer medios de pago no soportados dependiendo del país, además de obtener la información de montos mínimos y máximos soportados por cada medio de pago.
Link: https://www.mercadopago.com.co/developers/es/guides/resources/localization/payment-methods
Impuestos
Existen consideraciones de impuestos diferentes por país, estos son establecidos en el momento de crear la preferencia de pago. MercadoPago es un agente de retención y por defecto aplica retención sobre el 19% de la base del monto total de la preferencia generada a menos que se indique lo contrario en la creación de la preferencia.
Ivas en Colombia:
- 0%
- 5%
- 15%
- 19% (Defecto)
Link: https://www.mercadopago.com.co/developers/es/guides/resources/localization/iva-colombia
Testing
- Integración QR - Postman API Collection
- Checkout Pro
- Checkout API
- Mobile Checkout
- sandbox_init_point: Url usada para emular un flujo de pago por medio de una redirección de nuestros usuarios con tarjetas de prueba.
Installation 📚
# install dependencies
$ yarn
Running the app ▶
# development
$ yarn start
# watch mode
$ yarn start:dev
# production mode
$ yarn start:prod
Running migrations ▶
# run migration
$ yarn migration
# create migration
$ yarn migration:create
# revert migration
$ yarn migration:revert
Test 🕵️
# unit tests
$ yarn test
# e2e tests
$ yarn test:e2e
# test coverage
$ yarn test:cov
Credits 👍
- typescript-starter: Nest framework TypeScript starter repository.
- Mercado Pago SDK for NodeJS
Supporting 🍻
I believe in Unicorns 🦄 Support me, if you do too.
Donate Ethereum, ADA, BNB, SHIBA, USDT, DOGE:
Wallet address: 0x3F9fA8021B43ACe578C2352861Cf335449F33427
Please let us know your contributions! 🙏
Happy coding 💯
Made with ❤️
<img width="150px" src="https://avatars0.githubusercontent.com/u/28855608?s=200&v=4" align="right">