Order (API integration)
If your current integration is through the API, Mercado Pago offers the possibility to integrate in-person payments through the Order API, designed to simplify the integration of Mercado Pago's payment products.
Prerequisites
To ensure a successful migration to the Order API, you must meet the following prerequisites:
| Prerequisite | Description |
| Mercado Pago seller account | To integrate with Mercado Pago, you need to have a seller account. If you don’t have one yet, visit the page to create it for free. |
| Application created in Your integrations | Applications are the different integrations contained in one or more stores. You can create an application for each solution you implement to keep everything organized and maintain control for easier management. Additionally, by creating an application, you will be able to obtain the necessary credentials to operate. Refer to the documentation of the Developer dashboard to create your application. |
| Credentials | Credentials are unique keys that are provided to you at the moment you create the application through Your integrations. You will need a set of production credentials to receive real payments. Access Credentials for more information. |
| Mercado Pago Point terminal | To integrate with Mercado Pago, you need to be provided with a Point terminal. To obtain it, contact your portfolio sales executive. |
| Mercado Pago application | In addition to the device, it is essential to have the Mercado Pago application to log in and manage the collections made. You can download it for both Android and iOS devices. |
Integration configuration
The Order API provides various endpoints that allow you to perform the same functionalities more efficiently:
Important
To use these endpoints, it is necessary for your terminal to be configured in
PDV mode. If it is set to STANDALONE mode, it will be understood that you want to process payments in a non-integrated manner, which will prevent the use of our API. To configure your terminal in POS mode, use the endpoint
Update terminal operation mode
, which allows you to change the operating mode of the terminals.- Get terminals: This endpoint allows you to obtain a list of the Point terminals associated with your Mercado Pago account. It will provide you with their respective ID and the operating mode in which they are functioning.
- Update terminal operation mode: If the terminal you are trying to integrate is in
STANDALONEoperational mode, you will need to update it to POS mode using this endpoint. This will allow you to operate in integrated mode with our API. - Create order: This endpoint allows you to create an order that contains payment transactions for Mercado Pago Point. You can associate it with the desired terminal using its ID.
- Get order by ID: This allows you to retrieve all the information about an order using the ID obtained in the response to its creation.
- Cancel order by ID: This allows you to cancel an order created for Mercado Pago Point using the reference ID obtained in the response to its creation.
- Refund order: This endpoint allows to create a refund for a payment transactions associated with an order for Mercado Pago Point.