VibeFox eWAY for WooCommerce — Ajuda
Requisitos
WordPress: 6.0 ou superior.
WooCommerce: 8.0 ou superior, instalado e ativo.
PHP: 8.0 ou superior.
Moeda da loja: AUD, NZD, SGD, HKD ou MYR. Para outras moedas, o método de pagamento fica oculto na finalização de compra. O pedido é cobrado na sua própria moeda.
Conta eWAY: você precisa de uma conta de comerciante no eWAY com acesso à API Rapid e da sua chave e senha da API Rapid, obtidas no MyeWAY em Settings, API Key. Para testes, você precisa de uma conta sandbox do eWAY com chave e senha próprias. As chaves de teste e de produção são diferentes. Não é preciso configurar nada no eWAY: a URL de retorno é enviada com cada pagamento.
Chave de licença VibeFox: comprada em vibefox.net. Uma chave funciona em um único domínio.
Instalação
1. No WordPress, acesse Plugins > Add New > Upload Plugin, escolha o arquivo ZIP do plugin e clique em Install Now. Você também pode enviar a pasta wcp_eway_payment_gateway para /wp-content/plugins/ por FTP.
2. Clique em Activate.
3. Abra as configurações: WooCommerce > Settings > Payments > eWAY > Manage, ou clique em Settings abaixo do nome do plugin na página de Plugins.
4. Insira sua chave de licença VibeFox no bloco de licença no topo da página e clique em Activate.
5. Insira sua chave e senha de API sandbox, mantenha Sandbox Mode ativado, ative Enable/Disable e faça um pedido de teste com o cartão de teste do eWAY 4444333322221111.
6. Insira sua chave e senha de API de produção, desmarque Sandbox Mode e salve.
Configuração
Todas as configurações ficam em uma única página: WooCommerce > Settings > Payments > eWAY. Acima dos campos, um selo indica o modo: SANDBOX (os pagamentos vão para o sandbox do eWAY e nenhum valor real é cobrado) ou LIVE (os pagamentos reais são processados com a chave de API de produção). A página avisa quando a chave ou a senha de API do modo atual estão ausentes (nesse caso, o gateway não aparece na finalização de compra) e quando a moeda da loja não é suportada. Na lista de métodos de pagamento, o eWAY aparece como pendente de configuração até que o modo atual tenha credenciais, e exibe um selo de modo de teste no modo sandbox.
Geral
Enable/Disable: Enable eWAY Payment Gateway ativa ou desativa o método de pagamento. Padrão: desativado.
Title: o nome do método de pagamento que os clientes veem na finalização de compra. Padrão: Credit Card (eWAY).
Description: o texto exibido abaixo do método de pagamento na finalização de compra. Padrão: Pay securely using your credit card via eWAY. You will be redirected to the eWAY secure payment page.
Credenciais de API
A chave e a senha da API Rapid estão no MyeWAY, em Settings, API Key. O eWAY tem guias para as chaves de produção e de sandbox, vinculados nesta seção. Sandbox e produção usam chaves diferentes.
Sandbox Mode: Enable sandbox (test) mode envia os pagamentos para o sandbox do eWAY com a chave de sandbox. Nenhum valor real é cobrado. Padrão: ativado. Desmarque para receber pagamentos reais com a chave de produção.
Live API Key: a chave da API Rapid da sua conta eWAY de produção.
Live API Password: a senha da API Rapid da sua conta eWAY de produção.
Sandbox API Key: a chave da API Rapid da sua conta sandbox (partner/developer) do eWAY.
Sandbox API Password: a senha da API Rapid da sua conta sandbox do eWAY.
Pedidos
Order Status on Success: o status do pedido assim que o eWAY confirma o pagamento.
Avançado
Debug log: Enable logging registra as chamadas à API e os resultados de pagamento em WooCommerce > Status > Logs, origem wcp_eway_payment_gateway. Dados de cartão e chaves não são registrados. Erros são sempre registrados. Padrão: desativado.
Uninstall: Delete all plugin data on uninstall. Quando marcado, as configurações do gateway e seus logs são removidos ao excluir o plugin. As referências de pagamento salvas nos pedidos são mantidas. Padrão: desativado.
Finalização de compra
O cliente escolhe o método de pagamento (por padrão Credit Card (eWAY)) e faz o pedido. O plugin solicita ao eWAY uma página de pagamento para o valor total do pedido na moeda do pedido, com o ID do pedido como referência da fatura e os dados de cobrança do cliente, e envia o cliente para a Responsive Shared Page do eWAY. Lá o cliente paga com cartão. O pagamento é capturado imediatamente.
Depois de pagar, o cliente volta para a sua loja. O plugin não confia no navegador: ele consulta o eWAY, de servidor para servidor, o resultado da página de pagamento criada para este pedido. O pedido só é marcado como pago depois que o eWAY confirma e o valor e a moeda aprovados correspondem ao pedido. Então o cliente chega à página de pedido recebido. Se o eWAY não pôde ser consultado naquele momento, o pedido permanece em «Pagamento pendente» e a página exibe We have not received the confirmation of your payment from eWAY yet. If you completed the payment, this order will be updated shortly — please do not pay again. O pagamento é verificado novamente ao abrir a página de pedido recebido e antes de o WooCommerce cancelar automaticamente o pedido não pago.
Se o pagamento for recusado, o cliente volta para a finalização de compra (ou para a página Pay for order) com o motivo, por exemplo Your payment was declined: Insufficient funds. Please try again or use a different payment method. Se o cliente clicar em Cancel na página do eWAY, o plugin primeiro confere com o eWAY que nada foi pago. Um pedido feito na finalização de compra é então cancelado, e um pedido pago pela página Pay for order permanece não pago. O cliente vê You cancelled the payment on the eWAY page. Your order has not been paid — you can try again. Se o pagamento não foi concluído, a mensagem é The payment was not completed. Please try again.
Um cliente pode pagar novamente um pedido não pago. Cada página de pagamento do pedido é rastreada, portanto um pagamento feito por uma página anterior também é reconhecido. Se o eWAY não conseguir criar a página de pagamento, o cliente vê uma mensagem curta, por exemplo Payment error: Unable to connect to eWAY. Please try again.
O método de pagamento funciona na finalização de compra clássica, no bloco de Finalizar compra e na página Pay for order. É compatível com o High-Performance Order Storage (HPOS) do WooCommerce.
O eWAY não envia notificações de servidor para servidor para a Shared Page: o resultado é obtido quando o cliente retorna e nas verificações descritas acima. O plugin não tem campos de cartão no seu site, cartões salvos ou assinaturas, nem autorização sem captura seguida de captura, e não avalia as pontuações de fraude da Beagle (transações bloqueadas pelas regras antifraude do eWAY são recusadas pelo próprio eWAY).
Pedidos e reembolsos
Status do pedido
Pending payment: o cliente foi enviado ao eWAY e ainda não pagou, ou o resultado ainda não pôde ser obtido do eWAY (a nota do pedido indica isso).
Processing or Completed: o pagamento foi aprovado. O status segue Order Status on Success. A nota do pedido mostra o ID da transação no eWAY, o código de autorização e a resposta. O ID da transação do pedido é o ID da transação no eWAY.
On hold after payment: o eWAY aprovou um valor ou uma moeda diferentes do pedido (por exemplo Approved for partial amount, ou o pedido foi editado depois que o cliente abriu a página de pagamento), ou o pagamento foi aprovado depois que o pedido já havia sido cancelado. A nota explica isso. Na página de pedido recebido, o cliente vê Your payment was received and is being reviewed by the store. We will contact you if anything is needed. Conclua o pedido ou reembolse o pagamento.
Failed: o eWAY recusou o pagamento. A nota mostra o código do eWAY e o seu significado.
Cancelled: o cliente cancelou na página do eWAY depois de fazer o pedido na finalização de compra, ou o pedido foi cancelado por você ou pelo tempo limite de retenção de estoque do WooCommerce, depois que o eWAY confirmou que não havia sido pago.
Se um segundo pagamento for aprovado para um pedido que já está pago, o pedido não muda. Uma nota pede que você reembolse a duplicata no MyeWAY.
Reembolsos
Abra o pedido, clique em Refund, informe o valor e clique em Refund via Credit Card (eWAY) (o botão usa o título do método de pagamento). Reembolsos totais e parciais são suportados. O reembolso é enviado no ambiente em que o pagamento foi feito (sandbox ou produção), por isso a chave e a senha de API desse ambiente precisam estar configuradas. Se o eWAY recusar o reembolso, o WooCommerce mostra o código do eWAY e nenhum reembolso é registrado. Um reembolso bem-sucedido é adicionado às notas do pedido com o ID da transação de reembolso do eWAY.
Reembolsos feitos no MyeWAY não são sincronizados com o WooCommerce. Se necessário, crie um reembolso manual no WooCommerce sem usar o botão de reembolso do eWAY.
Chave de licença
O plugin funciona com uma chave de licença VibeFox obtida em vibefox.net. O bloco de licença fica no topo de WooCommerce > Settings > Payments > eWAY. Cole a chave em License key e clique em Activate. O bloco mostra o status, por exemplo a data até a qual a licença está ativa, e o seu domínio. Use Check now para verificar o status novamente, Change key para inserir outra chave e Remove key para removê-la deste site. O link Manage licenses and domains in your account abre a sua conta na vibefox.net.
Uma chave funciona em um único domínio. Remover a chave de um site não libera a vaga de domínio. Libere a vaga na sua conta na vibefox.net.
Sem uma chave ativa, o eWAY não é exibido aos clientes na finalização de compra. Se um pagamento for iniciado mesmo assim, o cliente vê This payment method is not available. Please choose another one. Os gerentes da loja conectados continuam vendo o método de pagamento, marcado como (unlicensed — visible to admins only), para que possam configurar e testar o plugin antes de comprar uma chave. Um lembrete aparece na página de Plugins e nas páginas do WooCommerce. Os pedidos existentes não são afetados: pagamentos já iniciados continuam sendo confirmados e os reembolsos funcionam.
Quando uma licença expira, o plugin continua funcionando, mas atualizações e suporte exigem renovação. O status é verificado novamente, automaticamente, em segundo plano.
Solução de problemas
eWAY does not appear at checkout: verifique se a licença está ativa, se Enable/Disable está ativado, se a chave e a senha de API do modo atual estão preenchidas (campos sandbox no modo sandbox, campos de produção no modo de produção) e se a moeda da loja é AUD, NZD, SGD, HKD ou MYR. Na página Pay for order, a moeda do pedido é verificada.
The payment went through, but the order stays Pending payment: o cliente não voltou do eWAY, ou o eWAY não pôde ser consultado naquele momento. O eWAY não envia notificações para a Shared Page. O pagamento é verificado novamente ao abrir a página de pedido recebido e antes de o WooCommerce cancelar o pedido não pago. Confira a transação no MyeWAY e veja em WooCommerce > Status > Logs, origem wcp_eway_payment_gateway.
O cliente vê a mensagem This payment method is temporarily unavailable: a chave ou a senha de API do modo atual estão ausentes, ou o eWAY as recusou. Verifique as credenciais do modo atual.
O cliente vê a mensagem eWAY could not start the payment: o eWAY retornou códigos de erro, exibidos na mensagem. Muitas vezes os dados de cobrança são inválidos.
O cliente vê a mensagem We could not match this payment to an order: o link de retorno não pertence a nenhum pedido desta loja. Se o cliente foi cobrado, procure o pagamento no MyeWAY.
O cliente vê a mensagem We could not confirm your payment with eWAY: o resultado do pagamento não pôde ser verificado. O pedido é atualizado quando o resultado for obtido; o cliente não deve pagar novamente.
Order is On hold after payment: leia a nota do pedido. O valor ou a moeda aprovados eram diferentes do pedido, ou o pagamento chegou depois que o pedido foi cancelado. Conclua o pedido ou reembolse o pagamento.
O reembolso falha com uma mensagem sobre o modo sandbox ou produção: o pedido foi pago nesse ambiente, e a chave e a senha de API dele não estão preenchidas. Informe-as e tente novamente.
O bloco de licença mostra um erro: siga a mensagem exibida no bloco. Por exemplo, se a chave já estiver em uso em outro domínio, libere uma vaga na sua conta na vibefox.net e clique em Check now. Se o endereço do site mudou, clique em Check now para ativar a chave no novo domínio. Se o servidor de licenças estiver inacessível, o plugin continua funcionando com o último status conhecido.
Para desenvolvedores, o readme lista o filtro eway_p_supported_currencies, caso a sua conta eWAY esteja habilitada para mais moedas.
Desinstalação
Desativar o plugin mantém todos os dados. Para removê-lo, desative-o e exclua-o na página Plugins. A chave de licença e o status de licença deste plugin são sempre removidos. As configurações do gateway e os logs são removidos apenas se a opção Uninstall (Delete all plugin data on uninstall) estiver ativada. Caso contrário, eles são mantidos para uma futura reinstalação. As referências de pagamento salvas nos pedidos são sempre mantidas. Os pedidos existentes mantêm suas notas de pagamento e IDs de transação.
O eWAY é uma marca registrada de seu respectivo titular. Este plugin não é afiliado ao eWAY nem endossado por ele.