Sobre a extensão

Visão geral

Integre as soluções Cielo E-Commerce para pagamentos via cartão de crédito/débito, boleto, PIX e GooglePay. Oferecendo uma experiência de checkout simplificada, segura e transparente. Utilizando ferramentas de anti fraude e autenticação como Velocity, ZeroAuth, Silent Order Post (PCI DSS 3.2) e Autenticação 3DS 2.2 para garantir segurança para clientes e comerciantes.

Suporte

Suporte da extensão

Acesse a página da extensão e clique em Get Support.

Suporte Cielo

Em caso de dúvidas em qualquer etapa ou outras informações técnicas, entre em contato com o Suporte Web do Cielo e-Commerce nos seguintes canais:

  • E-mail: cieloeCommerce@cielo.com.br
  • Capitais: 4002-9700
  • Demais Cidades: 0800 570 1700
  • *Horário de atendimento: 24h por dia, 7 dias por semana.

Instalação

Upload da extensão

  1. Faça download da extensão na página oficial e salve o arquivo em um local conhecido em seu dispositivo.
  2. A partir do Painel de Controle, acesse Extensões > Instalador e clique em Upload
  3. Localize o arquivo em seu dispositivo, selecione-o e clique em Abrir ou dê um duplo clique no nome do arquivo.

    Aguarde a instalação ser concluída. A extensão será listada na tabela de Extensões instaladas.

  4. Clique em Instalar
  5. Vá em Extensões > Extensões, selecione Pagamentos em Tipo de extensão, encontre Cielo Checkout na tabela e clique em Instalar.

  6. Siga as Orientações de configuração.

Certificado TLS/SSL no domínio do site

É obrigatório que o domínio do site implemente certificado TLS/SSL e utilize o protocolo HTTPS para estabelecer uma comunicação segura com o servidor.

Atenção

Não oferecemos suporte a instalação do certificado no servidor.

Atenção

Entre em contato com o suporte o seu servidor para mais informaçõoes.

Certificado TLS/SSL Cielo

Instalação no Servidor da loja virtual

Além utilizar o protocolo HTTPS instalando certificado TLS/SSL no endereço da sua loja virtual, é necessário instalar os três arquivos a seguir na Trustedstore do servidor.

Nota

Caso não esteja seguro sobre como realizar a instalação do certificado, entre em contado com o suporte do seu servidor.

Atenção

Não oferecemos suporte a instalação do certificado Cielo.

Atenção

A Cielo não oferece suporte para a instalação do certificado.

Acesso do Cliente à loja virtual

O navegador faz a atualização do certificado automaticamente. Os certificados da Cielo serão exibidos no botão de informações do site no endereço da sua loja virtual. No cadeado, será possível ver as informações do certificado, como a instituição emissora e a data de validade.

Fonte: Cielo

Configuração

Acessando as configurações

Para acessar as configurações clique em Extensões > Extensões a partir do Painel de Controle, selecione Pagamentos em Tipo de extensão, encontre Cielo Checkout na tabela e clique em Editar.

Configurações Gerais

Parâmetro Descrição
Nome do método Texto que será exibido na seleção de métodos de pagamento na finalização do pedido.
Nome da opção Texto que será exibido na opção de meios de pagamento na finalização do pedido.
Ordem Ordem em que o método de pagamento será exibido.
Zona geográfica Região onde o método de pagamento estará dispponível.
Ambiente Modo operação comum a todos os meios de pagamento.

Sandbox: Utilizadas para operação em ambiente de testes.
Produção: Utilizadas para operação em ambiente real.

Ocultar seleção de método de pagamento Quando habilitando a opção Forma de pagamento ficará oculta na finalização do pedido. O método de pagamento Cielo Checkout será selecionado automaticamente.
Status Habilita a extensão.
Log de erros Grava um histórico de dados de erros ou falhas. Consulte o histórico acessando Configurações > Manutenção > Log de erros e clique na aba cielo.log

Credenciais

Credenciais de Sandbox

Utilizadas para operaçãoem ambiente de testes. Para obter as credenciais MerchantId e MerchantKey de testes crie uma conta em Cadastro do Sandbox.

Credenciais de Produção

Utilizadas para operação em ambiente real. As credenciais MerchantId e MerchantKey são fornecidas pela Cielo após a afiliação do estabelecimento.

Status Transacional

Correlacione os status do pedido e do resultado da transação de pagamento.

Status do pagamento Descrição
Não concluído Aguardando atualização de status.
Autorizado Pagamento apto a ser capturado mas ainda não concluído.
Pagamento confirmado Pagamento confirmado e finalizado.
Negado Pagamento negado.
Anulado Pagamento cancelado.
Reembolsado Pagamento cancelado após 23h59 do dia de autorização.
Pendente Aguardando retorno da instituição financeira.
Abortado Pagamento cancelado por falha no processamento.

Meios de Pagamento

Meios de pagamento disponíveis:

Cartão de Crédito

Bandeiras disponíveis
Parâmetro Descrição
Texto no extrato Texto impresso na fatura bancaria do portador. Não permite caracteres especiais.
Status Habilita o meio de pagamento.
Tarifa de crédito à vista Percentual adicional para pagamentos na modalidade crédito à vista. Consulte o seu contrato com a Cielo para mais informações.
Tarifa de parcelamento Percentual adicional para pagamentos na modadlidade de crédito parcelado. Consulte o seu contrato com a Cielo para mais informações.
Tarifa por parcela Percentual adicional em cada parcela. Aplicável apenas para 2 ou mais parcelas. Consulte o seu contrato com a Cielo para mais informações.
Valor mínimo Valor mínimo que o pedido deve atingir para que o meio de pagamento seja habilitado.
Parcelamentos
Parcelamentos
Quantidade de parcelas. Máximo 12.

Pagador das tarifas

Valores possíveis:

  • Vendedor paga todas as tarifas.
  • Cliente paga todas as tarifas.
  • Cliente paga apenas parcelamento (Não aplicável a uma parcela)

Valor mínimo
Valor mínimo que o pedido deve atingir para que a quantidade de parcela correspondente seja habilitado.

Importante

Solicite ao Suporte Cielo que habilite a consulta de BIN.

Cartão de Débito

Bandeiras disponíveis
Parâmetro Descrição
Texto no extrato Texto impresso na fatura bancaria do portador. Não permite caracteres especiais.
Tarifa Percentual adicional para pagamentos na modalidade débito. Consulte o seu contrato com a Cielo para mais informações.
Pagador das tarifas

Valores possíveis:

  • Vendedor paga todas as tarifas.
  • Cliente paga todas as tarifas.
Valor mínimo Valor mínimo que o pedido deve atingir para que o meio de pagamento seja habilitado.
Status Habilita o meio de pagamento.

Importante

Para cartões de débito é obrigatório habilitar a Autenticação 3DS 2.2.

Importante

Solicite ao Suporte Cielo que habilite a consulta de BIN.

Pix

Parâmetro Descrição
Desconto Desconto que será aplicado ao valor final do pedido.
Valor mínimo Valor mínimo que o pedido deve atingir para que o meio de pagamento seja habilitado.
Tamanho do QRCode (px) Tamanho em pixels que o QRCode será exibido.
Status Habilita o meio de pagamento.

Nota

Para habilitar o Pix no ambiente sandbox entre em contato com Suporte Cielo.

Antes de usar em produção, certifique-se de que o Pix está liberado em seu cadastro. Para confirmar basta acessar o Portal Cielo na área logada em Meu Cadastro > Autorizações > PIX

Fonte: Cielo

Boleto

Bancos disponíveis
Parâmetro Descrição
Identificação do cedente Identificação (CPF ou CNPJ) do lojista junto ao banco emissor (Bradesco ou Banco do Brasil).
Dias de vencimento Dias de vencimento a partir do dia corrente para novos boletos. Máximo de 30 dias.
Desconto Desconto que será aplicado ao valor final do pedido.
Demobstrativo Texto que constará no campo Demonstrativo do boleto.
instruções Texto que constará no campo Instruções do boleto.
Valor mínimo Valor mínimo que o pedido deve atingir para que o meio de pagamento seja habilitado.
Status Habilita o meio de pagamento.
Atualizar boletos
Dias de vencimento
Dias de vencimento a partir da data atual. Máximo de 30 dias.

Status
Habilita reimpressão de boleto na página de detalhes do pedido.

Nota

Para mais informações sobre configuração de boletos, acesse o Anexo

GooglePay

Parâmetro Descrição
GooglePay Merchant ID Valor mínimo que o pedido deve atingir para que o meio de pagamento seja habilitado.
Valor mínimo Valor mínimo que o pedido deve atingir para que o meio de pagamento seja habilitado.
Status Habilita o meio de pagamento.

Nota

Não oferecemos suporte a criação do Google Merchant ID. Para mais informações consulte Google Merchant Center Help e Google Pay & Wallet Console

Segurança/Anti fraude

Velocity

O Velocity é um tipo de mecanismo de prevenção a tentativas de fraude, que analisa a frequência que determinados dados são utilizados numa transação e se esse dados estão inscritos em uma lista de comportamentos passíveis de ações de segurança.

Importante

Para que suas transações sejam analisadas pelo Velocity, solicite a inclusão desse serviço ao Suporte Cielo.

Zero Auth

O Zero Auth é uma ferramenta da Cielo que permite verificar se um cartão está válido para realizar uma compra antes que o pedido seja finalizado. Simula uma autorização sem afetar o limite de crédito ou alertar o portador do cartão sobre o teste. Suporta as bandeiras Visa, Master e Elo tanto para cartões de crédito quanto de débito.

Parâmetro Descrição
Status Habilita o uso da ferramenta.

Importante

Para habilitar o Zero Auth, entre em contato com a equipe de Suporte Cielo.

Silent Order Post (PCI DSS 3.2)

Com o Silent Order Post, os dados do cartão são trafegados de forma segura diretamente para os sistemas da Cielo. Esse processo garante a confidencialidade das informações pois dos não passam pelo servidor do e-commerce.

Parâmetro Descrição
ClientId Chave fornecida pela Cielo para utilização da ferramenta.
Client Secret Chave fornecida pela Cielo para utilização da ferramenta.
Status Habilita o uso da ferramenta.

Nota

Para obter o ClientID e o ClientSecret, envie um e-mail para o Suporte Cielo contendo o MerchantId e informando que deseja obter as credenciais para o Silent Order Post.

Autenticação 3DS 2.2

Protocolo de autenticação que confirma se o comprador é de fato o portador do cartão de crédito ou débito. O objetivo do 3DS é evitar fraudes em transações de cartão.

Parâmetro Descrição
ClientId Chave fornecida pela Cielo para utilização da ferramenta.
Client Secret Chave fornecida pela Cielo para utilização da ferramenta.
Status Habilita o uso da ferramenta.

Nota

Para obter o ClientID e o ClientSecret, envie um e-mail para o Suporte Cielo contendo o MerchantId e informando que deseja obter as credenciais para Autenticação 3DS 2.2.

Notificação

Url que a Cielo enviará notificações sobre criação ou mudanças no status da transação.

Parâmetro Descrição
Nome do parâmetro Parâmetro que deverá ser enviado na notificação. Possui valor fixo: notificationKey
Chave Valor do parâmetro notificationKey
Url Url/endpoint que receberá as notificações.

Nota

Durante seu cadastro na Cielo, você deve configurar a Url, parâmetro e a chave corretamente para que Cielo envie as notificações.

Os eventos só são notificados quando você solicitar o recebimento desse tipo de notificação ao Suporte Cielo.

Importante

Siga corretamente as orientações de configuração das notificações. Elas permitem que seu e-commerce se mantenha informado sobre as transações em tempo real, ajudando a monitorar o fluxo de pagamentos.

Checkout

Carregando Meios de Pagamento

Parâmetro Status Pedido possui frete Exibir meios de pagamento
Ocultar seleção de método de pagamento
Clique aqui para mais detalhes.
Habilitado Após selecionar o método de envio.
Habilitado Ao entrar na página de checkout.
Desabilitado Após selecionar o médoto de pagamento.
Desabilitado

Cartão de Crédito/Débito

Fluxo de pagamento

  1. Cliente preenche o formulário e clica em para enviar os dados.
  2. Após o pagamento, é exibido a mensagem de confirmação e redirecionado para a página de sucesso.

Nota

O Número de telefone será exibido apenas quando a Autenticação 3DS 2.2 estiver habilitado.

Pix

Fluxo de pagamento

  1. Cliente preenche o formulário e clica em para obter o QRCode.
  2. O QRCode é exibido na tela aguardando confirmação de pagamento através da leitura do QRCode ou copiar e colar código.
  3. Após o pagamento, é exibido a mensagem de confirmação e redirecionado para a página de sucesso.

Boleto

Para transacionar por boleto, você precisa primeiro contratar esse serviço com o banco.

Fluxo de pagamento

  1. O comprador preenche o formulário e clica em confirmar.
  2. O comprador será redirecionado para a página de sucesso.
  3. O documento será aberto em uma nova aba ou janela do seu navegador.

Nota

A seleção do Banco emissor do boleto será exibido apenas quando houver dois bancos configurados e habilitados.

GooglePay

O comprador deve estar logado na sua conta do Google.

Fluxo de pagamento

  1. O comprador seleciona o método de pagamento e parcelamento e clica no botão GPay.
  2. Será aberto um popup do GooglePay solicitando que o comprador selecione o cartão deseja utilizar.
  3. Após o confirmação, é exibido a mensagem de pagamento concluído e redirecionado para a página de sucesso.

Dashboard

Detalhes da transação

No painel de controle acesse Vendas > Pedidos e clique em Exibir

Na página de Informações do pedido, clique em Detalhes da transação.

As informações da transação de pagamento serão exibidas em um popup.

Área do cliente

Alterando método de pagemento

Caso o pedido tenha sido realizado com pagamento via Boleto e o status estiver como Pendente, é possível alterar o método de pagamento ou reimprimir o boleto (reimpressão de boleto).

Acesse Minha conta > Histórico de pedidos e clique em Exibir

Na página de Informações do pedido, clique em Alterar pagamento.

O fluxo de pagamento via Cartão, Pix e Carteira Digital seguem os mesmos passos apresentados na seção Checkout. Para Boleto é possível apenas reimprimir ou atualizar o boleto (reimpressão de boleto).

Será aberto um popup com as opções de pagamento.

Reimpressão de boleto

Acesse Minha conta > Histórico de pedidos e clique em Exibir

Na página de Informações do pedido, clique em Alterar pagamento.

Após abrir o popup com as opções de pagamento, selecione a opção de Boleto. Em seguida, clique em Reimprimir boleto, o documento será aberto em uma nova aba ou janela do seu navegador.

Nota

Novos boletos só são emitidos após o vencimento do último boleto impresso. Se o último boleto ainda estiver dentro do prazo de validade, ele será reimpresso. Esse processo ajuda a evitar a emissão de múltiplos boletos com a mesma data de vencimento.

Detalhes da transação

Com o cliente logado, acesse Minha conta > Histórico de pedidos e clique em Exibir

Na página de Informações do pedido, clique em Detalhes da transação.

As informações da transação de pagamento serão exibidas em um popup.

Anexo

Configurando boleto Bradesco

Ambiente Bradesco

Atenção

Não oferecemos suporte para configuração de boletos no ambiente Bradesco.

O lojista precisará realizar configurações dentro do ambiente bancário.

Painel de controle

O lojista deverá contatar o gerente de relacionamento do Banco Bradesco para solicitar a contratação do Boleto Registrado via Gerenciador API/Painel de controle. A equipe técnica do Banco enviará para o e-mail do solicitante os dados de acesso ao Gerenciador API/Painel de controle.

Configurando o boleto

No painel do Bradesco, o lojista deverá acessar a aba Configurações e escolher a opção Meios de Pagamento e modifique as seguintes configurações.

Fonte: Cielo
  • Habilitar "frase" do boleto: Inativo
  • Habilitar "referência" do boleto: Ativo
  • Apresentar Agência e Conta: Inativo
  • Vencimento: 5 dias

Importante

O vencimento pode ser definido nas configurações da extensão na seção Boleto.

Fonte: Cielo
  • URL de notificação: https://www.pagador.com.br/post/BoletoBradescoSps/ReceivePost
  • No campo Chave de Segurança clique em Gerar chave de segurança
  • Endereço de IP da loja (numérico)
  • Para os campos de URL de resposta, URL de falha e URL de redirecionamento, inserir o seguinte link: https://www.pagador.com.br/post/BoletoBradescoSps/ReceivePost
Fonte: Cielo

Em cada um dos parâmetros, preencher com o Parâmetro de Comunicação abaixo:

Parâmetros Dados
Notificação numOrder=[%lid_m%]&merchantid=[%merchantid%]&cod=[%errorcod%]&cctype=[%cctype%]&ccname=[%ccname%]&ccemail=[%ccemail%]&numparc=[%numparc%]&valparc=[%valparc%]&valtotal=[%valtotal%]&prazo=[%prazo%]&comb=[%comb%]&assinatura=[%assinatura%]&
Confirmação numOrder=[%lid_m%]&merchantid=[%merchantid%]&cod=[%errorcod%]&cctype=[%cctype%]&ccname=[%ccname%]&ccemail=[%ccemail%]&numparc=[%numparc%]&valparc=[%valparc%]&valtotal=[%valtotal%]&prazo=[%prazo%]&comb=[%comb%]&assinatura=[%assinatura%]&
Falha numOrder=[%lid_m%]&merchantid=[%merchantid%]&cod=[%errorcod%]&cctype=[%cctype%]&ccname=[%ccname%]&ccemail=[%ccemail%]&numparc=[%numparc%]&valparc=[%valparc%]&valtotal=[%valtotal%]&prazo=[%prazo%]&comb=[%comb%]&assinatura=[%assinatura%]&
Comunicação numOrder=[%lid_m%]&merchantid=[%merchantid%]&cod=[%errorcod%]&cctype=[%cctype%]&ccname=[%ccname%]&ccemail=[%ccemail%]&numparc=[%numparc%]&valparc=[%valparc%]&valtotal=[%valtotal%]&prazo=[%prazo%]&comb=[%comb%]&assinatura=[%assinatura%]&

Importante

Não podem existir espaços ou quebras de texto nos parâmetros expostos acima.

Clique em Gravar todas as configurações realizadas.

Configurando credenciais
  1. No painel do Bradesco, o lojista deverá acessar a aba Configurações e escolher a opção Meios de Pagamento.
  2. O campo Palavra-secreta deve ser preenchido com uma senha. A operação é confirmada clicando em Gerar nova chave de segurança
  3. Ainda no Painel do Bradesco, o cliente deve criar um Usuário de Consulta para atualizações de status.
Suporte Bradesco

Para obter ajuda com os passos acima, entre em contato com o suporte Bradesco:

Ambiente Cielo

Dados de cadastro

O Lojista precisará informar ao Suporte Cielo os seguintes dados:

Dados Descrição Formato OBS
Agência Código agência 4 dígitos com ou sem hífen
Conta Conta corrente 7 dígitos com hífen
Carteira Não é necessário boleto Registrado 2 dígitos N/A
Conciliação Número do convênio de cobrança 7 dígitos Informado dentro do Painel do Bradesco
Convênio Convênio de comércio eletrônico 6 dígitos Validar com o banco se é necessário preenchimento para a carteira
Nosso Numero Contador incremental 5 dígitos Opcional - Número de controle que a cada emissão do boleto aumenta em +1
Vencimento Prazo de validade do boleto 6 dígitos É o valor padrão, se nenhum outro valor for enviado via API
Assinatura de Afiliação Chave de segurança do Bradesco 50 dígitos Informado dentro do Painel do Bradesco

Serão necessárias as credenciais do Bradesco:

Nota

Essas credenciais são usadas para que a Cielo possa consultar o status do Boleto.

Credenciais Descrição Exemplo
Usuário E-mail usado no acesso do Painel do Bradesco cielo@cielo.com
Senha/Chave de Segurança Chave de segurança criada dentro do Painel do Bradesco.
Não é a senha de acesso ao Painel Bradesco
qcnmFA-Y2rGm4meWLzrEzSpdPARBsmblZSqfKLwq7DM

Configurando boleto Banco do Brasil

Atenção

Não oferecemos suporte para configuração de boletos no ambiente Banco do Brasil.

Ambiente Banco do Brasil

O lojista deverá contatar o gerente de relacionamento do Banco do Brasil para solicitar a habilitação do produto Boleto Registrado. O formulário a seguir deve ser preenchido e entregue ao gerente.

Dado Formato
URL (site) retorno à loja https://www.pagador.com.br
Formato arquivo Retorno (X) CBR643
Meio de retorno {X) Mainframe – para empresa com sistema próprio, que não usam o GFN.

Ao final do credenciamento, o lojista receberá um documento com como o que segue abaixo.

Ambiente Cielo

Dados de cadastro

O Lojista precisará informar ao Suporte Cielo os seguintes dados:

Dados Descrição Formato OBS
Agência Código agência 5 Dígitos Hífen obrigatório - não pode haver espaços antes ou depois da agência
Conta: Conta corrente 7 Dígitos Hífen obrigatório
Carteira: Não é necessário boleto Registrado 2 dígitos N/A
Conciliação Número do convênio de cobrança 7 Dígitos Inserir o Convênio de cobrança fornecido pelo banco
Convênio Convênio de comércio eletrônico 6 Dígitos Inserir o Convênio de Comercio Eletrônico fornecido pelo banco
Nosso Numero Contador incremental 5 Dígitos Inserir "10000" - A cada emissão de boleto esse numero aumenta em +1
Vencimento Prazo de validade do boleto 6 Dígitos É o valor padrão, se nenhum outro valor for enviado via API
Instruções Informações exibidas no boleto 50 Dígitos Somente números e letras de A-Z, não pode haver caracteres especiais ou mais de um espaçamento entre cada palavra