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:
- 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
STANDALONE
operational 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 payment transactions associated with an order for Mercado Pago Point.
Print configuration
The Printing API provides a practical solution for connecting your systems and managing the printing of invoices and receipts, as well as custom prints, on the Point terminals you have configured. With this API, it is possible to guarantee a unified and efficient payment experience.
This resource allows printing receipts, Documentos Tributarios Electrónicos (DTE) and custom prints directly from a point of sale (POS) through the API, using the integrated printer of Smart devices. This simplifies the payment process and quickly responds to the needs of your business.
Printing of invoices and electronic receipts
The following types of Documentos Tributarios Electrónicos (DTE) in XML format are accepted:
Document type | Description |
Affected Invoice (33) and Exempt (34) | Refers to the tax document that has legal validity before the Servicio de Impuestos Interno (SII). |
Affected Receipt (39) and Exempt (41) | Refers to the document that the customer receives when making a purchase, having accounting and tax validity. |
Custom tags
Custom tags allow for adjusting the presentation of printed documents. They offer flexibility and control over the text format, enabling the creation of efficient and visually appealing prints. Below, consult the different available tags, their functions, and usage examples:
Tag | Function | Example |
{b} | Bold | {b}Bold text{/b} |
{w} | Large text | {w}Large text{/w} |
{s} | Small text | {s}Small text{/s} |
{br} | Line break | {br} |
{left} | Align left | {left}Left-aligned text{/left} |
{center} | Center text | {center}Centered text{/center} |
{qr} | Print a QR code that represents the sent text | {qr}Text{/qr} |
{pdf417} | Print the barcode of a TED | {pdf417}Text{/pdf417} |
Print configuration
Use the API to manage the print queue, considering the specifications of each endpoint.
The available endpoints are:
- Create terminal action: This allows you to create a new terminal action for the Mercado Pago point.
- Get action by ID: This allows you to consult all action information using the ID obtained in the response to its creation.
- Cancel action by ID: This allows yoy to cancel an order created for Mercado Pago Point and its transactions using the reference ID obtained in the response to its creation. Only an action in status "created" can be canceled.
Wait until the printing intent reaches the terminal and the print is processed. If the print does not arrive automatically, press the Update button to fetch the intent manually.