VibeFox CCAvenue for WooCommerce — Ajuda
Requisitos
WordPress: 5.8 ou superior.
WooCommerce: 6.0 ou superior, instalado e ativo. O plugin se recusa a ser ativado sem ele.
PHP: 8.0 ou superior, com a extensão OpenSSL (usada para criptografar a requisição e descriptografar a resposta).
Conta CCAvenue: você precisa de uma conta de comerciante da CCAvenue com Merchant ID, Access Code e Working Key. O Access Code e a Working Key são emitidos para um domínio de site, então gere-os para o domínio desta loja. A CCAvenue usa as mesmas credenciais no ambiente de teste; o acesso de teste precisa ser habilitado na sua conta pela CCAvenue. O plugin usa os endpoints da CCAvenue Índia.
Moeda: a moeda do pedido é enviada à CCAvenue como está. As contas da CCAvenue aceitam INR por padrão; outras moedas exigem processamento multimoeda na sua conta CCAvenue.
Chave de licença VibeFox: comprada em vibefox.net. Uma chave funciona em um 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_ccavenue_payment para /wp-content/plugins/ por FTP.
2. Clique em Activate.
3. Abra as configurações: WooCommerce > Settings > Payments > CCAvenue > Manage, ou clique em Settings abaixo do nome do plugin na página Plugins.
4. Insira a sua chave de licença VibeFox no bloco de licença no topo da página e clique em Activate.
5. Insira o Merchant ID, o Access Code e a Working Key do seu painel da CCAvenue e ative Enable/Disable.
6. Mantenha o Test mode ativado durante os testes e, depois, desative-o para receber pagamentos reais.
Configuração
Todas as configurações estão em uma única página: WooCommerce > Settings > Payments > CCAvenue. Acima dos campos, a página avisa quando a CCAvenue está ativada, mas falta o Merchant ID, o Access Code ou a Working Key (o método de pagamento fica então oculto na finalização de compra até que os três estejam preenchidos), mostra CCAvenue test mode is on: customers are sent to test.ccavenue.com and no real money is taken. enquanto o modo de teste estiver ativado, e lembra do processamento multimoeda quando a moeda da loja não é INR.
Geral
Enable/Disable: Enable CCAvenue Payment Gateway ativa ou desativa o método de pagamento. Padrão: desativado.
Title: o nome do método de pagamento que o cliente vê na finalização de compra. Padrão: CCAvenue.
Description: o texto exibido abaixo do método de pagamento na finalização de compra. Padrão: Pay securely via Credit/Debit card, Net Banking, UPI or Wallet through CCAvenue.
Credenciais de API
Faça login no painel de comerciante da CCAvenue (M.A.R.S.) e abra Settings > API Keys. Gere o Access Code e a Working Key para o domínio desta loja. Espaços nas credenciais são removidos ao salvar.
Merchant ID: o seu Merchant ID numérico da CCAvenue. Se ele contiver algo além de dígitos, um erro é mostrado ao salvar e o valor salvo anteriormente é mantido.
Access Code: o Access Code deste site.
Working Key: a Working Key (chave de criptografia) deste site. Ela criptografa a requisição de pagamento e é a única forma de verificar a resposta da CCAvenue, então mantenha-a em segredo.
Test mode: Send customers to the CCAvenue test environment (test.ccavenue.com). A CCAvenue usa o mesmo Merchant ID, Access Code e Working Key para teste e produção; o acesso de teste precisa ser habilitado na sua conta pela CCAvenue. No modo de teste, a finalização de compra mostra TEST MODE: no real transactions will be processed. Padrão: ativado. Desative para pagamentos reais.
URL de retorno
A CCAvenue devolve o cliente ao endereço exibido nesta seção. Ele tem a forma https://your-site/wc-api/ccavenue_p_callback/. O plugin envia esta URL em cada pagamento, então não há nada para configurar na CCAvenue. Ela deve pertencer ao domínio registrado na CCAvenue.
Avançado
Debug log: Log CCAvenue events grava IDs de pedido, referências da CCAvenue e status em WooCommerce > Status > Logs, origem wcp_ccavenue_payment. Chaves, dados de cartão e endereços não são registrados. Padrão: desativado.
Delete data on uninstall: Remove the plugin settings, logs and CCAvenue order references when the plugin is deleted. Desativar o plugin nunca apaga nada. Padrão: desativado.
Finalização de compra
O cliente escolhe o método de pagamento (por padrão, CCAvenue) e faz o pedido. A página Pay for order mostra Thank you for your order. You are being redirected to CCAvenue to complete the payment. e envia o cliente à página de pagamento da CCAvenue. Sem JavaScript, o cliente clica em Pay via CCAvenue ou Cancel order. Cada tentativa recebe uma nova referência de pedido da CCAvenue. O total e a moeda do pedido, os dados de cobrança e de entrega e a chave do pedido são enviados na requisição criptografada. Nomes e endereços são ajustados aos caracteres e tamanhos que a CCAvenue aceita; país e estado são enviados como nomes, e o telefone como dígitos.
Depois do pagamento, a CCAvenue devolve o cliente com uma resposta criptografada. O pedido só é marcado como pago depois que a CCAvenue confirma: a resposta precisa descriptografar com a sua Working Key, pertencer a este pedido e trazer o mesmo valor e moeda do pedido. Em seguida, o cliente chega à página de pedido recebido.
Se o pagamento falhar, o cliente volta à finalização de compra com Payment was not completed. Please try again or choose a different payment method. Se o cliente cancelar na página da CCAvenue, a mensagem é Payment was cancelled. You may try again. Se a resposta não puder ser verificada, a mensagem é We could not confirm the payment result. If your account was charged, please contact us before paying again. O cliente pode pagar novamente um pedido não pago, por exemplo pela página Pay for order. Se o pagamento foi iniciado pela página Pay for order e o carrinho está vazio, o WooCommerce mostra a mensagem na página do carrinho; um pedido falho pode ser pago de novo em My account > Orders.
O método de pagamento funciona na finalização de compra clássica, no bloco de Finalização de compra e na página Pay for order. É compatível com o armazenamento de pedidos de alto desempenho do WooCommerce (HPOS). Os textos exibidos ao cliente são traduzidos para o hindi.
O resultado é obtido somente pelo retorno do cliente da CCAvenue: não há notificações de servidor para servidor nem consultas de status. Se o cliente fechar o navegador antes de voltar, o pedido permanece com o status Pending payment. O plugin não tem reembolsos pelo WooCommerce, cartões salvos, assinaturas ou pagamentos recorrentes, nem iframe ou formulário de cartão no site, e não oferece suporte à CCAvenue UAE nem a outras plataformas regionais.
Pedidos
Status do pedido
Pending payment: o cliente foi enviado à CCAvenue e ainda não voltou. Verifique o pagamento no painel da CCAvenue se o cliente não retornar.
Processing: o pagamento foi confirmado (pedidos apenas com produtos virtuais para download passam a Concluído, o padrão do WooCommerce). A nota do pedido mostra a referência bancária, o ID de rastreamento da CCAvenue e o modo de pagamento. O ID da transação do pedido é o ID de rastreamento da CCAvenue.
On hold, amount/currency mismatch: a CCAvenue confirmou um pagamento cujo valor ou moeda difere do pedido, por exemplo porque o pedido foi editado depois que o cliente começou a pagar ou porque uma oferta de desconto da CCAvenue foi aplicada. A nota mostra o valor recebido e o esperado. Verifique o pagamento no painel da CCAvenue e, depois, conclua ou reembolse o pedido.
On hold, awaiting bank confirmation: a CCAvenue informou o pagamento como Awaited. O pedido nunca é marcado como falho enquanto o dinheiro ainda pode ser capturado. Verifique no painel da CCAvenue antes de atender o pedido e altere o status manualmente. Uma resposta posterior com o mesmo ID de rastreamento ainda é aplicada.
On hold, payment for a cancelled order: o cliente pagou depois que o pedido havia sido cancelado. Confira o estoque e atenda ou reembolse o pedido.
Cancelled: o cliente interrompeu o pagamento na página da CCAvenue.
Failed: o pagamento falhou, ou a CCAvenue retornou Invalid, Timeout ou outro status sem sucesso. A nota do pedido mostra a mensagem da CCAvenue. Uma falha tardia nunca altera um pedido pago.
Se chegar outro pagamento bem-sucedido para um pedido que já está pago (por exemplo, a partir de duas abas do navegador), o pedido não é alterado novamente. Uma nota pede que você reembolse a cobrança duplicada no painel da CCAvenue.
Reembolsos: reembolsos pelo WooCommerce não são suportados. Reembolse o pagamento no painel da CCAvenue e registre-o manualmente no WooCommerce.
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 > CCAvenue. 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 em vibefox.net.
Uma chave funciona em um domínio. Remover a chave de um site não libera a vaga do domínio. Libere a vaga na sua conta em vibefox.net.
Sem uma chave ativa, a CCAvenue não é mostrada 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. Gerentes da loja logados ainda veem o método de pagamento, marcado como (unlicensed — visible to admins only), para que você possa configurar e testar o plugin antes de comprar uma chave. Um lembrete aparece na página Plugins e nas páginas do WooCommerce. Pedidos existentes não são afetados: clientes que retornam de pagamentos já iniciados continuam sendo processados.
Quando uma licença expira, o plugin continua funcionando, mas atualizações e suporte precisam de renovação. O status é verificado novamente automaticamente, em segundo plano.
Solução de problemas
A CCAvenue não aparece na finalização de compra: verifique se a licença está ativa, se Enable/Disable está ativado e se as três credenciais estão preenchidas: Merchant ID, Access Code e Working Key. A página de configurações mostra um aviso quando alguma está faltando.
O pagamento foi feito, mas o pedido continua com o status Pending payment: o cliente não voltou da CCAvenue para a sua loja, por exemplo porque fechou o navegador. O plugin não tem notificações de servidor para servidor. Verifique o pagamento no painel da CCAvenue e atualize o pedido manualmente.
Todo pagamento termina com We could not confirm the payment result: a resposta não pode ser descriptografada. A Working Key está errada, pertence a outro domínio ou foi copiada com caracteres extras. Gere as chaves para o domínio desta loja e cole-as novamente. Ative o Debug log e consulte WooCommerce > Status > Logs, origem wcp_ccavenue_payment.
A CCAvenue mostra um erro antes da página de pagamento: verifique se o Access Code e a Working Key foram gerados para este domínio, se a URL de retorno pertence ao domínio registrado na CCAvenue e, no modo de teste, se a CCAvenue habilitou o acesso de teste na sua conta. Para uma moeda diferente de INR, o processamento multimoeda precisa estar habilitado na sua conta CCAvenue.
O cliente vê This payment method is temporarily unavailable: uma das credenciais está ausente.
O cliente vê Payment gateway error: encryption failed: a requisição não pôde ser criptografada. Verifique se a extensão OpenSSL do PHP está instalada.
O pedido está On hold após o pagamento: leia a nota do pedido. O valor ou a moeda pagos eram diferentes do pedido, o pagamento aguarda confirmação bancária, ou o pedido havia sido cancelado. Verifique o pagamento no painel da CCAvenue e, depois, atenda o pedido ou reembolse o pagamento.
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 em 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 não puder ser acessado, o plugin continua funcionando com o último status conhecido.
Para desenvolvedores, o readme lista o filtro ccavenue_p_request_params (altera os dados enviados à CCAvenue, por exemplo merchant_param2 a merchant_param5 ou promo_code; não altere amount, currency, order_id nem merchant_param1) e o filtro ccavenue_p_icon, para o ícone da finalização de compra.
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, os logs e as referências da CCAvenue armazenadas nos pedidos são removidos somente se Delete data on uninstall estava ativado. Caso contrário, permanecem para uma reinstalação futura. Pedidos existentes mantêm suas notas de pagamento e IDs de transação.
A CCAvenue é uma marca registrada de seu respectivo titular. Este plugin não é afiliado nem endossado pela CCAvenue.