Mercado Pago
Esta documentação descreve a integração do e-SiTef com a plataforma de pagamento Mercado Pago. Além de explicar sobre as configurações que devem ser, necessariamente, efetuadas no ambiente do e-SiTef.
Interfaces e-SiTef suportadas para integração
É possível utilizar as seguintes interfaces para a integração com o roteamento Mercado Pago:
Credenciais necessárias
A loja deve obter no portal do Mercado Pago as credenciais listadas abaixo, e repassá-las à Software Express ou fazer o cadastro no Portal do Lojista do e-SiTef.
Parâmetro | Descrição | Obrigatório |
---|---|---|
public_key | Chave pública da aplicação para saber, por exemplo, os meios de pagamento e criptografar os dados do cartão. | SIM |
access_token | Chave privada da aplicação para gerar pagamentos. | SIM |
Códigos de autorizadora
Abaixo estão os códigos a serem utilizados nessa integração:
440
: PIX402
: demais formas de pagamento com Mercado Pago
Atenção: No ambiente de homologação do Mercado Pago não é possível simular uma transação PIX aprovada. A transação ficará pendente.
Parâmetros específicos do Mercado Pago
Serviço de criação de pagamento HTML
Abaixo estão os parâmetros de requisição específicos do Mercado Pago para o serviço de criação de pagamento HTML:
Parâmetro | Descrição | Tamanho | Obrigatório |
---|---|---|---|
additional_data | Dados adicionais da transação. | ||
application_fee | Valor de comissão do Mercado Pago em centavos | < 12 N | NÃO |
binary_mode | Modo binário de aprovação. Quando definido como true , o pagamento só pode ser aprovado ou negado (não fica pendente). | < 5 AN | NÃO |
discount_campaign_id | Identificador da campanha de desconto | < 1024 AN | NÃO |
discount_amount | Valor do cupom de desconto em centavos | < 12 N | NÃO |
acquirer_expiry_date | Data de expiração do pagamento no formato AAAA-MM-DDTHH:MM:SS | = 19 AN | NÃO |
acquirer_expiry_date_from | Data a partir da qual a iniciação do pagamento estará ativa no formato AAAA-MM-DDTHH:MM:SS | = 19 AN | NÃO |
acquirer_expiry_date_to | Data de expiração da iniciação do pagamento no formato AAAA-MM-DDTHH:MM:SS | = 19 AN | NÃO |
acquirer_expires | Booleano que indica se a iniciação do pagamento expira. | < 5 AN | NÃO |
description | Razão de pagamento ou título do item | < 1024 AN | NÃO |
extra_info | Informações adicionais. | < 1024 AN | NÃO |
max_installments | Número máximo de parcelas. | < 2 N | NÃO |
additional_data .items[] | Dados de carrinho de compras. Obrigatório o envio de pelo menos um item, e a soma dos preços do carrinho deve ser igual ao valor total da transação (campo amount , na raiz do JSON). | ||
id | ID do produto. | < 1024 AN | NÃO |
title | Nome do item. | < 1024 AN | NÃO |
description | Descrição do item. | < 1024 AN | NÃO |
picture_url | URL da imagem do item. | < 1024 AN | NÃO |
category_id | Categoria do item: art , baby , coupon , donation , computing , camera , video_game , television , car_eletronic , automotive , entertainment , fashion , game , home , musical , phone , service , learning , ticket , travel , virtual_good ou other | < 1024 AN | NÃO |
quantity | Quantidade do item. | < 7 N | SIM |
unit_price | Preço unitário do item em centavos. | < 12 N | SIM |
additional_data .payer | Dados do comprador. | ||
name | Nome do comprador. | < 1024 AN | NÃO |
surname | Sobrenome do comprador. | < 1024 AN | NÃO |
email | E-mail do comprador. | < 1024 AN | NÃO |
creation_date | Data da criação da conta no formato DD/MM/AAAA | = 10 AN | NÃO |
identification_type | Tipo de identificação do comprador. | < 1024 AN | NÃO |
identification_number | Número de identificação do comprador. | < 1024 AN | NÃO |
type | Tipo de identificação do pagador associado: guest , customer ou registered | < 10 AN | NÃO |
additional_data .payer .phones[] | Telefone do comprador. | ||
ddd | Código da área do telefone. | < 1024 AN | NÃO |
number | Número do telefone do comprador. | < 1024 AN | NÃO |
additional_data .payer .address | Endereço do comprador. | ||
street_name | Endereço do comprador. | < 1024 AN | NÃO |
street_number | Número do endereço do comprador. | < 1024 AN | NÃO |
zip_code | CEP do comprador. | < 1024 AN | NÃO |
additional_data .shipment | Endereço de entrega. | ||
mode | Modo de envio:
| < 1024 AN | NÃO |
local_pickup | Preferência de remoção de pacotes em agência (booleano). Apenas para mode = me2 . | < 5 AN | NÃO |
dimensions | Tamanho do pacote em cm x cm x cm, gr. Apenas para mode = me2 . | < 1024 AN | NÃO |
default_shipping_method | Escolha um método de envio padrão no checkout. Apenas para mode = me2 . | < 1024 AN | NÃO |
cost | Custo do transporte em centavos. Apenas para mode = custom . | < 12 N | NÃO |
free_shipment | Preferência de frete grátis (booleano). Apenas para mode = custom . | < 5 AN | NÃO |
additional_data .shipment .free_methods[] | Oferecer um método de frete grátis. Apenas para mode = me2 . | ||
id | Identificador do método de envio | < 1024 AN | NÃO |
additional_data .shipment .address | Endereço de entrega. | ||
zip_code | CEP do endereço de entrega. | < 1024 AN | NÃO |
street_number | Número do endereço de entrega. | < 1024 AN | NÃO |
street_name | Nome da rua de entrega. | < 1024 AN | NÃO |
floor | Número do andar de entrega. | < 1024 AN | NÃO |
apartment | Número do apartamento de entrega. | < 1024 AN | NÃO |
city | cidade de entrega. | < 1024 AN | NÃO |
state | Estado de entrega. | < 1024 AN | NÃO |
additional_data .payment_method .excluded_payment_methods[] | Métodos de pagamento a serem excluídos do fluxo de pagamento Mercado Pago. | ||
id | ID do método de pagamento a ser excluído:
| < 1024 AN | NÃO |
additional_data .payment_method .excluded_payment_types[] | Tipos de pagamento a serem excluídos do fluxo de pagamento Mercado Pago. | ||
id | ID do tipo de pagamento a ser excluído: debit_card , credit_card ou ticket . | < 1024 AN | NÃO |
additional_data .payment_method .ad_tracks[] | Tracks que serão executados durante a interação do usuário no fluxo de Pagamento. | ||
type | Tipo da track:
| < 1024 AN | NÃO |
conversion_id | Conversion ID da track. | < 1024 AN | NÃO |
conversion_label | Conversion Label da track. | < 1024 AN | NÃO |
pixel_id | Pixel ID da track. | < 1024 AN | NÃO |
Exemplo de JSON:
{
"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"
}
]
}
}