Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/proyecto26/mercadopago-api
API for MercadoPago Checkout
https://github.com/proyecto26/mercadopago-api
api api-documentation api-rest api-service ecommerce mercadopago mercadopago-api
Last synced: 8 days ago
JSON representation
API for MercadoPago Checkout
- Host: GitHub
- URL: https://github.com/proyecto26/mercadopago-api
- Owner: proyecto26
- License: mit
- Created: 2021-05-08T06:07:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-16T23:13:09.000Z (about 2 years ago)
- Last Synced: 2024-10-29T22:37:27.547Z (17 days ago)
- Topics: api, api-documentation, api-rest, api-service, ecommerce, mercadopago, mercadopago-api
- Language: TypeScript
- Homepage: https://mercadopago-e-commerce.herokuapp.com/api
- Size: 24.9 MB
- Stars: 24
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
| | MercadoPago API Template |
| - | ------------ |
| ⚡️ | **Launch your api instantly** watching changes with live-reload |
| 📈 | **Highly scalable** using [Repository design pattern](https://docs.nestjs.com/techniques/database#repository-pattern) to access the database even easier |
| 😎 | **OpenAPI** with [Swagger](https://docs.nestjs.com/openapi/introduction) 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](https://docs.nestjs.com/techniques/authentication) and other techniques to increase the security of your applications |
| 👥 | **Made for Users.** Easily validate permissions for specific routes using [Guards](https://docs.nestjs.com/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](https://github.com/typestack/class-validator) to enforce validation rules for all incoming client payloads |
| ⚠️ | **Logger** with [Winston](https://github.com/winstonjs/winston) using different levels to track exceptions easily |
| 🔄 | **Migrations** using [TypeORM](https://github.com/typeorm/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](http://mercadopago.com/mco/account/webhooks), 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](https://documenter.getpostman.com/view/7908112/SVfNv9FJ?version=latest)
- [Checkout Pro](https://www.mercadopago.com.co/developers/es/guides/online-payments/checkout-pro/test-integration)
- [Checkout API](https://www.mercadopago.com.co/developers/es/guides/online-payments/checkout-api/testing)
- [Mobile Checkout](https://www.mercadopago.com.co/developers/es/guides/online-payments/mobile-checkout/testing)
- **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 📚
```bash
# install dependencies
$ yarn
```
## Running the app ▶
```bash
# development
$ yarn start
# watch mode
$ yarn start:dev
# production mode
$ yarn start:prod
```
## Running migrations ▶
```bash
# run migration
$ yarn migration
# create migration
$ yarn migration:create
# revert migration
$ yarn migration:revert
```
## Test 🕵️
```bash
# unit tests
$ yarn test
# e2e tests
$ yarn test:e2e
# test coverage
$ yarn test:cov
```
## Credits 👍
* **typescript-starter:** [Nest framework TypeScript starter repository](https://github.com/nestjs/typescript-starter).
* **[Mercado Pago SDK for NodeJS](https://mercadopago.github.io/sdk-nodejs)**
## Supporting 🍻
I believe in Unicorns 🦄
Support [me](http://www.paypal.me/jdnichollsc/2), if you do too.
Donate **Ethereum**, **ADA**, **BNB**, **SHIBA**, **USDT**, **DOGE**:
> Wallet address: 0x3F9fA8021B43ACe578C2352861Cf335449F33427
Please let us know your contributions! 🙏
## Happy coding 💯
Made with ❤️
