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

É possível customizar o nosso checkout com suas cores, logo e até mesmo adicionar o link da sua loja.

O primeiro passo para customizar o checkout é acessar a nossa dashboard transacional. Uma vez logado acesse as configurações da conta na barra lateral clicando em "Configurações > Conta".

Todos os parâmetros do checkout estão na área de configurações gerais. Para alterar qualquer parâmetro basta clicar em "Editar".

Os parâmetros são os seguintes:

Parâmetro

Nome exibido nos produtos

Nome que será exibido no topo da tela do checkout.

Url logo

Precisa ser preenchido com a url da imagem hospedada. Define o logo que será exibido no checkout. Substitui o nome no topo da tela do checkout.

Email

Email de contato para que o seu cliente possa contatá-lo.

Url site

Link que será adicionado tanto no cabeçalho da página qunato nos botões de voltar para loja.

Utilizar cores padrão do checkout

Caso esteja habilitada essa opção, as cores utilizadas no checkout serão as cores padrão da Pagar.me. Para customizar o checkout com suas próprias cores é necessário desabilitar essa opção.

Cor principal

Precisa ser preenchido com um valor hexadecinal. Define as cores predominantes do checkout. Essa cor será aplicada na barra de progresso da compra e nos botões de avançar por exemplo.

Cor secundária

Precisa ser preenchido com um valor hexadecinal. Define as cores de detalhes do checkout. Essa cor será aplicada no botão de concluir pagamento e alguns icones.

Uma vez preenchidas as informações desejadas, basta inserir sua senha de acesso, clicar em salvar alterações e pronto! Fácil e rápido.

❗️

Atenção

Essa integração funciona apenas para a versão 2019-09-01 ou posteriores da API Pagar.me

Tutorial de instalação

Conseguindo suas chaves

Acesse sua conta Pagarme em https://dash.pagar.me/ e selecione a conta que deseja realizar essa instalação

No canto superior direito selecione a opção para ser redirecionado para o HUB

Selecionando a opção "Shopify" você será redirecionado para a página da integração, então basta clicar em "Integrar com Pagar.me"

Na tela de configuração todos os parâmetros gerais da integração podem ser ajustados como taxas e número de parcelas.

Segue abaixo uma tabela com cada campo explicado

Parâmetro

Loja

Para merchants com mais de uma loja é importante conferir se a loja que está selecionada é a que deseja instalar

Número máximo de parcelas

Define qual é a quantidade máxima de parcelas que a compra pode ser realizada. Valor de 1 a 12.

Máximo de parcelas sem juros

Define quantas parcelas não terão juros. Valor de 1 a 12.

Valor mínimo da parcela

Define qual é o valor mínimo que cada parcela deve ter. Caso o valor não atinja o valor mínimo apenas a opção de pagamento à vista estará presente no checkout.

Taxa inicial de juros

Esse é o juros que será aplicado na primeira parcela com juros. Valor em porcentagem.

Taxa de juros incremental

Esse é o juros que será aplicado à partir da segunda parcela com juros. Caso seja preenchido o juros irá aumentar conforme o parcelamento aumenta. Valor em porcentagem.

Dias para adicionar no vencimento do boleto

Define em quantos dias o boleto emitido irá vencer. Valor mínimo 1.

Código dos bancos aceitos para transferência

Campo exclusivo para cliente gateway que possuem bancos integrados à Pagar.me. Os códigos dos bancos devem ser separados por vírgula

Aceita boleto?

Habilita o boleto no checkout.

Aceita cartão de crédito?

Habilita o cartão de crédito no checkout.

Aceita transferência online?

Habilita a transferência online no checkout (exclusivo para clientes gateway).

Temos permissão de pedir o CPF no checkout?

Habilita que o checkout solicite o CPF do comprador. Obrigatório para clientes PSP.

O endereço de cobrança pode ser editável no checkout?

Habilita a opção para que o cliente altere a endereço que havia sido preenchido no Shopify.

Método de pagamento padrão

Define qual é o método de pagamento que será o padrão no checkout.

Operação padrão para cartão de crédito

Define se as compras com cartão de crédito devem ser apenas autorizadas ou autorizadas e capturadas

Clicando para finalizar a instalação, você voltará para a página de integração da platforma e do lado direito haverá uma lista com as lojas que estão integradas nesse meio de pagamento.

Para copiar as suas chaves basta clicar nos botões de ID e TOKEN:

🚧

Lembre-se de habilitar o checkout

O shopify utiliza-se do checkout redirecionado da Pagar.me, então para que o mesmo funcione corretamente é necessário que o mesmo esteja habilitado na dashboard.

Configurando sua loja

Para que a integração com o Shopify funcione corretamente é necessário ter algumas configurações habilitadas dentro da plataforma. São 3 configurações que recomendamos que sejam realizadas ativadas:

Habilitar criação de contas

Na área de administração da sua loja acesse "Settings > Checkout". Encontre a opção "Customer Accounts" e altere para "Accounts are required".

customeracc-shop.pngcustomeracc-shop.png

customeracc-shop.png

Essa configuração fará com que o cliente precise de uma conta na loja para transacionar. Essa configuração não é obrigatória, porém é necessária para que os clientes consigam consultar os pedidos posteriormente na loja.

Email obrigatório

Para configurar, acesse área de administração da sua loja, na opção "Settings > Checkout". Encontre a opção "Customer contact" e altere para "Customers can only check out using email".

customercontact-shop.pngcustomercontact-shop.png

customercontact-shop.png

Essa configuração tornará obrigatória a inserção de um email durante o processo de compra.

Duas linhas de endereço obrigatórias

Na área de administração da sua loja acesse "Settings > Checkout". Encontre a opção "Form Options" e altere a opção Address line 2 para "Required".

formopt-shop.pngformopt-shop.png

formopt-shop.png

Essa configuração irá obrigar o comprador a preencher as duas linhas de endereço exibidas no checkout. Esses parâmetros são essenciais para que a integração funcione corretamente.

Instalando o Payment Provider

Acesse o link de instalação do provider. Selecione a sua loja:

Autorize a instalação do aplicativo clicando sobre o botão Install Payment Provider

Após confirmar a instalação, clicando no botão Install Payment Provider, você será redirecionado à página de seleção de meios pagamentos. Nesta tela, clique sobre o botão Choose Thrid Party Provider:

Pesquise por "Pagar.Me" e clique na opção "Pagar.me Payments"

Dirija-se a seção Configuração para finalizar a configuração de sua loja.

Reinstalando o Payment Provider

Caso já tenha instalado a Pagar.me anteriormente acesse sua loja Shopify

No canto inferior esquerdo, acesse a opção de configurações (settings)

Na tela de settings selecione a opção de meios de pagamento (payments)

Selecione a opção Choose Third-party providers

Pesquise por "Pagar.Me" e clique na opção "Pagar.me Payments"

Feito isso, basta configurar seu payment provider!

Configurando o payment provider

Copie a chaves da integração (aquelas que configurou no primeiro passo) e insira as mesmas no campo Account Information dentro da plataforma.

Configure as bandeiras que deseja aceitar

Caso esteja utilizando as credenciais de testes, ative o modo de testes

👍

Vale lembrar

O checkout redirecionado pode ser customizado. Você encontra todos os detalhes de como customizar o seu checkout clicando aqui.

Pronto! O checkout está pronto para utilizar.

Updated about a month ago


Shopify


Suggested Edits are limited on API Reference Pages

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