MANUAL MÓDULO CIELO – QUERY COMMERCE (VERSÃO 1.6.1)

MANUAL MÓDULO CIELO – QUERY COMMERCE (VERSÃO 1.6.1)
QUERY COMMERCE
Introdução
Esse manual fornecerá as informações necessárias para a realização da integração de sua loja em
Magento com o sistema de pagamento da Cielo. Essa integração permite o recebimento de
transações seja via débito ou crédito com a maioria das bandeiras presentes no mercado.
A versão atual do módulo Cielo possui suporte às seguintes bandeiras: Visa, Mastercard, Diners Club,
Discover, Elo, American Express, Aura e JCB.
Integração Cielo
Este tópico tem por finalidade instruir os utilizadores do Módulo de Integração do Magento com a
API Cielo a realizar a instalação corretamente, identificando possíveis erros e problemas que possam
surgir neste processo.
As instruções irão se dividir conforme a listagem que se segue:
1. Instalando o módulo
a. Cópia dos arquivos
b. Permissão de leitura
c. Limpeza do cache
2. Verificando se o módulo foi instalado no sistema
a. Listagem de módulos instalados
b. Menu de navegação e configurações
c. Tabelas no banco de dados
3. Possíveis problemas
1) Instalando o módulo
a) Copia dos arquivos
O primeiro passo a ser realizado é a cópia dos arquivos do módulo para a sua aplicação. Os arquivos
estão organizados e estruturados respeitando a hierarquia de pastas do Magento, portanto basta
copiar os arquivos do módulo para a pasta raiz da instalação do Magento.
Por exemplo, se o Magento está instalado na pasta /var/www do seu servidor, basta copiar os
arquivos do módulo para esta pasta, seja por meio de acesso FTP, acesso SFTP, linha de comando ou
mesmo interface gráfica.
b) Permissão de Leitura
Confira se os arquivos que você copiou possuem permissão de leitura do usuário utilizado pelo seu
servidor HTTP, para evitar problemas na execução do módulo. Recomenda-se que sejam aplicadas
aos arquivos do módulo as permissões designadas para os demais arquivos do Magento.
c) Limpeza de Cache
Uma vez que seus arquivos do módulo foram instalados e possuem as permissões corretas, limpe o
cache do Magento para que o módulo seja instalado e todos os seus menus apareçam na navegação
da administração. Caso você esteja logado na administração antes de iniciar o processo de
instalação, recomendamos que você faça logout e entre novamente na administração da sua loja,
pois alguns menus da configuração exigem esta renovação de sessão.
Para realizar a limpeza do cache acesse no menu da administração Sistema → Gerenciamento
Cache.
Caso possua caches adicionais, como por exemplo, os caches de opcode do PHP, não se esqueça de
realizar a renovação dos mesmos.
2) Verificando se o módulo foi instalado no sistema
a) Listagem de módulo instalados
A primeira verificação a ser realizada para saber se o módulo foi corretamente instalado é ir à
listagem de módulos na administração do Magento. Navegue para Sistema → Configurações →
Avançado.
Nesta tela, expanda a listagem de módulos instalados e confira se o módulo de integração está
instalado. Procure pela entrada Query_Cielo, conforme mostra a figura abaixo:
Caso não encontre o módulo listado, averigue se algum dos passos anteriores foi realizado
incorretamente e, caso persista o erro, entre em contato com o suporte.
b) Menu de configuração
Neste momento, o menu de configuração do módulo irá aparecer na administração da sua loja
Magento em Sistema → Configurações → Vendas → Formas de Pagamento, conforme mostrado nas
figuras abaixo:
Navegue pela página dos menus do módulo em Cartão de Crédito – Cielo – Query Commerce e
Cartão de Débito – Cielo – Query Commerce para assegurar que os funcionamentos dos mesmos
estejam corretos.
c) Possíveis problemas
Caso ocorra algum problema na instalação do módulo, releia com atenção cada um dos passos a
serem realizados e averigue se há entradas no log da sua loja. Para ativar o log da loja virtual,
navegue até Sistema → Configuração → Desenvolvedor → Configurações de Log e ative-o.
Os arquivos de log se encontram na pasta /{instalação_magento}/var/log,
{instalação_magento} a pasta raiz da sua instalação do Magento.
sendo
Em caso de erro do tipo “Not valid template”, basta entrar na pasta app do módulo, Design,
frontend, default e transferir manualmente as pastas layout e template que se encontra no mesmo
caminho descrito anteriormente. Persistindo os problemas, entre em contato com o suporte para a
solução de problemas.
Configuração do módulo
As configurações do módulo podem ser acessadas através do Sistema → Configuração → Vendas →
Formas de Pagamento.
Após clicar sobre Formas de Pagamento uma nova página será carregada. Nesta página é possível
visualizar todas as formas de pagamento, incluindo as do módulo da Cielo. As ilustrações abaixo
mostram as interfaces de configurações.
Em Cartão de Débito – Cielo – Query Commerce é possível ter acesso ao painel administrativo do
mesmo.
Em Cartão de Crédito – Cielo – Query Commerce é possível ter acesso ao painel administrativo do
mesmo.
A seguir segue uma descrição completa sobre cada um dos campos da configuração.

Habilitado: habilita o uso do módulo.

Título: campo responsável por nomear como irá aparecer o título do método de pagamento
para o cliente.

Soft. Descriptor: corresponde a uma mensagem de no máximo 13 letras que aparecerá na
fatura do cliente.

Ambiente: Teste ou Produção

Bandeiras de Cartões: especifica quais cartões estarão disponíveis para o cliente. Dentre as
opções estão Visa, Mastercard, Diners Club, Discover, Elo, American Express, Aura e JCB.

Capturar Automaticamente: Indica se a operação deve ser capturada pelo sistema ou será
capturada na administração das vendas.

Autentificar: Indica que, para cartões Visa e Mastercard, haverá autenticação dos dados. Ao
final da compra o cliente é redirecionado para uma página da sua operadora de cartão onde
são coletados dados que autentiquem o proprietário.

Permitir a criação de um token com os dados do usuário: Permite que a Cielo armazene os
dados do cartão do cliente e os transforme em um token para agilizar compras futuras. Pode
gerar gastos extras para o lojista.

Novo Status do Pedido: Status no qual o pedido se encontrará logo após o cliente tê-lo
efetuado.

Tipo de parcelamento: Pode ser via operadora ou loja, mas o parcelamento via operadora
possui limitações que devem ser verificadas juntamente a Cielo.

Número máximo de parcelas: Corresponde a quantidade de parcelamento máximo que será
oferecido ao cliente pelo lojista. Sendo que esse número de parcelas pode ser diferente para
o cliente dependendo do cartão que o mesmo utiliza, uma vez que cada cartão pode ter uma
limitação de parcelamento diferente.

Valor mínimo de parcelas: Especifica o menor valor que poderá ser assumido por uma
parcela, sendo que a Cielo permite que o menor valor seja de R$5,01.

Parcelas sem juros: Corresponde ao número máximo de parcelas sobre o qual não há juros.

Juros do pedido (%): juros que será aplicado a cada parcela.

Número Cielo: Identifica o lojista junto a Cielo. Por padrão vem configurado com o número
utilizado para teste.

Chave Cielo: Chave do lojista junto a Cielo. Por padrão a mesma vem configurada com uma
chave de teste.
Funcionamento
Depois de configurado o módulo corretamente, o mesmo já está apto para ser utilizado pelos
clientes em suas compras futuras.
A tela a seguir mostra a visão que o cliente passará a visualizar quando optar pelo pagamento com
cartão de crédito ou cartão de débito. Depois de solicitada a opção de pagamento, o cliente deverá
escolher a bandeira correspondente ao seu cartão e preencher todos os campos solicitados pelo
cartão, especificando o parcelamento desejado.
Outra opção de compra também disponível para o cliente é através de Token. O token é uma
maneira de agilizar a compra, caso a loja permita, os dados do cartão de crédito utilizado pelo
cliente são guardados de maneira segura no ambiente da Cielo e a loja recebe um identificador
(chamado de token), que remete àquele cliente e cartão de crédito. Com a utilização do token o
cliente só tem que selecionar o cartão que deseja utilizar, identificando-o através da bandeira e dos
últimos 4 dígitos e preencher a maneira como a compra será parcelada.
Para ter acesso aos pedidos realizados, basta ir através do menu em Venda → Pedidos e clicar ao
pedido correspondente que deseja visualizar. Feito isso uma nova tela, como a da imagem abaixo
será carregada carregar.
No canto superior direito da página apareceram duas opções para consultar o WebService da Cielo
ou capturar a transação e o resultado dessas ações é apresentado na forma do XML a seguir.
A captura da transação só deve ser utilizada quando o módulo estiver configurado para captura
manual e nesse caso é imprescindível a execução dessa ação por parte do lojista já que sem ela ele
não recebe o valor referente à compra.
Para fazer estorno/cancelamento da transação deve ser utilizado o reembolso do Magento, através
da interface é possível criar reembolsos parciais ou totais o que gera cancelamento parcial ou total
na Cielo, fazendo com que o lojista tenha flexibilidade para cancelar apenas alguns itens de uma
compra.
FAQ – Perguntas frequentes
Como devo proceder em caso de erro no log do tipo “Not valid template”?
Nessa situação basta realizar a transferência das pastas layout e template manualmente dentro da
hierarquia padrão do Magento em sua loja. Tais pastas se encontram em app, Design frontend, rwd
e default. Feito isso sua integração com o módulo da Cielo deverá funcionar como esperado.
O que seria a configuração de token?
Processo conhecido como tokenização trata-se de um serviço onde uma informação sigilosa
(número de cartão) será substituída por um token único, por exemplo, um apelido ou uma
sequência de números. Esse token deverá ser utilizado em todos os sistemas que necessitem de
dados do cartão do cliente reduzindo assim o risco de comprometimento: o fraudador não terá
como reverter o número do token de volta para os números do cartão, pois a informação do número
do cartão está sob a responsabilidade desta empresa. (Fonte: Site da cielo).
O pedido aparece com erro, mas na Cielo a transação ocorreu normalmente. O que devo fazer?
Sempre que o botão “Consultar Webservice” é utilizado ele atualiza os dados do pedido com as
informações recebidas da Cielo então se a transação foi realmente efetivada os dados serão
atualizados no Magento.
Onde está o botão “Cancelar na Cielo” ?
O botão “Cancelar na Cielo” foi substituído pela função padrão do Magento de criação de
reembolsos. Agora sempre que criado um reembolso, total ou parcial, é criada uma transação de
cancelamento na Cielo com o valor reembolsado.