Pular para o conteúdo principal
Versão: 1.x

Gateway de terminal Windcave

O gateway de terminal Windcave permite receber pagamentos presenciais com cartão em um terminal Windcave por meio do Windcave HIT. Os pagamentos são iniciados no WCPOS e concluídos no terminal, e a confirmação é registrada no pedido do WooCommerce.

Novo na versão 0.1.0 — aguardando certificação da Windcave

A versão 0.1.0 é o primeiro lançamento. A Windcave exige a certificação de QA de uma integração antes que ela seja usada em produção, e esta integração ainda não foi certificada. Use credenciais UAT (teste) da Windcave até a conclusão da certificação. O Vendor ID é fornecido pela Windcave durante a certificação.

Recursos​

Conexão HIT na nuvem

Conecte-se pelo serviço HIT na nuvem da Windcave, com um Station ID por terminal e sem pareamento local

Instruções do terminal na tela

Acompanhe as instruções e os botões do terminal no painel de pagamento, incluindo YES/NO para verificação de assinatura e CANCEL

Conclusão verificada

Os pedidos só são concluídos após a verificação da referência de pagamento, do valor, do ambiente, do total do pedido e da moeda

Deixar um pagamento de lado

Após um tempo limite, deixe o pagamento pendente de lado e continue trabalhando enquanto uma verificação em segundo plano o acompanha

Notificações de resultado

Ative as notificações de resultado opcionais (FPRN) para que a Windcave possa notificar seu site como alternativa à consulta periódica

Como funciona​

O gateway usa o Windcave HIT (Host Initiated Transaction) por HTTPS. Environment seleciona o endpoint de UAT ou de produção, e cada terminal é identificado pelo Station ID fornecido pela Windcave.

Ao iniciar um pagamento, o total do pedido e a moeda são enviados ao terminal. A página de pagamento consulta a Windcave a cada 1,5 segundo, reproduzindo na tela as instruções e os botões disponíveis no terminal. As notificações de resultado (FPRN) opcionais permitem que a Windcave notifique o site como alternativa à consulta periódica.

Configuração​

1

Instalar Windcave Terminal for WooCommerce

Baixe o arquivo zip do plugin (não o zip do código-fonte do GitHub) na página de lançamentos do GitHub. Envie-o por Plugins > Adicionar novo > Enviar plugin e ative-o com o WooCommerce instalado e ativo.

A ativação requer PHP 7.4+ e a extensão PHP DOM (php-xml). Se algum deles estiver ausente, uma mensagem impedirá a ativação.

2

Obter credenciais HIT da Windcave

Peça à Windcave um HIT username, uma HIT key e um Station ID para cada terminal. Solicite uma conta de desenvolvimento pelo formulário de requisitos de integração da Windcave.

As credenciais de UAT e de produção são diferentes. Use as credenciais de UAT enquanto esta integração aguarda a certificação.

3

Configurar o gateway

  1. Acesse WP Admin > WooCommerce > Configurações > Pagamentos e abra Windcave Terminal
  2. Defina Environment como UAT (testing) (o padrão). Use Production somente após a certificação da Windcave, com credenciais de produção
  3. Insira o HIT username e a HIT key fornecidos pela Windcave
  4. Insira seus Station IDs, um por linha
  5. (Opcional) Defina um Default Station ID. Ative Lock terminal selection para usar sempre esse padrão e impedir que os caixas o alterem
  6. Deixe Vendor ID vazio até que a Windcave forneça um durante a certificação
  7. Salve suas configurações
4

Ativar notificações de resultado (opcional)

Ative Result notifications (FPRN) e salve para solicitar que a Windcave notifique seu site quando o resultado de uma transação estiver pronto. Essa é uma alternativa à consulta periódica.

5

Ativar no WCPOS

  1. Acesse WP Admin > POS > Configurações > Finalização de compra
  2. Localize o gateway Windcave Terminal e ative-o para o POS
  3. Salve suas configurações
nota

A caixa de seleção Enable/Disable na tela de configurações do WooCommerce controla apenas o checkout da loja virtual. O WCPOS usa este gateway depois de configurado, independentemente de essa caixa estar marcada.

Referência das configurações​

ConfiguraçãoO que faz
Enable/DisableAtiva o gateway para o checkout da loja virtual. A ativação no POS é controlada em POS > Configurações > Finalização de compra
TitleO rótulo exibido no checkout; o padrão é Windcave Terminal
DescriptionA descrição exibida no checkout; o padrão é Pay in person on the Windcave terminal.
EnvironmentUAT (testing) (padrão) ou Production. Cada ambiente usa credenciais HIT diferentes; a produção exige certificação da Windcave
HIT usernameO HIT username fornecido pela Windcave para o ambiente selecionado
HIT keyA HIT key fornecida pela Windcave para o ambiente selecionado
Station IDsUm Station ID fornecido pela Windcave por linha, um para cada terminal
Default Station IDO Station ID pré-selecionado, também usado quando nenhum Station ID é selecionado
Lock terminal selectionUsa sempre o Station ID padrão para impedir alterações pelos caixas. Só tem efeito quando um valor padrão está definido
Vendor IDFornecido pela Windcave durante a certificação. Deixe vazio até que a Windcave o forneça
POS nameO nome enviado à Windcave para identificar o POS; o padrão é WCPOS
Result notifications (FPRN)Solicita que a Windcave notifique o site quando o resultado de uma transação estiver pronto, como alternativa à consulta periódica. Desativado por padrão
Checkout logsExibe ferramentas de registro no painel de pagamento. Desativado por padrão
Log levelOff, Errors only ou Debug. O padrão é Debug, que registra solicitações e respostas com chaves e dados do cartão ocultados
SupportDisponibiliza Download support bundle e um link para visualizar os registros em WooCommerce > Status > Logs

Não há um botão para testar a conexão: as credenciais e os Station IDs são verificados quando o primeiro pagamento é processado.

Uso​

Processamento de pagamentos​

  1. Adicionar itens: adicione produtos ao carrinho no POS
  2. Selecionar gateway: escolha Windcave Terminal como forma de pagamento
  3. Escolher terminal: selecione um Station ou use o padrão bloqueado. A seleção é obrigatória quando há dois ou mais Stations e nenhum padrão definido
  4. Iniciar pagamento: clique em Start Terminal Payment para enviar o total do pedido ao terminal
  5. Acompanhar instruções: as instruções e os botões disponíveis no terminal aparecem na tela, incluindo YES/NO para verificação de assinatura e CANCEL quando disponível
  6. Conclusão automática: após a aprovação e a verificação, o pedido é concluído e o POS exibe o recibo

Controles de pagamento​

  • Start Terminal Payment: envia uma nova solicitação de pagamento ao Station selecionado
  • Cancel Terminal Payment: pressiona o botão CANCEL do terminal quando disponível. Caso contrário, cancele no terminal ou deixe o pagamento de lado quando essa opção aparecer
  • Deixar pagamento de lado: aparece após o tempo limite de 5 minutos. A tentativa fica sujeita a uma verificação em segundo plano de 10 minutos, permitindo que você receba o pagamento de outra forma; isso não cancela o pagamento na Windcave
  • Recarregar a página: retoma um pagamento já em andamento

Recibos​

O texto do recibo do terminal, quando fornecido pela Windcave, é salvo como uma nota privada do pedido no WooCommerce.

Reembolsos​

Reembolsos pelo WooCommerce não são compatíveis na versão 0.1.0. Faça o reembolso no portal da Windcave (Payline) ou no terminal e, em seguida, registre-o manualmente no WooCommerce.

Registros e pacote de suporte​

Encontre os registros em WooCommerce > Status > Logs, na origem windcave-terminal. O nível de registro padrão é Debug, que registra solicitações e respostas da Windcave com chaves e dados do cartão ocultados.

Clique em Download support bundle na tela de configurações do gateway para baixar um arquivo .json e envie-o com o número do pedido. Ele contém detalhes do ambiente, configurações com a HIT key e o username ocultados, tentativas de pagamento de até 20 pedidos recentes sem os recibos e as últimas 1.000 linhas dos dois arquivos de registro mais recentes; as linhas podem incluir texto de recibos do terminal com números de cartão ocultados.

Se o WooCommerce usar o manipulador de registros do banco de dados, o pacote não conterá linhas de registro. Exporte os registros em WooCommerce > Status > Logs.

Ative Checkout logs para exibir ferramentas de registro no painel de pagamento.

Requisitos​

Conta Windcave: HIT username, HIT key e um Station ID por terminal; o uso em produção exige certificação da Windcave
Hardware compatível: Um terminal Windcave que use HIT
WCPOS: É necessária a versão Pro para fazer checkout no POS
Servidor: WordPress 5.2+, WooCommerce e PHP 7.4+ com a extensão DOM (php-xml)
Moeda: Uma moeda com duas casas decimais
Conexão estável: Conexão confiável com a internet para comunicação com a API

Escopo e limitações​

Certificação obrigatória

Esta integração ainda não foi certificada pela Windcave. Use credenciais UAT até a conclusão da certificação de QA da Windcave; não a use em produção antes da certificação.

  • Reembolsos pelo WooCommerce não são compatíveis na versão 0.1.0
  • Gorjetas, sobretaxas e retirada de dinheiro não são compatíveis
  • Só há suporte para moedas com duas casas decimais
  • O terminal cobra o valor total do pedido; não é possível pagar apenas parte do pedido no terminal
  • Os Station IDs são inseridos manualmente; os terminais não são detectados automaticamente
  • O gateway foi desenvolvido para o POS. Na loja virtual, só funciona na página de pagamento do pedido

Solução de problemas​

Problemas comuns​

Ativação recusada: é necessária a extensão PHP DOM (php-xml)
  • A extensão PHP DOM está ausente no servidor
  • Peça ao seu provedor de hospedagem para ativar php-xml. A ativação também requer PHP 7.4+
Nenhum Station ID configurado
  • A configuração Station IDs está vazia
  • Adicione nas configurações do gateway os Station IDs fornecidos pela Windcave, um por linha, e salve
As credenciais HIT da Windcave não estão configuradas
  • O HIT username ou a HIT key está vazio
  • Insira ambos nas configurações do gateway e salve. Confira se Environment corresponde a essas credenciais
O terminal ainda está concluindo uma transação anterior
  • Ainda há uma transação anterior em andamento nesse Station
  • Conclua ou cancele a transação no terminal e tente novamente
A Windcave não tem registro desta transação
  • A Windcave ainda não tem registro após o período de tolerância inicial de 30 segundos
  • Inicie o pagamento novamente
A Windcave aprovou um pagamento, mas ele não pôde ser aplicado
  • O resultado aprovado não passou nas verificações necessárias para concluir este pedido
  • Confira o portal da Windcave e as notas do pedido antes de cobrar novamente
Este pagamento foi iniciado em outro ambiente
  • Environment foi alterado enquanto o pagamento estava em andamento
  • Volte ao ambiente em que o pagamento foi iniciado ou confira o portal da Windcave

Como obter ajuda​

  • Envie o pacote de suporte da tela de configurações do gateway junto com o número do pedido
  • Acesse o repositório do GitHub para relatar problemas
  • Entre em contato com o suporte da Windcave para dúvidas sobre conta, credenciais e hardware