Mercado Pago

This documentation describes the integration with Mercado Pago payment platform and also explains about the settings that must be made at the e-SiTef environment.

e-SiTef supported Interfaces for integration

It is possible to use the following interfaces for integration with Mercado Pago routing:

• HTML Payment

Required credentials

The merchant must get at the e-SiTef-Portal the credentials listed below, and pass them on to Software Express or register on the e-SiTef-Portal.

Parameter	Description	Required
public_key	The application's public key to know, for example, the means of payment and to encrypt card data.	YES
access_token	Application private key to generate payments.	YES

Authorizer codes

Below are the codes to be used in this integration:

• 440: PIX
• 402: other forms of payment with Mercado Pago

Attention: In Mercado Pago's approval environment, it is not possible to simulate an approved PIX transaction. The transaction will be pending.

Mercado Pago specific parameters

HTML payment creation service

Below are the Mercado Pago-specific requisition parameters for the HTML payment creation service:

Parameter	Description	Size	Required
additional_data	Additional transaction data.
application_fee	Mercado Pago commission amount in cents	< 12 N	NO
binary_mode	Binary approval mode. When set to true, payment can only be approved or denied (not pending).	< 5 AN	NO
discount_campaign_id	Discount campaign identifier	< 1024 AN	NO
discount_amount	Discount coupon amount in cents	< 12 N	NO
acquirer_expiry_date	Payment expiration date in format AAAA-MM-DDTHH:MM:SS	= 19 AN	NO
acquirer_expiry_date_from	Date from which payment initiation will be active in the format AAAA-MM-DDTHH:MM:SS	= 19 AN	NO
acquirer_expiry_date_to	Payment initiation expiration date in the format AAAA-MM-DDTHH:MM:SS	= 19 AN	NO
acquirer_expires	Boolean indicating if payment initiation expires.	< 5 AN	NO
description	Payment reason or item title	< 1024 AN	NO
extra_info	Additional Information	< 1024 AN	NO
max_installments	Maximum installments number	< 2 N	NO
additional_data .items[]	Shopping cart data. It is required to send at least one item, and the sum of the cart prices must be equal to the total transaction amount (amount field, in the JSON root).
id	Product ID	< 1024 AN	NO
title	Item name	< 1024 AN	NO
description	Item Description	< 1024 AN	NO
picture_url	Item Image URL	< 1024 AN	NO
category_id	Item category: art, baby, coupon, donation, computing, camera, video_game, television, car_eletronic, automotive, entertainment, fashion, game, home, musical, phone, service, learning, ticket, travel, virtual_good or other	< 1024 AN	NO
quantity	Item quantity	< 7 N	SIM
unit_price	Item unit price in cents	< 12 N	SIM
additional_data .payer	Customer Data
name	Customer's name	< 1024 AN	NO
surname	Customer's surname	< 1024 AN	NO
email	Customer's email.	< 1024 AN	NO
creation_date	Date of account creation in the format DD/MM/AAAA	= 10 AN	NO
identification_type	Customer identification type	< 1024 AN	NO
identification_number	Customer identification number	< 1024 AN	NO
type	Type of identification of the associated payer: guest, customer ou registered	< 10 AN	NO
additional_data .payer .phones[]	Customer's phone
ddd	Phone area code	< 1024 AN	NO
number	Customer's phone number	< 1024 AN	NO
additional_data .payer .address	Customer's address
street_name	Customer's address	< 1024 AN	NO
street_number	Customer's address number	< 1024 AN	NO
zip_code	Customer's zip code	< 1024 AN	NO
additional_data .shipment	Delivery address
mode	Shipping Mode: custom = Customized me2 = Market shipping not_specified = Not specified	< 1024 AN	NO
local_pickup	Preference for removing packages in agency (boolean). Just for mode = me2.	< 5 AN	NO
dimensions	Package size in cm x cm x cm, gr. Just for mode = me2.	< 1024 AN	NO
default_shipping_method	Choose a standard shipping method at checkout. Just for mode = me2.	< 1024 AN	NO
cost	Cost of transportation in cents. Just for mode = custom.	< 12 N	NO
free_shipment	Free shipping preference (boolean). Just for mode = custom.	< 5 AN	NO
additional_data .shipment .free_methods[]	Offer a free shipping method. Just for mode = me2.
id	Shipping method identifier	< 1024 AN	NO
additional_data .shipment .address	Delivery address
zip_code	Delivery address zip code	< 1024 AN	NO
street_number	Delivery address number	< 1024 AN	NO
street_name	Delivery street name	< 1024 AN	NO
floor	Delivery floor number	< 1024 AN	NO
apartment	Delivery apartment number	< 1024 AN	NO
city	Delivery city	< 1024 AN	NO
state	Delivery state	< 1024 AN	NO
additional_data .payment_method .excluded_payment_methods[]	Payment methods to be excluded from the Mercado Pago payment flow
id	Payment method ID to be deleted: debelo = Elo Debit debmaster = Mastercard Debit visa = Visa master = Mastercard hipercard = Hipercard amex = American Express elo = Elo debvisa = Visa Debit pec = Payment in lottery without bank slip bolbradesco = payment slip	< 1024 AN	NO
additional_data .payment_method .excluded_payment_types[]	Payment types to be excluded from the Mercado Pago payment flow.
id	Payment type ID to be deleted: debit_card, credit_card ou ticket.	< 1024 AN	NO
additional_data .payment_method .ad_tracks[]	Tracks that will be executed during user interaction in the Payment flow.
type	Tipo da track: google_ad: Set up a Google Ads conversion tracking tag in GTM. Required values: conversion_id e conversion_label. facebook_ad: Allows you to set up a Facebook pixel. Required values: pixel_id.	< 1024 AN	NO
conversion_id	Track conversion ID	< 1024 AN	NO
conversion_label	Track Conversion Label	< 1024 AN	NO
pixel_id	Track pixel ID	< 1024 AN	NO

JSON example:

{
   "merchant_id":"LOJAMERCADOPAGO",
   "merchant_usn":"123456",
   "amount":"100",
   "soft_descriptor":"softDescriptor",
   "additional_data":{
      "extra_info":"extraInfo",
      "items":[
         {
            "title":"Camiseta",
            "quantity":"1",
            "unit_price":"100",
            "picture_url":"https://abc.def/item/552292339/zoom/10.jpg",
            "category_id":"fashion",
            "description":"Camiseta Preta",
            "id":"id"
         }
      ],
      "payer":{
         "name":"Jonas",
         "surname":"Melo",
         "email":"a@b.com",
         "date_created":"11/02/2015",
         "address":{
            "zip_code":"12345678",
            "street_number":"751",
            "street_name":"Rua Major Vitor"
         },
         "phones":[
            {
               "number":"912341234",
               "ddd":"11"
            }
         ],
         "identification_type":"CPF",
         "identification_number":"86670573049"
      },
      "payment_method":{
         "excluded_payment_methods":[
            {
               "id":"debelo"
            }
         ],
         "excluded_payment_types":[
            {
               "id":"debit_card"
            }
         ]
      },
      "shipment":{
         "mode":"not_specified",
         "local_pickup":"true",
         "dimensions":"23x23x23, 23g",
         "default_shipping_method":"45",
         "cost":"2",
         "free_shipment":"true",
         "address":{
            "zip_code":"87654321",
            "street_number":"920",
            "street_name":"Rua General Henrique",
            "floor":"1",
            "apartment":"23",
            "city":"São Mateus",
            "state":"AM"
         },
         "free_methods":[
            {
               "id":"621"
            }
         ]
      },
      "max_installments":"12",
      "application_fee":"1",
      "acquirer_expiry_date":"2021-06-02T11:05:27",
      "acquirer_expiry_date_from":"2021-06-01T11:05:27",
      "acquirer_expiry_date_to":"2021-06-03T11:05:27",
      "acquirer_expires":"false",
      "ad_tracks":[
         {
            "conversion_id":"conversionId",
            "type":"google_ad",
            "conversion_label":"conversionLabel"
         }
      ]
   }
}