Referência da API | Plugin Coffee Code – Getnet for WooCommerce (v1.5.0)

Bem vindo(a)!

Este é o manual para que você possa integrar sua empresa à Plataforma Digital da Getnet e começar a usufruir das melhores soluções do mercado. Plugin elaborado com as melhores práticas de desenvolvimento. Proporcionando mais agilidade, segurança e conversão de vendas.

SUMÁRIO

1. O que é a Plataforma Digital da Getnet?
- 1.1. Não possui Plataforma Digital da Getnet?
2. Requisitos
3. Métodos de Pagamentos
4. Ambientes
5. Instalação do Plugin
6. Criação Conta Sandbox
7. Configuração dos Métodos de Pagamentos
- 7.1. Gerenciamento dos Métodos de Pagamentos
8. Testes
9. Debug
10. Configuração das URLs de Callback
11. Suporte
12. Colaboradores e Desenvolvedores

1. O que é a Plataforma Digital da Getnet?

A Plataforma Digital é um ecossistema completo, criado para fornecer as mais diversas soluções para o mercado de pagamentos (eCommerce, mCommerce). Estes serviços permitem aos estabelecimentos credenciados aceitar cartões de crédito, boletos bancários e pix como forma de pagamento em suas lojas virtuais através da implementação de processos simples.

Sugerimos que este documento seja lido e utilizado como guia de referência para quaisquer dúvidas no momento da implementação da integração de sua plataforma de comércio eletrônico com o nosso Plugin.

1.1. Não possui Plataforma Digital da Getnet?

Caso não tenha cadastro na plataforma de e-commerce ou possua apenas a maquininha, CONTRATE diretam ente por aqui.

Você será redirecionado para a página da Getnet, onde deverá informar seu CPF/CNPJ e seguir com a contratação do Pacote de e-commerce Getpay Avançado diretamente por lá.

2. Requisitos

PHP version 7.1 ou maior.
WooCommerce version 5.0.x ou maior.
Brazilian Market on WooCommerce.

3. Métodos de Pagamentos

Cartões de Crédito
Boleto Bancário
Pix

4. Ambientes

Antes de iniciarmos a instalação e configuração do Plugin, vamos conceituar e esclarecer os possíveis ambientes de se trabalhar com a integração do referido Plugin junto à Getnet.

4.1. Sandbox

A Sandbox é um ambiente de testes onde as aplicações podem ser alteradas sem interferir no ambiente de produção. As credenciais são fornecidas pela Getnet, após criação de conta Sandbox, que abordaremos no detalhe logo adiante.

4.2. Homologação

Este é um ambiente um pouco mais completo do que o de Sandbox. Pois o mesmo engloba as opções de PIX e Boleto, opções pelas quais não existem em Sandbox. Porém não há (até o momento de escrita deste manual) interface gráfica ou dashboard para interagir com este ambiente. Essa interação deve ser feita totalmente através de REST API.

Para gerar credenciais de homologação, entrar em contato com o suporte Getnet:

E-mail: [email protected]

Telefone: 51 4020.4009

No momento em que for solicitar as credenciais de homologação será necessário especificar quais produtos deseja testar.

Exemplo: Boleto, Cartão de Crédito e Pix.

4.3. Produção

O ambiente de produção é o ambiente real, onde todas as transações serão realizadas e processadas, recomenda-se extremo cuidado ao utilizá-lo.

5. Instalação do Plugin: Faça upload deste plugin em seu WordPress, e ative-o;

5.1. Para instalação, acesse o admin de seu WordPress e depois: “Plugins > Adicionar novo > Pesquise por:Coffee Code – Getnet for WooCommerce > Instalar agora” e aguarde procedimento;

5.2. Verifique se seu plugin já está instalado e ativo, acesse o menu “Plugins > Plugins instalados” e veja se o mesmo vai exibir na lista e se já está ativado, caso não exiba verifique se fez os passos anteriores corretamente e caso exiba e não esteja ativo clique em ativar;

6. Criação Conta Sandbox: antes de configurar o módulo com suas credenciais fornecidas pela Getnet (Seller ID, Client ID, Client Secret), primeiro crie uma conta Sandbox.

6.1. Passo a Passo da criação da sua conta no Sandbox:

Crie uma conta através do link a seguir, precisando somente de e-mail e senha: Clique aqui

6.1.1. Após acessar o link anterior, clique na opção “Crie sua conta no Sandbox”;

6.1.2. Entre com as informações: “Nome > Sobrenome > E-mail > Senha > Assinale a reCaptcha (não sou um robô) > Criar Conta”;

6.1.3. Aparecerá a mensagem de que o e-mail para ativação da sua nova conta do Sandbox foi enviado para o e-mail informado no passo anterior;

6.1.4. Após recebida a mensagem abaixo no seu e-mail, clique em: “Sim, desejo ativar minha nova conta”;

6.1.5. Assinale a reCaptcha “(não sou um robô) > Ativar nova conta”;

6.1.6. Prontinho! Seu painel de controle do ambiente Sandbox da Plataforma Digital Getnet abrirá;

6.2. Após cadastrada a sua conta Sandbox na API da Getnet, agora é hora de configurar o módulo com suas credenciais. No admin de seu WordPress acesse: “WooCommerce > Getnet”. Se atentar a questão de ambiente, cada credencial funciona apenas em seu devido ambiente, ou seja, sandbox apenas em sandbox, homologação apenas em homologação e produção apenas em produção;

6.2.1. Na sua conta Sandbox, acesse o menu “Configurações”, para visualizar as credenciais de (Seller ID, Client ID, Client Secret);

6.2.2. Agora preencha as respectivas credenciais e clique em “Salvar alterações”;

7. Configurando os Métodos de Pagamentos: acesse o menu “WooCommerce > Configurações > Pagamentos” e aparecerá a listagem de métodos de pagamentos do Plugin instalado. Dentre os métodos abaixo, assinale aqueles pelos quais deseja utilizar em sua loja para exibir a tela de configuração;

7.1. Gerenciamento dos Métodos de Pagamentos: clique na descrição do método de pagamento ex.: Getnet Cartão de Crédito ou no menu Gerenciar, para abrir as configurações do mesmo. Configure os métodos pelos quais deseja utilizar um a um. Cartão de Crédito, Boleto Bancário e Pix, com as credenciais de acordo o ambiente pelo qual deseja utilizar (sandbox, homologação ou produção), lembre-se que para utilizar as funcionalidades de Boleto Bancário e Pix no ambiente de produção, esta opção deverá ser contratada e ativada à parte junto a Getnet.

7.1.1. Como Contratar e Ativar as Funcionalidades de Emissão de Boleto e Pix

Boleto:

Obs.: Apenas clientes do banco Santander podem emitir boletos.

Caso já seja um cliente do banco Santander entre em contato com seu gerente de contas Santander, para:

Definir o certificado digital como o da Getnet;
O convênio deve estar vinculado a caixa postal da Getnet;
E arquivo CISA.

Após obtido, deve-se encaminhar as informações para o suporte da Getnet no e-mail: [email protected]

PIX:

Para utilizar o Pix, basta cadastrar uma chave com o Santander e negociar a taxa diretamente no convênio com eles.

7.1.2. Cartão de Crédito

Assinalar opção: Habilitar Cartão de Crédito;
Inserir título – Controla o título que o usuário vê durante o checkout;
Inserir descrição no checkout – Controla a descrição que o usuário vê durante o checkout;
Inserir prefixo do pedido – Insira um prefixo para os números dos seus pedidos. Se você usar a sua conta Getnet para várias lojas, certifique-se de que este prefixo seja único;
Inserir descrição na fatura do comprador – Texto exibido na fatura do cartão do comprador;
Assinalar opção: Imagem do cartão de crédito no checkout – Habilita imagem de pré visualização do cartão de crédito no checkout;
Logs – Assinalar a opção: Habilita os logs do cartão de crédito;
getnet-creditcard-order ou getnet-creditcard-order-error. Para visualizar: “WooCommerce > Status > Logs”;
Inserir valor mínimo para parcelar a compra – Valor mínimo para compras parceladas (esta opção habilita o parcelamento quando a compra atinge tal valor, caso o total da compra seja inferior a este valor configurado, somente será permitido o pagamento no crédito à vista);
Inserir quantidade máxima de parcelas – Seleciona a quantidade máxima de parcelas para o pagamento;
Juros a partir da parcela – Define a partir de qual parcela será aplicado os juros;
Valor inicial dos juros – Valor percentual dos juros a serem aplicados na parcela;
Incremento nos juros – Valor percentual dos juros incrementados em cada parcela;
Salvar alterações.

7.1.2.1. Cancelamento/Estorno

É possível realizar a solicitação de cancelamento/estorno de pagamentos com cartões de crédito para transações no mesmo dia (D0). Basta realizar o passo a passo conforme orientações abaixo:

Atenção, pois esta operação não poderá ser desfeita.

No admin de seu WordPress acesse: “WooCommerce > Pedidos > Selecione o pedido > Clique no botão reembolso > Inserir valor a ser reembolsado (deverá ser exatamente o valor total do pedido para que não ocorra erro ao processar a operação) > Clique em concluir (aparecerá a mensagem informando que a operação não pode ser desfeita)”. Pronto, agora o reembolso foi concluído com sucesso e aparecerá com o valor estornado destacado em vermelho.

Para verificar o status do pedido reembolsado, no admin de seu WordPress acesse: “WooCommerce > Pedidos”. No pedido em questão já aparecerá o status REEMBOLSADO e também receberá a mensagem de Log que “o estorno foi realizado com sucesso”.

Para verificar a mensagem de Log, no admin de seu WordPress acesse: “WooCommerce > Status > Aba logs > Selecione a transação > Clique em visualizar”. Pronto, aparecerá a mensagem com o status de transação cancelada com sucesso e o seu respectivo valor.

7.1.3. Boleto

Assinalar opção: Habilitar Getnet Boleto;
Inserir título – Controla o título que o usuário vê durante o checkout;
Inserir descrição – Controla a descrição que o usuário vê durante o checkout;
Inserir prefixo do pedido – Insira um prefixo para os números dos seus pedidos. Se você usar a sua conta Getnet para várias lojas, certifique-se de que este prefixo seja único;
Número de dias para vencimento – Dias de vencimento do boleto após impresso;
Instruções do boleto – Instruções para aparecer no boleto;
Logs – Assinalar a opção: Habilita os logs do boleto;
getnet-boleto-order ou getnet-boleto-order-error. Para visualizar: “WooCommerce > Status > Logs”.
Configurações do Desconto:
Nome do Desconto – Digite o nome do desconto (Nome padrão: Desconto Getnet);
Valor do Desconto – Digite o valor do desconto (Exemplo: 10,00%), desconto em porcentagem;
Salvar alterações.

getnet-boleto-order ou getnet-boleto-order-error. Para visualizar: “WooCommerce > Status > Logs”;

Configurações de Desconto:
Nome do Desconto – Digite o nome do desconto (Nome padrão: Desconto Getnet);
Valor do Desconto – Digite o valor do desconto (Exemplo: 5%), desconto em porcentagem;
Salvar alterações.

7.1.4. Pix

ATENÇÃO! A URL de Callback para o método de pagamento pix, está disponível apenas no ambiente de produção.

Assinalar opção: Habilitar Getnet Pix;
Inserir título – Controla o título que o usuário vê durante o checkout;
Inserir descrição – Controla a descrição que o usuário vê durante o checkout;
Inserir prefixo do pedido – Insira um prefixo para os números dos seus pedidos. Se você usar a sua conta Getnet para várias lojas, certifique-se de que este prefixo seja único;
Logs – Assinalar a opção: Habilita os logs do pix;

getnet-pix-order ou getnet-pix-order-error. Para visualizar: “WooCommerce > Status > Logs”;

Configurações de Desconto:
Nome do Desconto – Digite o nome do desconto (Nome padrão: Desconto Getnet);
Valor do Desconto – Digite o valor do desconto (Exemplo: 10,00%), desconto em porcentagem;
Salvar alterações.

8. Testes: Pronto, após devidamente configurado, realize os testes de acordo o ambiente, lembre-se que compras em modo de teste não são efetivadas, fique atento a não manter a loja ativada em ambiente de teste.

9. Debug: Para debugar e visualizar logs com motivos de erros ou problemas de integração ou configuração em métodos de pagamento Getnet em sua loja siga as instruções abaixo.

9.1. Ativação Modo Debug: Primeiro, deverá ativar o modo debug no método pelo qual está ocorrendo o problema e deseja debugar, é uma opção que exibe ao final da configuração de cada método de pagamento Getnet em sua loja.

9.2. Simulação de Compra: Após ativado, simule uma compra de forma que seja feita uma requisição de pagamento, assim o sistema salvará os logs.

9.3. Visualização dos Logs: Após simulação da compra e retorno do erro, acesse o admin de sua loja e o menu “Woocommerce > Status > Logs”, selecione o log Getnet correspondente ao método de pagamento e data pela qual realizou o teste, e visualize os logs e verifique as mensagens de erros retornadas.

10. Configuração das URLs de Callback

Para atualização de pagamento, você precisa configurar as URLs de Callback no painel de administração da Getnet e posteriormente enviar um e-mail para: [email protected], solicitando a liberação das URLs configuradas no firewall da Getnet.

Sugestão de exemplo de e-mail para solicitação:

“Gostaria de solicitar a liberação no firewall para as seguintes URLs de Callback de nosso e-commerce:

‘https://SEUDOMINIO.com.br’

‘https://SEUDOMINIO.com.br/wc-api/getnet-creditcard’

‘https://SEUDOMINIO.com.br/wc-api/getnet-pix’

‘https://SEUDOMINIO.com.br/wc-api/getnet-billet’

Tais URLs já estão cadastradas em nosso site e no portal da Getnet, mas não estamos recebendo Callbacks corretamente.

Nosso Seller ID é:

Nosso CNPJ:

Nosso EC:”

Obs.: Apenas se tiverem as URLs de Callback cadastradas e configuradas junto ao suporte, os Callbacks irão funcionar.

No plugin selecione o método de pagamento desejado;
Copie a URL de Callback conforme o print abaixo:

Obs.: Neste exemplo a URL de Callback para Cartão de Crédito é: https://getnet.homolog.tech/wc-api/getnet-creditcard

Após copiada a URL de Callback, acesse o painel de administração da Getnet na opção “Configurações” e selecione a opção de Callback correspondente e cole no método de pagamento desejado:

Observe que cada método de pagamento possui uma URL diferente, você deverá fazer o mesmo procedimento para todos os métodos de pagamentos que utilizará. Dessa forma, toda atualização que houver no pagamento, será atualizada no seu woocommerce.

Colaboradores e Desenvolvedores:

“Coffee Code – Getnet for WooCommerce” é um software com código aberto. As seguintes pessoas contribuíram para este plugin:

Alexandre Anjos

Aline Gonçalves

Ivanilton Gomes

Jônatan Gouveia

Ritchelly Sá Domingos

Wesley Santos

Referência API Getnet

Baixar Plugin

Suporte Coffee Code