Instalando o conector no Pagar.me

Instalação no Pagar.me

Para iniciar a instalação no Pagar.me é necessário acessar o aplicativo da VTEX no nosso HUB. Caso não esteja conectado na sua conta Pagar.me basta clicar no canto superior direito, e realizar o login com usuário e senha da dashboard.
Já no HUB para iniciar a instalação basta clicar no botão "Integrar com o Pagar.me"

Clique na caixa de seleção e selecione a loja que deseja realizar a instalação.

Uma vez selecionada a loja, as opções de configuração da loja ficam disponíveis. É importante se atentar que a informação de nome da conta é obrigatória.

Além do Nome da Conta, outros parâmetros podem ser configurados, relativos aos meios de pagamento, uso de antifraude, VTEX InStore e captura de pagamento. Segue abaixo uma breve explicação de cada um dos parâmetros a serem preenchidos:

ParâmetroDescrição
Nome da conta VTEXÉ o nome da sua conta dentro da VTEX. Caso tenha dúvida, a VTEX possui um tutorial explicando do que se trata, clique aqui.
Habilitar Vtex InStoreOpção para utilizar a funcionalidade omnichannel VTEX inStore do conector.
Serial Number do POSUma vez habilitado o inStore é necessário inserir o número serial do POS para quais os pedidos devem ser direcionados. Caso sejam utilizados múltiplos POS, esse campo deve ser deixado em branco.¹
Dias para adicionar no vencimento do boletoDefine a data de vencimento do boleto após a emissão em dias
Instruções para o boletoDefine as instruções que serão exibidas no boleto gerado pela Pagar.me.
Utilizar número do pedido como número do documento no boletoUtiliza o parâmetro CODE da VTEX no campo de documento.
Utilizar número do pedido como nosso número no boletoUtiliza o parâmetro CODE da VTEX no campo de número do boleto.
Inverter TID/NSU/Code (algumas integrações de terceiros na Vtex exigem isto)Inverte os valores enviados para a VTEX, enviando o TID no lugar do NSU e vice-versa. Essa funcionalidade é específica para algumas integrações de terceiros.
Utilizar ID da Sessão (fingerprint) quando recebido da Vtex
Eu uso antifraude via Pagar.meSelecionar caso utilize o antifraude na Pagar.me
Eu uso antifraude diretamente via VTEXSelecionar caso utilize o antifraude na VTEX
Valor mínimo para enviar para o antifraude (apenas via Pagar.me)Define o valor mínimo da transação para que o pedido seja enviado para análise do antifraude. Apenas para clientes gateway.
Descrição para Compras em PIXDescrição adicional que será apresentado no extrato de compras realizadas via PIX (ex: nome da franquia).
Este campo será apresentado na sessão de "Informações Adicionais" do PIX e terá o seguinte formato:
"Descrição da compra" : "[texto preenchido no campo do HUB]"
Ativar Margem de AutorizaçãoAtiva aplicação dos campos "Margem de Autorização em Percentual" e "Margem Máxima de Autorização"
Margem de Autorização em Percentual (%)Estabelece limite de autorização de valor superior ao valor do pedido, respeitando a margem percentual preenchida.
Ex:
Valor do pedido: R$100
Margem de Autorização Percentual: 50%
Autorização: R$150
Margem máxima de autorização (Valor em reais)Estabelece limite de autorização de valor superior ao valor do pedido, respeitando margem em reais. Se o campo "Margem de autorização percentual" não for preenchido, a Margem Máxima de Autorização não é aplicada.

Ex:
Valor do pedido: R$100
Margem de autorização percentual: 50%
Margem máxima de autorização: R$40
Autorização: R$140
Ex2:
Valor do pedido: R$100
Margem máxima de autorização: R$40
Autorização: R$100
Delay em segundos para a captura após o antifraude pela Vtex . (Use "0" para desabilitar)Define quantos segundos a plataforma deve aguardar para realizar a captura da transação após a análise do antifraude. Apenas para clientes que utilizam o antifraude na VTEX. Caso seja desabilitado, o valor será definido pelo padrão da VTEX.
Dias para o auto cancelamento de pagamento com boleto pela Vtex. (Use "0" para desabilitar)Define quantos dias a plataforma deve aguardar para realizar o cancelamento do pedido do boleto. Caso seja desabilitado, o valor será definido pelo padrão da VTEX.
Dias para o auto cancelamento de pagamento com cartão de crédito pela Vtex. (Use "0" para desabilitar)Define quantos dias a plataforma deve aguardar para realizar o cancelamento do pedido após falha na autorização. Mínimo 600. Caso seja desabilitado, o valor será definido pelo padrão da VTEX.
Softdescriptor (Texto exibido na fatura do cartão)Define o valor enviado no softdescriptor de transações em cartão. Valor máximo de 13 caracteres.
Delay em segundos para a captura. (Use "0" para desabilitar)Define quantos segundos a plataforma deve aguardar para realizar a captura da transação após a autorização bem sucedida. Caso seja desabilitado, o valor será definido pelo padrão da VTEX.

🚧

¹Serial Number do POS

A inserção do serial number na configuração do HUB, só é válida para casos de um único POS para aquela conta. Caso sejam utilizados múltiplos POS, esse campo deve ser deixado em branco.

Uma vez que as informações estiverem preenchidas da maneira que deseja, basta clicar em "Autorizar".

Instalação na VTEX

Para finalizar o processo de instalação é necessário acessar a área de administração dentro da sua loja da VTEX.

Na barra lateral selecione a opção de "Configurações da loja" > "Pagamentos" > "Provedores"

A página atualizará exibindo todas as opções de pagamento que estão configuradas na sua loja. Primeiro precisamos adicionar o Pagar.me como um provedor de pagamento. Clique na opção "Novo provedor" para adicionar um novo provedor. Ficou alguma dúvida? Clique aqui para ver o tutorial de VTEX.

Encontre a opção PagarMeV3

Na tela de adição de provedor, existem dois campos obrigatórios que são o "Chave de aplicação" (Application Key) e "Token de aplicação" (Application Token), aqui devem ser inseridas as chaves geradas na sua integração do HUB.

Para acessar e copiar suas chaves, siga os passos a seguir:

Acesse a página "Minhas Integrações" no HUB, via o link https://hub.pagar.me/install. Nesta página você encontrará a integração da sua conta Pagar.me com a VTEX, realizada no início deste documento. As chaves estarão ocultas e só podem ser vistas pelos usuários com permissão de "Owner da Merchant", "Admin da Merchant" ou "Manager da Account".

Caso o seu usuário tenha alguma dessas permissões você poderá acessar os "3 prontinhos" no canto superior direito e poderá copiar as chaves.

Para transportar as chaves para a afiliação, clique em "ID" no HUB para copiar o Account ID e cole no campo "Application Key" da configuração do Provedor de pagamento VTEX. Depois, clique em "Token" no HUB para copiar o Token e cole no campo "Application Token".

Em seguida será necessário nomear a afiliação que está sendo criada, no campo "informações básicas" > "Nome". Você pode escolher o nome que fizer mais sentido para a sua organização, e vai servir para identificar a integração com o Pagar.me quando estiver configurando os métodos de pagamento na VTEX.

Logo abaixo deve ser definida se a afiliação está em ambiente Live/produção ou Teste. Esse campo deve ser definido Desmarcado sempre, pois a diferenciação entre seu ambiente de teste e produção no Pagar.me se dá pelas chaves que forem configuradas no Application Key e Application Token.

Caso você não deseje configurar o Split de pagamentos, deixe a opção "Ativar split de recebiveis e enviar recebedores de pagamento" Desmarcada.

Caso você deseje configurar o Split de pagamentos, marque a opção Ativar split de recebiveis e enviar recebedores de pagamento" Selecionada. Neste caso, a sua configuração deve se parecer com a figura abaixo:

Prossiga então para o preenchimento dos demais campos de configuração de split. Os campos são os seguintes:

Ativar split de recebiveis e enviar recebedores de pagamentoDefine se sua loja irá ou não atuar como um marketplace. Essa configuração faz com que regras de split sejam enviadas para a Pagar.me, caso elas estejam configuradas na VTEX.
Responsabilidade pelas tarifas de pagamentoDefine quem será responsável pelas tarifas de MDR cobradas pela Pagar.me, podendo ser o marketplace, os sellers ou ambos. Esse campo só é exibido caso a opção de split esteja "Selecionada".
Responsabilidade pelos estornosDefine quem será responsável pelos chargebacks caso eles ocorram, podendo ser o marketplace, os sellers ou ambos. Esse campo só é exibido caso a opção de split esteja "Selecionada".

📘

Gestão de recebedores/sellers

É importante ressaltar que para modelos Marketplace, a regra base para a cobrança de split de pagamentos (a divisão de valores entre os recebedores/sellers de acordo com sua comissão) deve ser configurada dentro da Vtex, o Pagar.me somente executa as regras conforme o que é requisitado pela Vtex.

Mais informações sobre gerenciamento de sellers da Vtex aqui.

Após configurar a afiliação basta clicar em salvar e a próximo passo é adicionar essa afiliação na condições de pagamento que desejar. Clique aqui para conferir o tutorial feito pela VTEX.

Lembre-se de selecionar a afiliação que acabou de criar e mudar o status para "Ativa". Configuradas as condições desejadas, basta clicar em salvar

Após a conclusão basta verificar se a condição de pagamento que acabou de criar está correta e ativa.

🚧

IMPORTANTE

É necessário configurar cada método de pagamento individuamente dentro da VTEX. Isso deve ser configurado após finalizar a instalação. Clique aqui para conferir o tutorial feito pela VTEX.