Manuais e Downloads

O Yapay possui módulos prontos para alguns sistemas de terceiros. Esses módulos são desenvolvidos internamente ou através de parceiros, e possuem diversos testes para garantir a sua compatibilidade com as versões abaixo indicadas.

Abaixo são disponibilizados os links para os manuais dos módulos disponíveis:

  Checkout Transparente Checkout Simples    
Integração do Tray Checkout com a plataforma de e-commerce Tray Commerce Yapay - - -
Integração do Tray Checkout com a plataforma de e-commerce Tray Commerce Yapay - - -
Integração do Tray Checkout com a plataforma de e-commerce Magento Yapay - Yapay Yapay
Integração do Tray Checkout com a plataforma de e-commerce WooCommerce Yapay - Yapay Yapay
Integração do Tray Checkout com a plataforma de e-commerce OpenCart em breve Yapay Yapay Yapay
Integração do Tray Checkout com a plataforma de e-commerce Presta Shop em breve Yapay Yapay Yapay
Integração do Tray Checkout com a plataforma de e-commerce OsCommerce em breve Yapay Yapay Yapay

Magento

Para disponibilizar a API de Pagamento do Yapay como facilitador de pagamento na plataforma Magento, basta acessar o Magento Connect Manager de sua loja e instalar o módulo disponível no repositório Magento Connect ou baixar o pacote disponível no site institucional do Yapay.

Instalação do Módulo Magento

Existem duas formas de realizar a instalação do módulo Magento:

  1. Instalação através da Chave da Extensão (Extension Key)

  2. Instalação através do Pacote da Extensão


1- Instalação através do Pacote da Extensão

Para instalar o módulo é necessário baixar o arquivo através da página a seguir:

Magento

Acesse o Magento Connect Manager de sua loja Magento (menu Sistema > Conexão Magento > Gerenciador de Conexão Magento), e clique no botão Selecionar arquivo da opção Upload Package File, conforme imagem abaixo. Selecione o pacote do Yapay baixado anteriormente, em seguida clique em Upload.

Magento Connect, instalação

Após a instalação do pacote, será exibido um log semelhante à imagem abaixo:

Magento Connect, instalação

Clique no botão Refresh e verifique se o módulo Yapay_Intermediador é listado nos módulos instalados, conforme abaixo:

Magento Connect, instalação

Clique em Return to Admin para voltar à área administrativa de sua loja virtual.

O próximo passo é configurar o módulo (veja o item 3).

2- Configuração do Módulo

Para utilizar o módulo da API de Pagamento do Yapay é necessário realizar duas etapas:

  1. Configurar sua loja virtual para disponibilizar os campos necessários para a integração

  2. Configurar o módulo de pagamento Yapay

2.1- Configuração dos Campos de Integração do Magento

Na integração com a API de Pagamento do Yapay é necessário o envio de alguns campos obrigatórios, onde será necessário disponibilizar estes campos na plataforma Magento.

Para a configuração do módulo, acesse o menu Sistema > Configuração, e no menu lateral esquerdo procure por Configuração do Cliente (faz parte do sub-menu Clientes). Ao clicar no link, serão listados as opções para configuração do cliente na loja virtual, procure pela aba Opções de Nome e Endereço para configurar os campos no Magento.

Após abrir a aba Opções de Nome e Endereço, encontre a opção Número de linhas em um endereço de rua e altere o valor para 4, onde serão disponibilizados 4 campos para cadastro do endereço, sendo respectivamente o logradouro, número, complemento e bairro.

Após alterar a opção acima, encontre a opção Exibir número fiscal e altere a opção para Obrigatório, assim será exibida a opção para o cliente informar o CPF no cadastro ou finalização da compra.

Segue abaixo imagem com a tela de configuração dos campos na plataforma Magento:

Magento Connect, instalação

2.2- Configuração do Módulo de Pagamento Yapay

Para a configuração do módulo, acesse o menu Sistema > Configuração, e no menu lateral esquerdo procure por Métodos de Pagamento (faz parte do sub-menu Vendas). Ao clicar no link, será listado todos os métodos de pagamento disponíveis, procure pela aba Yapay – Transparente para habilitar e configurar o método de pagamento.

Segue abaixo imagem com a tela de configuração:

Magento Connect, instalação

3.3- Opções de configuração Yapay:

Ativado: opção para habilitar o Yapay na finalização de compra

Título: título que aparecerá para seu cliente na hora de escolher a forma de pagamento

Status dos Novos Pedidos: status de cada novo pedido ao ser enviado para a Yapay

Token: chave gerada no seu painel de administração do Yapay, localizado no menu Perfil da Conta > Minha Conta > Dados da Conta

Gerar Fatura automaticamente para pedidos com produtos virtuais: caso esteja em “Sim”, os pedidos que contiverem ao menos um (1) produto virtual serão automaticamente marcados como “concluídos”, após o recebimento automático do pagamento. Isto se dá em função da não existência da etapa de “Envio” para estes produtos

Quantidade Máxima de Parcelas: representa a quantidade máxima de parcelas oferecida pela loja virtual, utilizando o Yapay

Meios de Pagamento Disponíveis: Meios de pagamento que serão exibidos para o consumidor ao finalizar a compra pelo Yapay

Parcelas sem Acréscimo: as parcelas selecionadas serão exibidas como sem acréscimo ao consumidor quando o mesmo finalizar a compra através do Yapay. Esta opção somente representa a visualização no checkout da loja virtual, onde também é necessário configurar na área administrativa do Yapay (menu Perfil da Conta > Configurações > Parcelamento de Vendas)

Taxa de Acréscimo: representa o percentual de acréscimo cobrado pelo Yapay

Prefixo do Pedido: campo utilizado para concatenar com o número do pedido da loja ao integrar com a Yapay

Ordem de exibição: ordem de exibição, caso exista mais de um método de pagamento

Ambiente de Teste (Sandbox): ambiente utilizado para que a loja possa realizar testes de integração – muita atenção para não manter este ambiente habilitado quando a loja estiver efetivamente vendendo

WooCommerce

Para disponibilizar o Yapay como facilitador de pagamento na plataforma WooCommerce, basta baixar o pacote disponível, extrair a pasta com o módulo, copiar para o diretório padrão e configurar o módulo.

Fique atento que sua versão de instalação, a plataforma WooCommerce deve ser compatível com o módulo Yapay.

Instalação do Módulo WooCommerce

Para instalar módulo é necessário baixar o pacote do WooCommerce:

WooCommerce

Acesse a área administrativa da plataforma e clique em Plugins > Adicionar Novo.

WooCommerce, instalação

Após acessar a página para adicionar um novo plugin, clique no botão “Fazer upload do plugin”.

WooCommerce, instalação

Irá aparecer a opção para selecionar o plugin do módulo. Selecione o plugin e clique em Instalar Agora.

WooCommerce, instalação

Após a instalação, basta ativar o plugin e irá visualizar as 3 opções de configuração (Config. Cartão / Config. TEF / Config. Boleto)

WooCommerce, instalação

Configuração do Módulo WooCommerce

Para acessar as configurações do módulo, clique no menu WooCommerce > Configurações, e clique na aba Checkout.

Clique em uma das opções de configuração do Yapay que será carregada a página do plugin com as opções de configuração abaixo:

WooCommerce, instalação

Opções de configuração Yapay:

Ativar / Desativar: Opção para ativar / desativar a opção de pagamento no checkout do WooCommerce.

Título: Título que será exibido no checkout do WooCommerce.

Descrição: Descrição que será exibida no checkout do WooCommerce.

Sandbox: Ambiente utilizado pela loja para realizar testes de integração com o Yapay – muita atenção para não manter este ambiente habilitado quando a loja estiver efetivamente vendendo.

Configuração Yapay: Botão para a configuração automática do Yapay.

Token da Conta: Token utilizado para a integração com o Yapay.

Consumer Key: Chave do Aplicativo no Yapay.

Consumer Secret: Chave de Segurança do Aplicativo no Yapay.

Meios de Pagamento Disponíveis: Seleção dos meios de pagamento que estarão disponíveis no checkout do WooCommerce (Opção somente na configuração de Cartão de Crédito e Transferência Online).

Prefixo do Pedido: Prefixo enviado para o Yapay.

PrestaShop

Para disponibilizar o Yapay como facilitador de pagamento na plataforma PrestaShop, basta baixar o pacote disponível no site institucional do Yapay, extrair a pasta com o módulo, copiar para o diretório padrão e configurar o módulo.

Fique atento que sua versão de instalação, a plataforma Prestashop deve ser compatível com o módulo Yapay.

1- Instalação do Módulo Prestashop

Para instalar módulo é necessário baixar o pacote do PrestaShop:

PrestaShop

Descompacte o arquivo baixado e copie a pasta para o diretório de módulos da sua instalação PrestaShop.

Passos para instalação via FTP, utilizando o Filezilla:

  1. Enviar a pasta extraída para o servidor da loja virtual, utilizando um software FTP (neste exemplo utilizamos o Filezilla)

  2. Ao efetuar a conexão no FTP, no lado direito serão mostradas as pastas que estão dentro do servidor, acesse a pasta do prestashop

  3. Dentro da pasta do PrestaShop existe um diretório chamado “Modules”, local onde devem ser instalados todos os arquivos do módulo, entrar na pasta “Modules” e enviar a pasta que extraída do Yapay

Cuidado para não arrastar em cima de uma pasta, se isso acontecer você terá uma pasta dentro da outra e então este módulo não funcionará.

PrestaShop, instalação

Após a conclusão do envio do módulo Yapay, acessar a administração do PrestaShop e entrar na seção de “Módulos”.

Na opção de busca, digitar Yapay e selecionar o módulo que já deverá estar listado na consulta:

PrestaShop, instalação

Será mostrado o módulo conforme a imagem abaixo. Clicar no botão install ou instalar (caso sua loja já esteja traduzida) no lado direito da listagem:

PrestaShop, instalação

Será necessário inserir dados de cadastro de sua conta para liberar os pagamentos em sua conta Yapay.

2- Configuração do Módulo PrestaShop

Na página de módulos, clique em Configure (Configuração) para acessar o módulo Yapay.

Será carregada a página do módulo com as opções de configuração abaixo:

PrestaShop, instalação

Opções de configuração Tray Checkout:

Token: campo obrigatório gerado no painel de administração Yapay

URL de notificação de status: URL utilizada pelo Yapay para alterar os status dos pedidos

Prefixo do Pedido: campo opcional, utilizado para concatenar com o número do pedido da loja ao integrar com a Tray

Ambiente de Teste (Sandbox): ambiente utilizado pela loja para realizar testes de integração com o Yapay – muita atenção para não manter este ambiente habilitado quando a loja estiver efetivamente vendendo

Ativar Yapay via Redirect: existem duas opções de carregamento do Yapay, opção de modal que carrega o Yapay sem sair da loja e Redirect que redireciona o cliente para realizar o pagamento na página do Yapay e retorna na finalização

Atenção: Após salvar as configurações, caso o módulo não fique disponível, será necessário alterar as configurações de cache.

OpenCart

Para disponibilizar o Yapay como facilitador de pagamento na plataforma OpenCart, basta baixar o pacote disponível no site institucional do Yapay, extrair a pasta com o módulo e enviar para sua loja.

Fique atento que sua versão de instalação OpenCart deve ser compatível com o módulo Yapay. As versões compatíveis são mostradas na pagina de download do módulo.

1- Instalação do Módulo OpenCart

Para instalar o módulo é necessário baixar o pacote através do link:

OpenCart

Descompacte o arquivo baixado e copie a pasta para o diretório raiz de sua instalação OpenCart, caso o sistema exiba a mensagem de mesclagem ou substituição de arquivos, clique em sim para todos.

Passos para instalação via FTP, utilizando o Filezilla:

  1. Enviar o conteúdo da pasta extraída para o servidor da loja virtual, utilizando um software FTP (neste exemplo utilizamos o Filezilla)

  2. Ao efetuar a conexão no FTP, no lado direito serão mostradas as pastas que estão dentro do servidor, acesse a pasta que está sua loja OpenCart

  3. Enviar as pastas extraídas (admin e catalog) do módulo Yapay para a pasta opencart, ou na raiz caso a instalação de sua loja esteja no webroot

Cuidado para não arrastar em cima de uma pasta, se isso acontecer você terá uma pasta dentro da outra e então este módulo não funcionará.

OpenCart, instalação

Segue a visualização dos diretórios da instalação OpenCart:

OpenCart, instalação

Após a conclusão do envio do módulo Yapay, acesse a administração do Opencart e entre na seção de “Formas de Pagamento” do menu Extensões.

Procurar pelo módulo “Yapay”, ele já deverá ser listado na consulta:

OpenCart, instalação

Será mostrado o módulo conforme a imagem abaixo. Clicar no botão install ou instalar (caso sua loja já esteja traduzida) no lado direito da listagem:

OpenCart, instalação

Após a instalação, será necessário habilitar e inserir dados de cadastro de sua conta para liberar os pagamentos em sua conta Yapay.

2- Configuração do Módulo OpenCart

Na página de Formas de Pagamento, clique em Edit (Editar) para acessar o módulo Yapay.

Será carregada a página do módulo com as opções de configuração abaixo:

OpenCart, instalação

Opções de configuração Tray Checkout:

Token: campo obrigatório gerado no painel de administração Yapay

Sufixo para o nº do pedido: campo opcional, utilizado para concatenar com o número do pedido da loja ao integrar com a Tray

Habilitar módulo Yapay: opção para habilitar/desabilitar o módulo na loja

Ambiente de Teste (Sandbox): ambiente utilizado pela loja para realizar testes de integração com o Yapay – muita atenção para não manter este ambiente habilitado quando a loja estiver efetivamente vendendo

Notificar alteração de status: campo utilizado para ativar/desativar a notificação de email para o cliente sobre as alterações de status

Região geográfica: restrição a regiões configuradas para sua loja OpenCart

Ordenação: opção para ordenar os módulos de pagamento habilitados

Por padrão, a OpenCart tem vários status para os pedidos, para trabalhar com o Yapay existem 5 que deverão ser selecionados conforme abaixo:

Status Processando: status posterior ao “aguardando pagamento”, indica que Yapay já recebeu o pedido e está processando

Status Processado: status que indica a aprovação do pedido, a partir deste status o produto/serviço deve ser enviado ou liberado para o cliente. É a confirmação do pagamento. Muita atenção para não trocar com o status PROCESSANDO

Status Cancelado: status que indica o cancelamento, reprovação ou não pagamento da transação no Yapay

Status Não Aprovado: status que indica que o pedido não obteve êxito no pagamento, por exemplo, um cartão expirado ou inválido

OsCommerce

Para disponibilizar o Yapay como facilitador de pagamento na plataforma OsCommerce, basta baixar o pacote disponível no site institucional do Yapay, extrair a pasta com o módulo e enviar para sua loja.

Fique atento que sua versão de instalação OsCommerce deve ser compatível com o módulo Yapay.

1- Instalação do Módulo OsCommerce

Para instalar o módulo é necessário baixar o pacote através do link abaixo:

OsCommerce

Descompacte o arquivo baixado e copie as pastas e arquivos para o diretório raiz de sua instalação do OsCommerce, caso o sistema exiba a mensagem de mesclagem ou substituição de arquivos, clique em sim para todos.

Passos para instalação via FTP, utilizando o WinSCP:

  1. Enviar o conteúdo da pasta extraída para o servidor da loja virtual, utilizando um software FTP (neste exemplo utilizamos o WinSCP)

  2. Ao efetuar a conexão no FTP, no lado direito serão mostradas as pastas que estão dentro do servidor, acesse a pasta que está sua loja OsCommerce

  3. Enviar as pastas e arquivos extraídos (pastas ext e includes e arquivo checkout_Yapay.php) do módulo Yapay para a pasta raiz da instalação de sua loja OsCommerce

Cuidado para não arrastar em cima de uma pasta, se isso acontecer você terá uma pasta dentro da outra e então este módulo não funcionará.

OsCommerce, instalação

Segue a visualização dos diretórios da instalação do OsCommerce:

OsCommerce, instalação

Após a conclusão do envio do módulo Yapay, acesse a administração do OsCommerce e entre na seção de Pagamentos do menu Módulos, onde será localizado o módulo Yapay.

OsCommerce, instalação

Clique na opção do módulo Yapay onde será mostrado o módulo conforme a imagem abaixo. Ative o módulo clicando em Instalar no lado direito da listagem:

OsCommerce, instalação

O próximo passo é configurar o módulo (veja o item 2), inserindo os dados de cadastro de sua conta para liberar os pagamentos em sua conta Yapay.

2- Configuração do Módulo OsCommerce

Para a configuração do módulo, acesse o menu Módulos > Pagamento, e selecione a opção Yapay, onde será exibido o botão Editar.

Ao clicar no botão Editar, serão listadas todas as informações para a configuração do módulo, onde poderá localizar o Token na área administrativa do Yapay, no menu Perfil da Conta > Minha Conta > Dados da Conta.

Segue abaixo imagem com as opções para a configuração do módulo:

OsCommerce, instalação

Opções de configuração do módulo Yapay:

Yapay: opção para habilitar o Yapay na finalização de compra

Token: chave gerada no seu painel de administração do Yapay

Tipo de Integração três opções de exibição do Yapay, onde:

  • REDIRECT: O consumidor é redirecionado para o ambiente do Yapay para finalização da transação

  • FRAME: O Yapay é aberto dentro da loja virtual, possibilitando o comprador finalizar a compra sem sair da loja

  • MODAL: Ao finalizar a compra, o Yapay será exibido sobre a loja virtual, sem o consumidor sair do ambiente da loja