Manual de configuração Marketplace
- Instalação da APP no marketplace
– Autenticado na conta do marketplace, aceda ao menu lateral “Transações” -> “Pagamentos” / “Configurações”, clique no menu superior “Afiliações de gateways” e depois no botão “+”.
– Procure por “easypay” e clique.
– Clique em “Instalar app”.
– Será aberta uma nova aba para instalação, clique em “INSTALAR”.
– Será aberto um pop-up. Clique em “INSTALAR”.
* Após instalar, caso a página não seja redirecionada, atualize o ecrã.
- Configuração do aplicativo
– Para configurar o aplicativo, aceda ao menu lateral e vá em “Configurações da conta” -> “Aplicativos” / “Meus aplicativos”, localize o Easypay Payment Provider e clique em “Configurações”.
A seguinte página será aberta:
Nesse ecrã é feita a configuração de campos importantes para o funcionamento do Easypay Payment Provider.
A configuração é separada por quatro partes: Credenciais Easypay (OBRIGATÓRIO), Pagamento (OBRIGATÓRIO), Personalização do Checkout Easypay (OPCIONAL) e Sandbox. Preencha atentamente.
Onde encontrar as informações necessárias para cada campo e como preencher:
- Credenciais Easypay (OBRIGATÓRIO)
1.1 Key ID e Key value:
– Autenticado no BackOffice da easypay, na parte superior do menu lateral, clique no logótipo da easypay e na conta “MARKETPLACE” clique na seta.
– No menu lateral clique em “Web Services” -> “Configuração API 2.0” -> clique em “Chaves” no que contém o alias “Criar Dados de Pagamento”.
– Copie o ID e a Chave. Caso queira, é possível criar uma nova chave clicando em “+ Nova”.
Volte à configuração do Easypay Payment Provider, cole o ID no campo “Key ID” e a Chave no campo “Key value”.
1.2 Margin account UID:
– No menu lateral, clique em “Beneficiário” -> Copie o “Account UID” que contém o alias “Conta de Margens”.
Volte à configuração do Easypay Payment Provider, cole o “Account UID” no campo “Margin account UID”.
1.3 Refund account ID e Refund account key:
– No menu lateral clique em “Web Services” -> “Configuração API 2.0” -> clique em “Chaves” no que contém o alias “Conta de Margens”.
– Clique em “+ Nova”
– Nomeie com “Refund Account” e clique em “Gravar”.
– Copie o ID e a Chave.
Volte à configuração do Easypay Payment Provider, cole o ID no campo “Refund account ID” e a Chave no campo “Refund account key”.
* Os reembolsos são retirados de uma conta do marketplace. O marketplace deve reaver o valor reembolsado diretamente com o comerciante.
1.4 Merchant account UID
Esse parâmetro define a conta de comerciante onde serão depositados os valores das compras dos produtos da própria loja, caso não tenha uma conta de comerciante separada, pode utilizar o “Account UID” da conta de pagamentos.
– Autenticado no BackOffice da easypay, na parte superior do menu lateral, clique no logótipo da easypay e na conta “COMERCIANTE 1” clique na seta.
– Copie o “Account UID”.
Volte à configuração do Easypay Payment Provider, cole o “Account UID” no campo “Merchant account UID”.
- Pagamento (OBRIGATÓRIO)
Onde identificar se um método de pagamento é assíncrono ou síncrono: https://docs.quality-utility.aws.easypay.pt/concepts/payment-methods
Onde encontrar as siglas atualizadas disponíveis:
Entre no link: https://docs.quality-utility.aws.easypay.pt/checkout/reference
Em “payment”, clique para expandir os detalhes e aparecerá os métodos disponíveis.
2.1 Tipos de pagamento assíncronos aceites
Define os métodos de pagamento assíncronos que estarão disponíveis para o cliente. Deve ser preenchido apenas com as siglas dos tipos de pagamento ASSÍNCRONOS separados por vírgula, sem pontos e sem espaços.
Como preencher:
Correto: mb,dd,vi,sc
Incorreto: mb, dd, vi, sc
*Caso esse campo esteja preenchido, é obrigatório o preenchimento do campo “Dias para expiração de pagamentos assíncronos”.
2.2 Tipos de pagamento síncronos aceites
Define os métodos de pagamento síncronos que estarão disponíveis para o cliente. Deve ser preenchido apenas com as siglas dos tipos de pagamento SÍNCRONOS separados por vírgula, sem pontos e sem espaços.
Como preencher:
Correto: cc,mbw,uf
Incorreto: cc, mbw, vi, sc
2.3 Dias para expiração de pagamentos assíncronos
Define o tempo de expiração em dias de pagamentos assíncronos. Preencha apenas o número de dias desejado. Exemplo: Se for 10 dias, o preenchimento deve ser 10.
Como preencher:
Correto: 10
Correto: 5
Incorreto: dez
Incorreto: 10/05/2023
- Personalização do Checkout Easypay (OPCIONAL)
Caso decida por não personalizar, a aparência do seu checkout Easypay será assim:
3.1 Checkout logo URL
O URL do logótipo do comerciante a apresentar no Checkout Easypay. Preencha o link onde a imagem está hospedada.
3.2 Checkout background color
A cor usada como background do Checkout Easypay. Preencha o código HEX da cor desejada.
Padrão: #ffffff.
3.3 Checkout accent color
A cor usada nos destaques e padrão para botões e bordas dos inputs. Preencha o código HEX da cor desejada.
Padrão: #0d71f9.
3.4 Checkout error color
A cor usada para apresentar erros. Preencha o código HEX da cor desejada.
Padrão: #ff151f.
3.5 Checkout input background color
A cor usada para o background dos inputs. Preencha o código HEX da cor desejada.
Padrão: transparent.
3.6 Checkout input border color
A cor usada para a borda dos inputs. Preencha o código HEX da cor desejada.
Padrão: a mesma utilizada no accent color.
3.7 Checkout input border radius
Permite definir o arredondamento das bordas dos inputs. Preencha com o arredondamento desejado em pixels. Utilize apenas números.
Padrão: 50px.
Como preencher:
Correto: 35
Incorreto: 35px
3.8 Checkout button background color
A cor usada para o background dos botões. Preencha com o código HEX da cor desejada.
Padrão: a mesma utilizada no accent color.
3.9 Checkout button border radius
Permite definir o arredondamento das bordas dos botões. Preencha com o arredondamento desejado em pixels. Utilize apenas números.
Padrão: 50px.
Como preencher:
Correto: 30
Incorreto: 30px
3.10 Checkout button box shadow
Permite ativar ou desativar a sombra nos botões.
3.11 Checkout font family
Define a fonte usada nos textos. Preencha com generic family name, web safe font ou o link da fonte.
Padrão: Overpass.
Como preencher:
Correto: sans-serif
Correto: verdana
Correto: https://fonts.gstatic.com/s/overpass/v12/qFda35WCmI96Ajtm83upeyoaX6QPnlo6_PPbM5qKl8Kuo8AzesE.woff2
3.12 Checkout base font size
Define o valor em pixels para o tamanho da fonte no elemento raíz. Utilize apenas números. *Em valores acima de 12, o layout do checkout quebra.
Padrão: 10.
Como preencher:
Correto: 11
Incorreto: 11px
- Sandbox
Para testes de desenvolvimento, ative o modo sandbox. *Necessário utilizar credenciais de teste.
– Após o correto preenchimento dos campos, clique em “SALVAR”.
3) Configuração do webhook
– Autenticado no BackOffice da easypay, na parte superior do menu lateral clique no logótipo da easypay e clique na seta da conta marketplace.
– No menu lateral clique em “Web Services” -> “Configuração URL”. No campo “URL: Notificar” preencha com o seguinte link substituindo apenas “nome-da-sua-loja” pelo nome real da sua loja marketplace:
https://nome-da-sua-loja.myvtex.com/_v/labsitpartnerpt.payment-provider-easypay/webhook
Caso haja mais de uma conta de pagamento do seu marketplace, preencha também. Por fim, clique em “Submeter”.
4) Configuração do método de pagamento Easypay dentro da VTEX
– Acesse “Transações” -> “Pagamentos” -> “Configurações”, clique em “Afiliações de gateways”.
– Clique no “+”.
– Procure por “easypay” e clique.
Atente-se às seguintes configurações:
“Captura automática de pagamento” deve estar marcada com “Use o comportamento recomendado pelo processador de pagamentos”.
“Ativar divisão e enviar recebedores?” deve estar marcada com “Sim”. “Responsabilidade pelas tarifas de pagamento” e “Responsabilidade pelos estornos” devem estar marcadas com “Marketplace”.
Por último, clique em “Salvar”.
– Agora é possível ver a “easypay” em Afiliações de gateways.
– Na aba Condições de pagamento, clique no “+”
– Procure por “easypay” e clique.
– Caso deseje, preencha com um nome personalizado de sua escolha para fácil identificação da condição de pagamento. Deixe o status em “Ativo” e certifique-se de que o “Processar com a filiação:” esteja a apontar para “easypay”. Por fim, clique em “Salvar”.
– Em até 10 minutos, a easypay estará pronta para ser utilizada no checkout da loja.
– Checkout exemplo:
*Para inserir um logótipo dos métodos aceites similar ao checkout acima é necessário entrar em contato com a agência que realiza as personalizações da sua loja. Link para os logótipos da Easypay: https://www.easypay.pt/brand-center/