Tutorial - Super Link e Checkout
Guia de Utilização
Este tutorial tem como objetivo auxiliar o lojista na configuração de sua loja na Cielo. Estas configurações são aplicadas tanto para a solução Super Link quanto para o Checkout Cielo.
Acessando o Backoffice
O acesso ao painel administrativo ou backoffice é feito através do site Cielo. O acesso pode ser feito por meio do CPF, N° do estabelecimento (EC) ou e-mail do seu cadastro de e-commerce na Cielo.
Após o preenchimento do CPF/e-mail/N° do EC, o site irá solicitar a sua senha. Em caso de primeiro acesso, será enviada uma senha provisória por e-mail.
Após realizar o acesso, deve ser localizado o menu de e-commerce. Neste menu estão disponíveis os produtos de e-commerce que o estabelecimento tem contratado. O Super Link e o Checkout Cielo são dois dos produtos disponíveis neste menu.
Abas do Backoffice
Após clicar em Super Link ou Checkout você terá acesso ao painel administrativo. Este painel possui 6 abas distintas, as quais permitem a configuração de sua loja e a utilização dos produtos contratados.
Cada aba tem um objetivo diferente. A tabela abaixo demonstra o objetivo de cada tela.
Aba | Descrição |
---|---|
DashBoard | Página inicial onde são apresentadas informações sobre o volume transacionado em sua loja online, os tipos de pagamentos mais efetuados e o status das transações. |
Pedidos | Nessa página fica contida a listagem de transações realizadas em seu estabelecimento. Aqui é possível pesquisar um determinado pedido ou transação. |
Link de Pagamentos | Nessa aba são criados e salvos os links de pagamentos de seu estabelecimento. |
Relatórios | Nesta página é possível gerar 05 tipos de relatórios: “Relatório financeiro” “Detalhado de vendas” “Listagem de clientes” “Extrato de Cobrança” “Relatório de Recorrência” |
Manuais | Nesta página constam os manuais de utilização do produto, assim como a página de FAQ e de “Dúvidas”, onde o lojista pode entrar em contato com a equipe de suporte Check out Cielo/Super Link. |
Configurações | Página onde é possivel fazer alterações nas configurações da Loja e dos seus dados cadastrais. |
Aba DashBoard
Aba inicial onde são apresentadas informações sobre a sua conta e sobre o volume e tipo de transações que sua loja vem realizando via o Checkout Cielo.
Tipos de informações
Nessa tela você encontra 2 tipos de informações.
- Alertas – Indica se há pedidos a expirar na data presente.
- Volume financeiro e transacional - São gráficos interativos que demonstram em porcentagem e em valores totais, qual a participação de cada meio de pagamento no total de transações realizadas e o volume total de acordo com o status das transações.
Aba Pedidos
Nessa aba fica contida toda a listagem de transações realizadas no Checkout Cielo. Aqui é possivel pesquisar um determinado pedido, via um determinado parametro de busca nos campos ou desmarcando os “checkbox” dos “Meios de pagamento” ou “Status de pagamento” e apertando o botão “Buscar”. O resultado da pesquisa é exposto em forma de uma listagem de transações que pode ser exportada como uma planilha de Excel.
Listagem de Pedidos
Detalhes dos Pedidos
Aba Link de Pagamento
Nesta aba são apresentados todos os links de pagamentos criados. Esses links podem ser utilizados de diferentes maneiras para proporcionar um maior volume de vendas.
Para saber mais sobre links de pagamentos veja:
No menu Link de Pagamentos, existem as áreas: Cadastrar de Link de Pagamentos e Listar Links de Pagamentos Cadastrados.
Listar Link de pagamentos Cadastrados
Clicando no Titulo ou SKU do produto, você será redirecionado a página de informações de Produto, onde todas as características do produto são informadas e onde você pode definir o padrão do Botão (caso a sua integração seja com base no Botão Checkout Cielo) a ser usado na venda desse produto.
A integração via Botão é melhor explicada no item Integração via Botão/Link de pagamentos.
Cadastrar de Link de Pagamentos
Nessa pagina é possível cadastrar seus produtos com base no tipo de produto em si. Cada produto cadastrado vai gerar um Link de pagamentos diferente O Checkout Cielo considera 5 tipos de produtos: Material Físico, Digital, Serviço, Recorrência e Pagamentos.
- Material Fisico – Produtos Fisicos que necessitam ser enviados pelos lojistas. Ex: Roupas, Brinquedos, etc.
- Digital – Bens digitais vendidos pela internet. Ex: Software, Jogos, Musicas, etc.
- Serviço – Serviços a serem prestados. Ex: Entrega delivery, projetos e orçamentos.
- Recorrência - Transações que se repetem em um determinado intervalo de tempo EX: Assinaturas, mensalidades etc
- Pagamentos - Pagamentos unicos ou transferência de valores Ex: quitação de dividas etc
Após realizar o cadastro do produto/Link de pagamento, a seguinte loja será exibida:
O Link de pagamentos é exibido de 3 maneiras:
- Botão - Será criado um código HTML como o abaixo:
<form method='post' action='https://cieloecommerce.cielo.com.br/transactional/Checkout/BuyNow' target='blank'>
<input type='hidden' name='id' value=00000000-0000-0000-000000000000/><input type='image' name='submit' alt='Comprar' src='https://cieloecommerce.cielo.com.br /BackOffice/Contenthttps://developercielo.github.io/images/botao_comprar_3.jpg' />
</form>
Exemplo de um botão Funcional:
- QR CODE E LINK - O link e o QRCODE tem o mesmo comportamento do botão, levando a mesma tela transacional.
QR Code | Link |
---|---|
http://bit.ly/2tRkSxZ |
Aba Relatórios
Nesta pagina é possível gerar 05 tipos de relatórios: “Relatório financeiro”, “Detalhado de vendas”, “Listagem de clientes”, “Extrato de Cobrança” e “Relatório de Recorrência”.
Relatório Financeiro
Esse relatorio apresenta as vendas pagas em um determinado periodo de tempo, sendo separadas por meio de pagamento. Selecionando o periodo e tipo de pagamento, após pressionar “Buscar” o resultado será apresentado.
Relatório detalhado de vendas.
Esse relatorio informa o valor de cada pedido assim como dados sobre o produto e o comprador. O relatorio somente informa dados dos pedidos considerados com status “PAGO”.
Listagem de clientes
A listagem de clientes gera um arquivo excel contendo os dados dos clientes que realizaram compras em sua loja.
Os dados apresentados são:
Dados do Comprador | Dados de entrega ou Billing |
---|---|
Nome | Endereço |
Numero | |
Telefone | Complemento |
CPF/CNPJ | Bairro |
Cidade | |
Estado | |
CEP |
Extrato de cobrança
A lista do valor cobrado pelos serviços oferecidos pela Cielo será apresentada neste relatório. Todos os dados dos planos e custos transacionais serão apresentados aqui:
Relatório de Recorrência
Nesse relatório é possível pesquisar o conjunto de recorrência e suas transações com base em seu ID ou por Status e Intervalo de ocorrência.
Ao clicar no “+” é aberto a tela de Detalhes da recorrência:
Os Detalhes da recorrência informam o carrinho e o histórico de transações agendadas. Ao clicar em “+Detalhes” o lojista é direcionado a tela de detalhes de Pedidos (Ver item “PEDIDOS”)
Tambem é possível realizar 3 tipos de modificações na recorrência:
- Desativar a Recorrência - Encerra o processo de cobrança automática. Desativação não pode ser desfeito.
- Alterar o Intervalo - Muda o Intervalo atual da recorrência para uma das outras opções (Bimestral, semestral e anual)
- Alterar o dia de agendamento - Modifica o dia em que a transação de recorrência ocorrerá.
Aba Manuais
Nesta página constam os manuais do Checkout Cielo, assim como a pagina de FAQ e de “Duvidas”, onde o lojista pode entrar em contato com a equipe de suporte Checkout Cielo.
Nessa pagina é possivel entrar em contato a respeito de duvidas Operacionais, tecnicas e Comerciais e ter acesso aos documentos técnicos e de suporte do Checkout Cielo.
- Manual do Desenvolvedor – Contém os procedimentos e diretrizes de integração do Checkout Cielo ao seu site.
- FAQ – Perguntas mais comuns a respeito do Checkout Cielo. Contem informações sobre questões Comerciais, Técnicas, Operacionais e sobre o Modo de teste.
Aba Configurações da Loja
Nesta pagina é possivel fazer configurações em diferentes mecanismos dentro do Checkout Cielo. Essa área é dividida em 4 partes diferentes: Exibição, Pagamentos, Antifraude, Frete de Correios & serviços.
Exibição
Aqui é possivel alterar o logo do meio de pagamento disponível em sua loja e a cor de fundo do site via o uso da caixa de opções ou digitando o código relativo a cor escolhida (As cores estão no padrão RGB).
Pagamentos
Nesta tela é possível alterar as configurações dos meios de pagamento disponíveis em sua loja, os definindo como ativos ou não, e configurar a URL de retorno, notificação e Mudança de Status.
Modo de Teste Checkout Cielo
O modo de teste Checkout Cielo é uma ferramenta que permite testar a integração do seu site. Com o modo teste, você pode realizar transações a medida que evolui com a integração e consegue simular cenários para testar diferentes meios de pagamento.
O modo de teste pode ser ativado marcando a caixa de seleção:
Quando a opção for salva, uma tarja vermelha será exibida na parte superior da tela. Ela será exibida em todas as telas do Backoffice e na tela transacional do Checkout Cielo.
Essa tarja indica que a sua loja Checkout Cielo está agora operando em ambiente de teste, ou seja, toda a transação realizada nesse modo será considerada como teste.
Backoffice | Transacional |
---|---|
![]() |
![]() |
Tipos de Notificação
Checkout Cielo possui dois tipos de notificações que o lojista pode utilizar de acordo com suas necessidades:
Tipo | Descrição |
---|---|
POST |
Notificação onde o lojista é passivo. Dois POST HTTP são disparados, um informando dados da venda e outra mudança de Status da transação |
JSON |
Notificação onde o lojista realiza uma consulta. Um POST contendo informações para a realização de uma consulta (GET ) as transações checkout |
Para utilizar ambos os modelos, o lojista necessitará acessar o Backoffice cielo e configurar tanto a URL de NOTIFICAÇÃO
quando a URL de MUDANÇA de STATUS
.
Para mais informações sobre o modelo de notificação visite o Manual de integração
URLs principais do Checkout Cielo
As URL’s descritas nesta área da aba tem a função de meios de comunicação entre o Checkout e o sistema do lojista integrando. Abaixo a descrição de cada uma das URLs
-
URL de Retorno - Ao finalizar a transação o comprador final poderá ser redirecionado para a URL de retorno. Ao clicar no botão “VOLTAR” na tela de comprovante de vendas, o comprador será direcionando para a URL de retorno previamente cadastrada no BackOffice.
-
URL de Notificação - Ao finalizar uma transação é enviado um post com todos os dados da venda para a URL de Notificação, previamente cadastrada no BackOffice. O POST de notificação é enviado apenas no momento que a transação é finalizada, independentemente se houve alteração do status da transação.
-
URL de Mudança de Status - Quando um pedido tiver seu status alterado, será enviando um post para a URL de Mudança de Status, previamente cadastrada no BackOffice. O POST de mudança de status não contem dados do carrinho, apenas dados de identificação do pedido.
Na tela de pedidos, dentro de cada transação, há a opção de reenvio do POST de mudança de status. Basta clicar nos botões azuis, marcados na imagem abaixo:
Para mais informações sobre as URLs de notificação do Checkout visite o Manual de integração
Valores Mínimos e Descontos
Nesta parte da aba de configurações é possível configurar 4 valores mínimos e descontos por meios de pagamento:
Tipo | Descrição |
---|---|
Valor minimo parcela | Caso o valor da parcela da compra seja inferior ao minimo, o Checkout exibirá apenas a parcela superior ao minimo EX: Parcela minima de R$5,00, Em uma compra de R$10, não será exibida a opção de parcelamento em 3X, apenas em 2X |
Valor mínimo para pagamento com boleto | Valor minimo para que a opção de pagamento em boleto seja Exibida |
Desconto para pagamento com boleto | Define um valor % para desconto caso o Boleto seja o meio de pagamento escolhido |
Desconto para pagamento com débito online | Define um valor % para desconto caso o Débito online seja o meio de pagamento escolhido |
Sobre Valor Minimo:
Exemplo: Caso o valor minimo de parcelamento seja de R$10,00, uma compra de R$100,00 poderá ser parcelada máximo em 10x, mesmo que na configuração da loja o parcelamento em 12x esteja habilitado.
Meios de pagamentos Ativos
Basta marcar a caixa de seleção do cartão que deseja disponibilizar no momento do pagamento. Para desabilita-lo, basta desmarcar a caixa de seleção.
O parcelamento é definido por bandeira de cartão. O numero de parcelas maximas disponibilizadas para cada cartão passa a ser definida pelo Lojista.
O Checkout Cielo permite parcelamento até 12 vezes sem juros. O numero de parcelas exibidas no transacional depende do valor minimo para parcelamento configurado pela Loja
Antifraude e Captura Automática
Aqui é possivel definir a automação dos processos de captura e cancelamento de pedidos com base no resultado da analise de antifraude e definir o valor mínimo inicial que uma transação deve ter para ser analisada.
Tabela de status do Antifraude
Status Antifraude | Substatus | Descrição |
---|---|---|
Baixo Risco | Baixo Risco | Baixo risco de ser uma transação fraudulenta |
Médio Risco | Médio Risco | Médio risco de ser uma transação fraudulenta |
Não finalizado | Não finalizado | Não foi possível finalizar a consulta |
N/A | Autenticado | Transações autenticadas pelo banco |
N/A | Não aplicável | Meio de pagamento não analisável como cartões de débito, boleto e débito online |
N/A | Transação de recorrência | Transação de crédito seja posterior a transação de agendamento |
N/A | Transação negada | Venda a crédito foi negada |
Você pode visualizar o status do antifraude acessando o detalhe da compra, na aba Pedidos e clicando no (+)
Frete de Correios & Serviços
Nesta área você configura as opções de frete disponiveis em sua Loja. Na seção Informações sobre Frete há uma explicação mais detalhada sobre os tipos de fretes disponiveis no Checkout Cielo. Há tambem na área de fretes de Correiros, uma calculadora de frete para consultas (essa calculadora dá o valor de frete de cada tipo de frete cadastrado para um determinado peso e localidade)
Tutorial - Link de Pagamentos
Sobre o Link de Pagamento
O Botão, QR CODE ou LINK é um método de compra usada sempre que não houver um “carrinho de compras” em sua loja. Esse tipo de integração é realizado via o cadastro de um conjunto de itens a ser vendido on backoffice do Checkout Cielo.
O botão gera um do 3 tipos diferentes de métodos de acesso a mesma tela transacional:
Método | Nome | Descrição |
---|---|---|
![]() |
Botão | É um código HTML que ao ser colado em um site, vai direcionar o comprador a tela transacional - Ideal para uso em hotSites ou E-mail Marketing |
![]() |
QRCODE | Código interpretável por Smartphones e Tablets - Ideal para uso em Marketing impressos ou Digital |
http://bit.ly/2tRkSxZ |
LINK | é um link compartilhável, ideal para uso em Redes Sociais ou Messengers Mobile |
Este modelo de integração é utilizado para:
- Associar uma compra rápida direta a um produto como uma promoção numa homepage pulando a etapa do carrinho.
- Enviar um e-mail marketing, ou uma cobrança via e-mail.
- Adicionar o botão (HTML) referente ao produto/serviço a ser comprado/pago.
- Realizar envio de pagamentos por aplicativos mobile
- Sempre que se deseja disponibilizar uma venda rápida.
Para utilizar este recurso, é necessário cadastrar o produto que se deseja vender, suas informações, e depois simplesmente copiar o código fonte gerado para este botão.
Características do Botão
Cada botão possui um código único que só permite comprar aquele determinado produto nas condições de preço e frete cadastrado. Portanto, um fraudador não consegue alterar nenhuma destas informações na hora de submeter à compra, pois o Checkout Cielo vai buscar todos os dados do produto no cadastro no Backoffice Cielo Checkout.
Característica | Explicação |
---|---|
Específico | Cada botão gerado serve somente para um determinado produto ou grupo de produtos. A quantidade e volume de produtos vendido é definido no cadastro do Botão, não sendo possível altera a quantidade na tela transacional Exemplo: Será necessário criar Um botão para vender 1 camisa. Se o comprador desejar 2 camisas, ele precisará usar o botão 2X ou O lojista deverá criar um botão com 2 camisas |
Número do Pedido do Checkout | O botão não permite o cadastro do número de pedido do Lojista. Como será a Cielo a acionar o próprio Checkout, será gerado um número de pedido (um GUID ) único. O Lojista receberá esse número de pedido como link a venda realizada |
Criação de pedidos | Um botão gera vários pedidos independentes, ou seja, para limitar a quantidade de pedidos gerados por um botão, QRCODE ou Link criado, é necessario definir uma quantidade minimas de itens em “estoque” no momento de cadastro. O Botão é um método de chamadas à API Checkout. Cada vez que ele é acionado, uma nova requisição é feita a API, criando assim um novo pedido |
Fluxo do Link de Pagamento
Criando Um Link de pagamentos
Para utilizar este recurso, é necessário cadastrar o produto que se deseja vender, suas informações, e depois simplesmente copiar o código fonte gerado para este botão. A inclusão dos produtos é feita dentro do Backoffice Cielo Checkout, no menu de Produtos/Cadastrar Produto.
É possivel criar 5 tipos diferentes de link de Pagamentos:
- Material Fisico – Produtos Fisicos que necessitam ser enviados pelos lojistas. Ex: Roupas, Brinquedos, etc.
- Digital – Bens digitais vendidos pela internet. Ex: Software, Jogos, Musicas, etc.
- Serviço – Serviços a serem prestados. Ex: Entrega delivery, projetos e orçamentos.
- Recorrência - Transações que se repetem em um determinado intervalo de tempo EX: Assinaturas, mensalidades etc
- Pagamentos - Pagamentos unicos ou transferência de valores Ex: quitação de dividas etc
Tela de Cadastro
Botão Cadastrado:
Abaixo a listagem de itens que devem ser cadastrados para a criação do botão:
Campos | Descrição | Tamanho Min. | Tamanho Máx. | Obrigatório |
---|---|---|---|---|
Tipo do Produto |
Indique se está vendendo um bem Material, um Serviço ou um bem Digital. Para bens Digitais, não será apresentada a opção de tipo de Frete. | n/a | n/a | Sim |
SKU |
Código de identificação do produto | 1 | 50 | Não |
Título |
Titulo do Produto | 1 | 50 | Sim |
Descrição |
Descrição do Produto | 1 | 255 | Sim |
Preço |
Valor total do pedido em centavos (ex.: R$1,00 =100). | 11 | 14 | Sim |
Frete |
Escolher dentre uma das opções de Frete (Correios, Frete Fixo, Frete Grátis, Retirar na loja, Sem Cobrança). | n/a | n/a | Sim |
CEP de Origem |
Esse campo só aparece para o frete tipo Correios, deve ser preenchido com o CEP de onde vai partir a mercadoria para fins de cálculo de frete. | 9 | 9 | Sim |
Peso(kg) |
Esse campo só aparece para o frete tipo Correios, deve ser preenchido com o peso do produto em kg para fins de cálculo de frete | n/a | n/a | Sim |
Valor do Frete |
Esse campo só aparece para o frete tipo Frete Fixo, e deve ser preenchido com o valor que o lojista especificar para seus produtos. | n/a | n/a | Sim |
Método de envio |
Esse campo só aparece para Tipo Produto igual a Material Físico e Tipo de Frete igual a Frete Fixo. | n/a | n/a | Sim |
URL |
Esse campo só aparece para Tipo Produto igual a Digital. | n/a | n/a | Sim |
Quantidade |
Define a quantidade maxima de pedidos que o Botão pode gerar. Se não definido, o botão poderá gerar um numero infinito de pedidos | n/a | n/a | Não |
Adicionando o botão na sua página, você deve copiar o código HTML do botão criado e inclui-lo no HTML de seu site, conforme o exemplo abaixo.
Cada botão possui um código único que só permite comprar aquele determinado produto nas condições de preço e frete cadastrado. Portanto, um fraudador não consegue alterar nenhuma destas informações na hora de submeter a compra, pois o Checkout Cielo vai buscar todos os dados do produto no cadastro do Backoffice Cielo Checkout, e valerão os dados do cadastro.