Configurar terminal
Para continuar com a integração do Mercado Pago Point ao seu sistema, após criar a sua aplicação e obter as credenciais adequadas, é necessário que você configure seu terminal Point para operar em modo integrado.
É essa configuração que garante que os pagamentos realizados nos terminals possam ser gerenciados a partir de seu sistema, otimizando a eficiência na conciliação e na gestão de tarefas.
Para realizar a configuração do seu terminal Point em modo integrado, primeiro você deverá criar e configurar uma loja e um caixa, e depois associar esse terminal à loja e caixa criados. Isso permite que cada leitor esteja vinculado não apenas a uma conta do Mercado Pago, mas também a um ponto de venda físico identificado em nosso sistema.
Por último, com seu terminal já vinculado, você deverá ativar seu modo de operação como Ponto de Venda (PDV). Siga as instruções abaixo para realizar corretamente cada passo.
A criação de lojas e caixas no Mercado Pago é necessária para poder operar em lojas físicas com terminals Point e assim poder manter a conciliação entre seu ponto de venda e o Mercado Pago.
Uma loja representa uma loja física dentro do Mercado Pago, que pode ter um ou mais caixas vinculados. No entanto, cada caixa permite apenas um terminal associado em modo PDV. Isso significa que, se você está querendo integrar mais de um terminal, deverá criar a mesma quantidade de caixas e realizar sua associação de maneira individual.
A criação e a configuração de lojas e caixas podem ser realizadas por duas vias: a partir do painel do Mercado Pago ou via API. Esta última opção é útil para sistemas que requeiram operar com vários pontos de venda, já que permite associar várias lojas a partir do sistema integrador.
Escolha a via que melhor se adeque às suas necessidades e siga os passos detalhados conforme o caso.
É possível criar lojas e caixas a partir do seu sistema através de nossas APIs para pagamentos presenciais. Para isso, siga os passos abaixo.
Criar loja
Para criar uma loja via API, envie um POST com o Access Token que corresponda ao seu tipo de integração (própriaIntegrações de Mercado Pago Point ao seu sistema para uso próprio e configuradas a partir de credenciais de produção da sua aplicação. Para mais informações, acesse o link abaixo.Acessar as credenciais ou para terceirosIntegrações de Mercado Pago Point ao seu sistema em nome de um vendedor e configuradas a partir de credenciais obtidas por meio do protocolo de segurança OAuth. Para mais informações, acesse o link abaixo.Acessar as credenciais) ao endpoint Criar lojaAPI. Você deverá adicionar o user_id da conta do Mercado Pago que receberá o dinheiro das transações no path da sua solicitação e completar os parâmetros requeridos com os detalhes do negócio conforme se indica a seguir.
curl
curl -X POST \ 'https://api.mercadopago.com/users/USER_ID/stores'\ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -d '{ "name": "Loja Instore", "business_hours": { "monday": [ { "open": "08:00", "close": "12:00" } ], "tuesday": [ { "open": "09:00", "close": "18:00" } ] }, "external_id": "LOJ001", "location": { "street_number": "0123", "street_name": "Nome da Rua de Exemplo.", "city_name": "Nome da cidade.", "state_name": "Nome do estado.", "latitude": 27.175193925922862, "longitude": 78.04213533235064, "reference": "Próximo ao Mercado Pago" } }'
| Parâmetro | Obrigatoriedade | Descrição e exemplos |
user_id | Obrigatório | Identificador da conta do Mercado Pago que recebe o dinheiro pelas vendas realizadas na loja. Se você está realizando uma integração própriaIntegrações de Mercado Pago Point ao seu sistema para uso próprio e configuradas a partir de credenciais de produção da sua aplicação. Para mais informações, acesse o link abaixo.Acessar as credenciais, encontrará este valor nos Detalhes da aplicação. Se, ao contrário, está realizando uma integração para para terceirosIntegrações de Mercado Pago Point ao seu sistema em nome de um vendedor e configuradas a partir de credenciais obtidas por meio do protocolo de segurança OAuth. Para mais informações, acesse o link abaixo.Acessar as credenciais, obterá o valor na resposta à vinculação por meio de OAuthChave privada gerada mediante o protocolo de segurança OAuth, que permite gerenciar integrações em nome de terceiros. Para mais informações, dirija-se à documentação.OAuth. |
name | Obrigatório | Nome da loja criada. |
external_id | Opcional | Identificador externo da loja para o sistema do integrador. Pode conter qualquer valor alfanumérico de até 60 caracteres, e deve ser único para cada loja. Por exemplo, LOJMercadoPago. |
location | Obrigatório | Este objeto deve conter todas as informações da localização da loja. É importante preencher tudo corretamente, especialmente latitude e longitude, usando o formato decimal simples e os dados reais do local. Por exemplo, "latitude": 27.175193925922862, e "longitude": 78.04213533235064 correspondem à localização exata do Taj Mahal, na Índia. |
Se a solicitação foi enviada corretamente, a resposta será como o exemplo a seguir.
json
{ "id": 1234567, "name": "Loja Instore", "date_created": "2019-08-08T19:29:45.019Z", "business_hours": { "monday": [ { "open": "08:00", "close": "12:00" } ], "tuesday": [ { "open": "09:00", "close": "18:00" } ] }, "location": { "address_line": "Nome da Rua de Exemplo, 0123, Nome da cidade, Nome do estado.", "latitude": 27.175193925922862, "longitude": 78.04213533235064, "reference": "Próximo ao Mercado Pago" }, "external_id": "LOJ001" }
Além dos dados enviados na solicitação, retornará o identificador atribuído a essa loja pelo Mercado Pago sob o parâmetro id.
Criar caixa
Para poder realizar vendas com o Mercado Pago, cada loja criada deverá conter pelo menos um caixa associado. É possível criar um caixa e associá-lo à loja previamente criada enviando um POST com o Access Token que corresponda ao seu tipo de integração (própriaIntegrações de Mercado Pago Point ao seu sistema para uso próprio e configuradas a partir de credenciais de produção da sua aplicação. Para mais informações, acesse o link abaixo.Acessar as credenciais ou para terceirosIntegrações de Mercado Pago Point ao seu sistema em nome de um vendedor e configuradas a partir de credenciais obtidas por meio do protocolo de segurança OAuth. Para mais informações, acesse o link abaixo.Acessar as credenciais) ao endpoint Criar caixaAPI como mostrado a seguir.
curl
curl -X POST \ 'https://api.mercadopago.com/pos'\ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -d '{ "name": "Primeiro POS", "store_id": 1234567, "external_store_id": "LOJ001", "external_id": "LOJ001POS001", "category": 621102 }'
| Parâmetro | Obrigatoriedade | Descrição e exemplos |
name | Obrigatório | Nome do caixa criado. |
store_id | Obrigatório | Identificador da loja à qual pertence o caixa, atribuído a essa loja pelo Mercado Pago. É retornado na resposta à criação da loja sob o parâmetro id. |
external_store_id | Opcional | Identificador externo da loja, que foi atribuído pelo sistema do integrador no momento de sua criação sob o parâmetro external_id. |
external_id | Obrigatório | Identificador externo do caixa, definido para o sistema integrador. Deve ser um valor único para cada caixa e tem um limite de 40 caracteres. |
category | Obrigatório | Código MCC que indica o ramo ao qual pertence o ponto de venda. Você pode consultar a lista completa de opções em nossa Referência de API. |
Se a solicitação foi enviada corretamente, a resposta será como o exemplo a seguir.
json
{ "id": 2711382, "qr": { "image": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", "template_document": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf", "template_image": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png" }, "status": "active", "date_created": "2019-08-22T14:11:12.000Z", "date_last_updated": "2019-08-25T15:16:12.000Z", "uuid": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1", "user_id": 446566691, "name": "Primeiro POS", "fixed_amount": false, "category": 621102, "store_id": 1234567, "external_store_id": "LOJ001", "external_id": "LOJ001POS001" }
Você pode ver na tabela abaixo a descrição de alguns dos parâmetros retornados que podem ser úteis para continuar com sua integração mais adiante.
| Parâmetro | Descrição |
id | Identificador atribuído ao caixa pelo Mercado Pago. |
qr | Objeto que conterá um código QR associado ao caixa criado. Só poderá ser utilizado caso tenha integrada a solução de pagamento Código QR. |
status | Status no qual se encontra a criação do ponto de venda. |
user_id | Identificador da conta do Mercado Pago que recebe o dinheiro pelas vendas realizadas no caixa. |
name | Nome atribuído ao caixa no momento de sua criação. |
store_id | Identificador da loja à qual pertence o caixa, atribuído a essa loja pelo Mercado Pago. É retornado na resposta à criação da loja sob o parâmetro id. |
external_store_id | Identificador externo da loja, que foi atribuído pelo sistema do integrador no momento de sua criação sob o parâmetro external_id. |
external_id | Identificador externo do caixa, definido para o sistema integrador no momento de sua criação. |
Se ambas as solicitações foram bem-sucedidas, você terá criado e configurado a loja e o caixa necessários para continuar com a configuração do seu terminal em modo PDV.
A associação do terminal Point à conta do Mercado Pago e à loja e caixa criados deve ser realizada a partir da aplicação do Mercado Pago no dispositivo móvel da conta recebedora ou daquela indicada como colaboradora. Esta aplicação está disponível para dispositivos Android ou iOS.
Comece ligando o terminal Point. Você verá na tela a mensagem "Inicie sessão neste dispositivo com sua conta do Mercado Pago". Ali você deverá escolher entre as opções abaixo.
- Sou responsável pelo negócio: selecione esta opção se você é o dono da loja física.
- Sou um colaborador: escolha esta opção se sua conta foi indicada como conta de colaborador pelo proprietário da loja.
Uma vez selecionada a opção que corresponda, aparecerá um código QR na tela do terminal que você deverá escanear com a aplicação móvel do Mercado Pago.
Para isso, acesse a aplicação e inicie sessão com a conta recebedora ou aquela indicada como conta de colaborador, conforme o caso. Em seguida, pressione o ícone QR na margem inferior e escaneie o código apresentado pelo terminal.
Após alguns segundos, o terminal poderá solicitar algumas configurações adicionais para a loja. Siga as instruções exibidas na tela para concluir todas as etapas.
Por último, o terminal solicitará que você selecione a loja e o caixa aos quais quer associá-lo, e confirme o endereço da loja previamente criada com sua conta do Mercado Pago. Ao finalizar, pressione o botão Confirmar.
Por último, o terminal solicitará que você insira uma senha que garantirá seu uso seguro.
Uma vez finalizado este processo, a tela exibirá a mensagem "Pronto! Já pode cobrar com seu Point", e você terá finalizado a associação do seu terminal à conta do Mercado Pago desejada, e à loja e caixa criados.
Como último passo da configuração de terminals, e para que estes possam estar integrados com nossa API, é necessário ativar o modo de operação como Ponto de Venda (PDV).
Para ativar o modo PDV via API pela primeira vez, é necessário consultar os terminals disponíveis vinculados à sua conta. Para isso, envie um GET ao endpoint Obter terminalsAPI, utilizando um Access Token compatível com o tipo de integração (própriaIntegrações de Mercado Pago Point ao seu sistema para uso próprio e configuradas a partir de credenciais de produção da sua aplicação. Para mais informações, acesse o link abaixo.Acessar as credenciais ou para para terceirosIntegrações de Mercado Pago Point ao seu sistema em nome de um vendedor e configuradas a partir de credenciais obtidas por meio do protocolo de segurança OAuth. Para mais informações, acesse o link abaixo.Acessar as credenciais). Recomendamos o uso opcional dos parâmetros store_id e pos_id para filtrar os resultados - esses identificadores são retornados na criação da loja e do caixa, respectivamente.
curl
curl -X GET \ 'https://api.mercadopago.com/terminals/v1/list?limit=50&offset=1&store_id=1235456678&pos_id=1235456678'\ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \
Esta chamada retornará uma lista de terminals vinculados à conta do Mercado Pago, junto com seu respectivo caixa e loja associados, e seu modo de operação.
json
{ "data": { "terminals": [ { "id": "PAX_A910__SMARTPOS1234345545", "pos_id": 47792476, "store_id": "47792478", "external_pos_id": "LOJ0101POS", "operating_mode": "PDV | STANDALONE | UNDEFINED" } ] }, "paging": { "total": 1, "offset": 0, "limit": 50 } }
| Parâmetro | Descrição |
terminals.id | Identificador único do terminal. O formato no qual este campo é retornado é "tipo de terminal + "__" + serial do terminal". Por exemplo, "PAX_A910__SMARTPOS123456789". Você poderá identificar o Point que deseja por meio dos últimos caracteres deste campo, que deverão coincidir com o serial que aparece na etiqueta traseira do terminal físico. |
terminals.pos_id | Identificador do caixa ao qual está associado o terminal Point. |
terminals.store_id | Identificador da loja à qual está associado o terminal Point. |
terminals.operating_mode | Modo de operação no qual está funcionando o terminal no momento da consulta. Pode ser: - PDV: modo de operação como Ponto de Venda (PDV). É o modo no qual opera o terminal quando está integrado via API e só poderá receber pagamentos com cartões. - STANDALONE: configuração do terminal por padrão. É o modo no qual opera quando não está integrado via API. - UNDEFINED: a configuração que tem o terminal não é reconhecida. |
Como o único modo de operação que permite integrar os terminals via API é o PDV, uma vez que tenha localizado o terminal Point desejado, você deverá ativá-lo. Para isso, envie um PATCH com o Access Token que corresponda ao seu tipo de integração (própriaIntegrações de Mercado Pago Point ao seu sistema para uso próprio e configuradas a partir de credenciais de produção da sua aplicação. Para mais informações, acesse o link abaixo.Acessar as credenciais ou para terceirosIntegrações de Mercado Pago Point ao seu sistema em nome de um vendedor e configuradas a partir de credenciais obtidas por meio do protocolo de segurança OAuth. Para mais informações, acesse o link abaixo.Acessar as credenciais) ao endpoint Alterar o modo de operaçãoAPI, como mostrado a seguir.
curl
curl -X PATCH \ 'https://api.mercadopago.com/terminals/v1/setup'\ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -d '{ "terminals": [ { "id": "PAX_A910__SMARTPOS1234345545", "operating_mode": "PDV" } ] }'
| Campo | Tipo | Descrição |
terminals.id | String | Identificador único do terminal cujo modo de operação se quer modificar, obtido na solicitação para consultar os terminals disponíveis. Você deve enviá-lo seguindo o formato "tipo de terminal + "__" + serial do terminal", como no seguinte exemplo: "PAX_A910__SMARTPOS123456789". |
terminals.operating_mode | String | Modo operativo no qual você quer configurar o terminal. Para integrar seu terminal via API, o valor deve ser PDV, que corresponde ao modo de operação com Ponto de Venda. |
Se a solicitação foi bem-sucedida, a resposta deverá retornar o parâmetro operating_mode=PDV.
json
{ "terminals": [ { "id": "PAX_A910__SMARTPOS1234345545", "operating_mode": ""PDV" } ] }
Para finalizar a configuração do seu terminal, você deverá reiniciá-lo e, em seguida, verificar se foi exitosa dirigindo-se a Mais opções > Configurações > Modo de vinculação. Se encontrar que o modo de vinculação é Ponto de Venda (PDV), a mudança no modo de operação foi efetiva e você poderá continuar integrando o processamento de pagamentos.