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

Configurando o módulo Pagar.me na plataforma EZ Commerce

Siga os passos a seguir para integrar o Pagar.me como meio de pagamentos na sua conta da plataforma EZ Commerce.

Se você tiver dúvidas durante o processo, fale com o responsável pela ativação da sua operação ou entre em contato através do e-mail homologacao@pagar.me para que possamos ajudar.

API Key e Encryption Key

Para usar o módulo do Pagar.me na EZ Commerce você vai precisar da API Key e da Encryption Key da sua conta. Saiba mais sobre essas chaves e veja como obtê-las em: Chaves de acesso

Instalando as formas de pagamento na plataforma EZ Commerce

Na EZ Commerce, não é preciso instalar previamente os módulos antes de configurá-los. Dessa forma, para começar a fazer as configurações, você precisa acessar o seu painel administrativo da plataforma e então encontrar a guia "Formas de pagamento".

Ali, é possível configurar uma opção do Pagar.me para Boleto bancário e, logo em seguida, outra para o Cartão de crédito.

Configurações de Boleto bancário

Em seu painel administrativo acesse a rota Formas de pagamento > Boleto Bancário, como mostra a imagem abaixo:

Após selecionar “Boleto Bancário” uma lista com todas as opções é mostrada. Procure pela opção que indica “Pagar.Me” na coluna de “Adquirente / Gateway”.

Para continuar as configurações, clique na janela de ação dessa opção, conforme imagem abaixo:

Após selecionar a janela de ação no módulo de Boleto bancário do Pagar.me, um menu de configurações dessa opção de pagamento é aberto. Esse menu contém as guias "Geral", "Notificador de boleto não pago", "Específico" e "Mapeamento de situações e pedidos".

Siga as instruções a seguir para configurar cada uma dessas guias corretamente.

GERAL

Explicando os campos da imagem acima:

Título

Este é o nome que aparece no campo da opção de Boleto na página de finalização de compra em sua loja.

Ativo

Neste campo você pode habilitar ou desabilitar o pagamento com Boleto bancário do Pagar.me na sua aplicação. Quando habilitado, este recurso aparece entre as opções de pagamento na página de checkout da sua loja.

Variação de valor

Nesse campo, caso você queira, é possível determinar um desconto ou acréscimo (em porcentagem) a partir de um determinado preço, para produtos escolhidos. Clicando nessa opção, uma nova janela é aberta, mostrando os itens abaixo:

  • Variação de valor: determina se será aplicado um desconto ou um acréscimo;
  • Porcentagem (%): escolhe o valor, em porcentagem, para a variação desse valor;
  • A partir do valor (R$): define um valor mínimo para que o desconto ou acréscimo seja aplicado;
  • Produtos: indica para quais produtos essa configuração é válida.

Após configurar os campos da maneira desejada, é preciso salvar as alterações. Para fazer isso, clique em “Cadastrar” e em seguida em “Fechar”, conforme imagem abaixo:

Após fechar essa janela de variação de valor, você volta para o menu de Boleto bancário e precisa continuar com a configuração na próxima guia.

NOTIFICADOR DE BOLETO NÃO PAGO

Explicando os campos da imagem acima:

Ativar Notificador

Esse campo permite ativar o notificador de boleto não pago. Esse item é um serviço que faz a verificação de boletos gerados na loja que ainda não foram pagos até determinada data (dias configuráveis). A partir disso, o sistema notifica os clientes do vencimento destes boletos, solicitando a quitação deles.

Dias antes do vencimento

Permite configurar quantos dias antes da data de vencimento você deseja que a notificação seja enviada para o cliente.

E-mail cópia

Aqui você pode cadastrar um e-mail caso queira receber uma cópia dessas notificações de boleto não pago.

ESPECÍFICO

Explicando os campos da imagem acima:

Chave de API

Neste campo você precisa colocar a sua api_key, de acordo com o ambiente que você deseja usar, teste ou produção. Veja mais sobre essa chave em: Chaves de acesso

Isto é, se você quer usar o ambiente test, use a sua chave de teste para simular pagamentos na sua Dashboard. Já para o ambiente live, é necessário usar a chave de produção, que torna possível aceitar pagamentos reais no seu site.

Exemplo de API Key para produção: ak_live_qlSlEXJgsqaCjKohh5AZfnqv7OLP5Q
Exemplo de API Key para teste: ak_test_grXijQ4GicOa2BLGZrDRTR5qNQxJW0

Chaves de teste

Operações feitas usando uma api_key ou uma encryption_key de teste não geram pagamentos reais para a sua company.

Chave de Criptografia

Neste campo você precisa colocar a sua encryption_key, de acordo com o ambiente que você deseja usar, teste ou produção. Veja mais sobre essa chave em: Chaves de acesso

Esta chave é usada para conseguir algumas informações junto à API Pagar.me e é essencial para transações por Cartão de crédito.

Exemplo de encryption key para produção: ek_live_Wa8CDUuLlFvSQzjxf4YFZIBQvb2l1p
Exemplo de encryption key para teste: ek_test_aHGru3d5a7qweiftqXg1bQvbN1c7K0

Enviar dados de Análise do Risco

Esse campo permite que os dados sejam enviados para a análise do antifraude. Por um padrão de segurança do Pagar.me, esse campo precisa estar sempre configurado como “Sim”. Se você precisa desativar a ferramenta, entre em contato com o nosso atendimento pelo e-mail relacionamento@pagar.me, para encontrar uma solução que atenda às suas necessidades de forma segura.

Vencimento

Neste campo você pode definir a quantidade de dias até que um boleto gerado vença.

Beneficiário

Aqui você define como é mostrado o nome da sua loja no Boleto impresso. Esse campo permite no máximo 13 caracteres.

Atenção!

Esse campo não aceita caracteres especiais, apenas letras e números, sem espaço.

Instrução

Nesses campos (linha 1, 2 e 3) você pode escolher o que deve ser impresso nas instruções no boleto. Por exemplo: Senhor(a) caixa, não aceitar o pagamento após o vencimento.

MAPEAMENTO DE SITUAÇÕES DE PEDIDOS

Explicando os campos da imagem acima:

Não concluído pelo cliente

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que não foram concluídos pelo cliente. Sugerimos deixar esse campo com a opção “Transação não finalizada”.

Concluído pelo cliente

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que foram concluídos pelo cliente. Sugerimos deixar esse campo com a opção “Aguardando verificação”.

Em análise/Aprovação

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que estão sob análise. Sugerimos deixar esse campo com a opção “Aguardando captura”.

Pagamento confirmado

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e tiveram o pagamento confirmado. Sugerimos deixar esse campo com a opção “A enviar”.

Finalizado

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que foram finalizados. Sugerimos deixar esse campo com a opção “Finalizado”.

Cancelado

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que foram cancelados. Sugerimos deixar esse campo com a opção “Cancelado pela loja”.

Salvando as alterações de Boleto Bancário

Ao finalizar a configuração, clique no canto inferior direito da tela em "Salvar" e então em “Fechar”, conforme mostra a imagem abaixo:

Quando isso é feito, você volta para a página de Boleto bancário. Para confirmar que tudo funcionou corretamente, verifique se o Pagar.me está ativo, conforme mostra a imagem abaixo:

Configurações de Cartão de crédito

Em seu painel administrativo acesse a rota Formas de pagamento > Cartão de crédito:

Após selecionar “Cartão de crédito” uma lista com todas as opções é mostrada. Procure pelas opções de bandeira que indicam “Pagar.Me” na coluna de “Adquirente / Gateway”.

Para continuar as configurações, clique na janela de ação de cada uma das opções, conforme imagem abaixo:

A configuração do cartão de crédito é feita por bandeiras. Sendo assim, vamos mostrar como habilitar o Pagar.me para a bandeira American Express. Para habilitar para as outras bandeiras que também são aceitas (Mastercard, Visa, Elo, Diners, Discovery, JCB, Aura e Hipercard), basta seguir os mesmos passos.

Após selecionar a janela de ação no Cartão de crédito do Pagar.me, um menu de configurações dessa opção de pagamento irá se abrir. Esse menu, contém as guias "Geral", "Específico" e "Mapeamento de situações de pedidos".

Siga as instruções a seguir para configurar cada uma dessas guias corretamente.

GERAL

Explicando os campos da imagem acima:

Título

Este é o nome que aparece no campo da opção de Cartão de crédito na página de finalização de compra em sua loja.

Ativo

Neste campo você pode habilitar ou desabilitar o pagamento com essa bandeira de Cartão do Pagar.me na sua aplicação. Quando habilitado, este recurso aparece entre as opções de pagamento na página de checkout da sua loja.

Variação de valor

Nesse campo, caso você queira, é possível determinar um desconto ou acréscimo (em porcentagem) a partir de um determinado preço, para produtos escolhidos. Clicando nessa opção, uma nova janela é aberta, mostrando os itens abaixo:

  • Variação de valor: determina se será aplicado um desconto ou um acréscimo;
  • Porcentagem (%): escolhe o valor, em porcentagem, para a variação desse valor;
  • A partir do valor (R$): define um valor mínimo para que o desconto ou acréscimo seja aplicado;
  • Faixa de parcelas: define o intervalo de parcelas no qual esse desconto ou acréscimo pode ser aplicado;
  • Produtos: indica para quais produtos essa configuração é válida.

Após configurar os campos da maneira desejada, é preciso salvar as alterações. Para fazer isso, clique em “Cadastrar” e em seguida em “Fechar”, conforme imagem abaixo:

Após fechar essa janela de variação de valor, você volta para o menu de Cartão de crédito e precisa continuar com a configuração na próxima guia.

ESPECÍFICO

Explicando os campos da imagem acima:

Chave de API

Neste campo você precisa colocar a sua api_key, de acordo com o ambiente que você deseja usar, teste ou produção. Veja mais sobre essa chave em: Chaves de acesso

Isto é, se você quer usar o ambiente test, use a sua chave de teste para simular pagamentos na sua Dashboard. Já para o ambiente live, é necessário usar a chave de produção, que torna possível aceitar pagamentos reais no seu site.

Exemplo de API Key para produção: ak_live_qlSlEXJgsqaCjKohh5AZfnqv7OLP5Q
Exemplo de API Key para teste: ak_test_grXijQ4GicOa2BLGZrDRTR5qNQxJW0

Chaves de teste

Operações feitas usando uma api_key ou uma encryption_key de teste não geram pagamentos reais para a sua company.

Chave de Criptografia

Neste campo você precisa colocar a sua encryption_key, de acordo com o ambiente que você deseja usar, teste ou produção. Veja mais sobre essa chave em: Chaves de acesso

Esta chave é usada para conseguir algumas informações junto à API Pagar.me e é essencial para transações por Cartão de crédito.

Exemplo de encryption key para produção: ek_live_Wa8CDUuLlFvSQzjxf4YFZIBQvb2l1p
Exemplo de encryption key para teste: ek_test_aHGru3d5a7qweiftqXg1bQvbN1c7K0

Descrição da cobrança

Esse campo permite configurar como você deseja que apareça o nome da sua loja da fatura do cliente. Essa descrição pode ter no máximo 13 caracteres.

Atenção!

Esse campo não aceita caracteres especiais, apenas letras e números, sem espaço.

Tipo de captura

Esse campo define se as transações feitas no seu site serão autorizadas e capturadas automaticamente ou apenas autorizadas, deixando a captura para um momento posterior.

Quando a opção "Automática" é selecionada, o módulo solicita à API Pagar.me que realize o fluxo de informação completo — ou seja, reservar e confirmar junto ao banco emissor a cobrança da quantia passada no cartão utilizado. Sendo assim, o pedido já entra no seu sistema com a fatura criada e o valor é debitado do cliente.

Já para a outra opção, o Pagar.me solicita para o banco emissor a reserva do valor do pedido no saldo do cartão utilizado. Depois disso, a captura deve ser feita manualmente, acessando o pedido no seu painel da EZ Commerce.

Esse processo é indicado para os casos nos quais a sua loja gostaria de analisar o pedido, verificar se há estoque, ou mesmo outras situações de acordo com o seu negócio. Veja mais sobre o assunto na seção "5. Autorização e Captura" na página: Overview da Transação

Sugerimos deixar esse campo com a opção “Automática”.

Enviar dados de Análise do Risco

Esse campo permite que os dados sejam enviados para a análise do antifraude. Por um padrão de segurança do Pagar.me, esse campo precisa estar sempre configurado como “Sim”. Se você precisa desativar a ferramenta, entre em contato com o nosso atendimento pelo e-mail relacionamento@pagar.me, para encontrar uma solução que atenda às suas necessidades de forma segura.

Nº total de Parcelas

Caso queira oferecer a opção de pagamento parcelado em até quantas vezes (de 1 a 12) o seu cliente pode parcelar os produtos vendidos na sua loja.

Nº total de Parcelas sem juros

Esta opção define em até quantas parcelas não será cobrado juros nas compras.

Por exemplo: se o campo estiver configurado com o valor 3, caso o cliente opte por comprar em 1x, 2x ou 3x, o seu pedido não será cobrado juros. No entanto, caso ele escolha 4x, todas as parcelas terão juros aplicados.

Porcentagem de Juros (Padrão)

Define a porcentagem de juros ao mês que será cobrada, caso necessário.

Parcela mínima (R$)

Caso queira, você pode definir qual é o valor mínimo permitido para as parcelas de qualquer pedido na sua loja. Quando isso é configurado, o módulo mostra sempre o maior número até que o valor seja atingido. No Pagar.me, este valor tem que ser pelo menos R$ 1,00.

Configuração de juros

Nesse campo, caso queira, é possível determinar os juros a serem aplicados para cada parcela. Clicando nesse botão, uma nova janela é aberta com os itens abaixo:

  • Parcelamento: Define a parcela na qual o juro será aplicado.
  • Tipo de juros: Determina o juro a ser aplicado na parcela correspondente.

Após configurar os campos da maneira desejada, para que as alterações sejam salvas, clique em “Salvar e fechar”, conforme mostra a imagem abaixo:

MAPEAMENTO DE SITUAÇÕES E PEDIDOS

Explicando os campos da imagem acima:

Não concluído pelo cliente

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que não foram concluídos pelo cliente. Sugerimos deixar esse campo com a opção “Transação não finalizada”.

Concluído pelo cliente

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que foram concluídos pelo cliente. Sugerimos deixar esse campo com a opção “Aguardando verificação”.

Em análise/Aprovação

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que estão sob análise. Sugerimos deixar esse campo com a opção “Aguardando captura”.

Pagamento confirmado (Pago)

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e tiveram o pagamento confirmado. Sugerimos deixar esse campo com a opção “A enviar”.

Finalizado

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que foram finalizados. Sugerimos deixar esse campo com a opção “Finalizado”.

Cancelado

Define o status para novos pedidos que forem feitos utilizando o Pagar.me como meio de pagamento e que foram cancelados. Sugerimos deixar esse campo com a opção “Cancelado pela loja”.

Salvando as alterações de Cartão de crédito

Ao finalizar a configuração, clique no canto inferior direito da tela em "Salvar" e então em “Fechar”, conforme mostra a imagem abaixo:

Quando isso é feito, você volta para a página de Cartão de crédito. Para confirmar que tudo funcionou corretamente, verifique se o Pagar.me está ativo, conforme mostra a imagem abaixo:

Pronto! Os módulos do Pagar.me na EZ Commerce foram ativados e devem aparecer como opções de meio de pagamento na página de checkout da sua loja.

Configurando o módulo Pagar.me na plataforma EZ Commerce


Suggested Edits are limited on API Reference Pages

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