Bem-vindo à documentação Pagar.me

Aqui você vai encontrar guias e exemplos para te ajudar
a integrar com a melhor API de Pagamentos do Brasil!

Começar

Você também pode buscar ou navegar pelas categorias

A VTEX é uma plataforma de e-commerce na nuvem, ou seja, não demanda criação de ambientes ou qualquer infraestrutura.

É considerada a melhor plataforma de e-commerce da América Latina e uma das melhores do mundo, VTEX Cloud commerce! Possui atuação no mercado global e conta com clientes como Walmart, Whirlpool, Lego, Disney, L'oreal, Sony, Coca-Cola, Staples, O Boticário, Nespresso, Ambev, Tramontina, Bosch entre outras 2.500 lojas espalhadas por mais de 25 países.

A VTEX oferece mais de 70 microserviços e diversas funcionalidades para incrementar ainda mais as funcionalidades do seu e-commerce, como Marketplace, B2B, B2C, Logística e Entrega, Teste A/B, Analytics, ERP, Smartcheckout, CMS e SEO avançado, Ferramentas de Merchandising, tudo isso em um ambiente totalmente seguro e com certificado PCI DSS.

O principal diferencial do app da Pagar.me no VTEX é a facilidade de integração. O processo é o mais rápido e simples possível, além de ter sido pensado para agilizar sua operação.

Funcionalidades do App

  • Pagamento com Boleto;¹
  • Pagamento com Cartão de Crédito;
  • PrivateLabels;²
  • Pagamento com Cartão de Débito (sem 3DS);
  • Safetypay;
  • Voucher;³
  • Permite uso de Boleto registrado;
  • Permite integração com Antifraude;
  • Utiliza o seu checkout da VTEX, sem necessidade de redirecionamentos;
  • Cancelamento integral,exclusivamente, pelo painel da Vtex;
  • Captura integral, exclusivamente, pelo painel da Vtex.

📘

Pagamento com boleto

Sempre que um método de pagamento enviado pela Vtex não for aceito pelo conector, um boleto sera gerado. O que significa, que se você tiver a demanda de utilizar um cartão próprio da sua loja, é necessário solicitar que isso seja implementado pelo time técnico do Pagar.me.

📘

Utilização de Private Labels

Caso você deseje utilizar algum cartão private label, é necessário solicitar que a Pagar.me libere esse cartão tanto no app quanto na API. Entrar em contato com o time de [email protected]

📘

Utilização de vouchers

Pagamento com método de pagamento voucher, precisa ser feito por meio de um cartão de loja criado em seu ambiente Vtex, como no link, com o nome "Voucher" e a tratativa será realizada pelo lado da Pagar.me. Um detalhe importante é que para a Vtex e em seu admin, a transação constará como cartão de crédito.

📘

Utilização de Multilojas

No caso do uso de multilojas, é necessário ter uma conta no Pagar.me para cada loja na Vtex, assim como para cada loja Vtex ter sua afiliação de gateway vinculada a um app. No caso da mesma loja utilizar afiliações de gateway diferentes apontando para o Pagar.me, é necessário ter uma loja no Pagar.me para cada afiliação de gateway utilizada na loja Vtex

Configurando o HUB

O HUB é a nossa central de aplicativos e é nele que todos os detalhes dos seus aplicativos serão configurados.

Durante a instalação serão solicitadas algumas informações adicionais para configurar a sua integração. Você pode editar essas informações posteriormente por aqui mesmo.

  • Nome da Conta na VTEX: Nome da sua conta na VTEX, conforme explicado no passo 1;
  • VTEX App Key: Access Key / App Key gerado no painel da VTEX, conforme explicado no passo 1;
  • VTEX App Token: Secret Key / App Token gerado no painel da VTEX, conforme explicado no passo 1;
  • Dias para adicionar no vencimento do boleto: Caso habilitado o boleto, aqui é possível quantos dias será adicionado ao dia da compra para a geração da data de vencimento;
  • Instruções para o Boleto: Instruções para o boleto, texto adicional que irá aparecer no boleto, quando usado;
  • Utilizar número do pedido como número do documento no boleto: Utiliza o número do pedido como número do documento no boleto emitido;
  • Utilizar número do pedido como nosso número: Utiliza o número do pedido como nosso número;
    Inverter TID/NSU/Code: No retorno para a Vtex, utilizaremos a informação de NSU como TID, e código de retorno como NSU e Code.
  • Utilizar ID da sessão: quando recebido da vtex, enviar o ID da sessão, informações de fingerprint, para que chegue no antifraude;
  • Habilitar Antifraude: Informa se pagamentos devem ser enviados ao antifraude via Pagar.me ou Vtex, caso nenhuma das caixas esteja habilita entenderemos que você não utilizará esta funcionalidade. Mesmo com essa opção habilitada é necessário verificar se o antifraude está habilitado na sua conta do Pagar.me;
  • Valor mínimo para enviar para o antifraude: Informa o valor mínimo de um pagamento que deve ser enviado ao antifraude, informe somente o valor inteiro, sem centavos;
  • Segundos para auto captura após antifraude pela Vtex: Quantidade de segundos para que a Vtex solicite a captura da cobrança no Pagar.me após a análise do antifraude via Vtex;
  • Dias para o auto cancelamento de pagamento com boleto pela Vtex: A Vtex como default possui um tempo de expiração de pedido, que não é configurável. Neste campo você pode escolher com quantos dias você deseja cancelar seus pedidos automáticamente, assim como desabilitar o cancelamento automático para boletos pendentes (evitando problemas com conciliação tardia);
  • Dias para o auto cancelamento de pagamento com cartão de crédito pela Vtex: A Vtex como default possui um tempo de expiração de pedido, que não é configurável. Neste campo você pode escolher com quantos dias você deseja cancelar seus pedidos automáticamente, assim como desabilitar o cancelamento automático para pagamentos de cartão de crédito pendentes (evitando problemas com captura tardia com o uso de anti fraude).
  • Segundos para auto captura: Quantidade de segundos para que a Vtex solicite a captura da cobrança no Pagar.me;

Configurações do app

Passo 1
Obtenha as suas chaves de acesso da VTEX (AppKey e AppToken) e o nome da sua conta..

Para saber mais sobre como obter esses dados acesse:

http://help.vtex.com/pt/tutorial/criar-appkey-e-apptoken-para-autenticar-integracoes
http://help.vtex.com/pt/tutorial/o-que-e-account-name
Obs.: é importante não esquecer de cadastrar um perfil de acesso para sua AppKey em seus usuários. Recomendamos liberar os perfis:

(Owner) Super Admin
Passo a passo disponível no link: https://help.vtex.com/pt/tutorial/gerenciando-usuarios/

Passo 2
Após obter as informações no passo anterior, instale o App da Vtex pelo Hub.

Para ver mais sobre os dados adicionais solicitados durante a instalação, veja a seção dados adicionais da integração .

Passo 3
Você precisa configurar os seus pagamentos utilizando o nosso provedor de pagamentos. Veja no link abaixo como configurar pagamentos na plataforma da VTEX:

http://help.vtex.com/pt/tutorial/condicoes-de-pagamento

Passo 3.1
Você deve seguir o caminho Pagamentos > Configurações > Afiliações de gateways:

Clique no botão assinalado abaixo para adicionar o conector da Pagar.me em sua loja.

Passo 3.2
Após clicar no botão você deverá escolher o conector da Pagar.me como na imagem abaixo:

Passo 3.3
Após isso, você poderá personalizar o nome de sua afiliação, no exemplo abaixo colocamos como Integração API Pagar.me.

Além do nome, você deverá inserir os mesmos dados explicados no passo 1 nos campos mostrados:

Configurações do checkout

Após isso você deverá acessar o espaço Condições de Pagamento e selecionar a bandeira do cartão ou a solução de boleto que você deseja que seja processado pelo Pagar.me, e escolher nosso conector como afiliação:

Lembrando que você deverá fazer isso para todas as bandeiras que serão ativas e boleto bancário separadamente.

📘

Para o funcionamento da integração, não é necessário copiar o Id ou o Token da instalação para nenhum lugar.

Conheça nosso app

Para saber mais sobre nosso módulo e a facilidade que ele traz para que você consiga transacionar o mais rápido possível em sua loja, acesso nossa página no Hub:

Como deixamos nossos módulos abertos e não cobramos pela utilização do próprio. Nosso app é encontrado como app free.

Precisa de uma ajuda?

Você pode entrar em contato com o nosso suporte pelo e-mail [email protected]

Nosso time ficará feliz em te ajudar com a instalação deste app.

Updated about a month ago


Vtex


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.