INTRODUÇÃO

Conheça a Cielo Smart

A Cielo Smart é mais do que uma maquininha de pagamentos, é uma plataforma aberta que permite a criação de soluções completas para o varejo, unindo frente de caixa, gestão de negócios e meios de pagamento em um único dispositivo.

Essa solução suporta aplicativos desenvolvidos para sistema Android, possibilitando que desenvolvedores parceiros possam criar aplicativos especializados para diversos segmentos e qualquer porte de cliente.

Com a Cielo Smart, você tem acesso a mais de 50 aplicativos para gestão do seu negócio, integração com sistemas de automação, bateria de longa duração, conexão constante para não perder vendas, aceitação de todas as formas de pagamento e um design moderno, ergonômico e discreto, com carregador magnético, NFC e conectividade 4G, garantindo mais tecnologia, agilidade, segurança e tranquilidade no seu dia a dia.

Modelos de negócio

A integração com a Cielo Smart pode ser aplicada em diferentes cenários, dependendo do modelo de negócio e da proposta da sua solução. A seguir, apresentamos os principais modelos disponíveis para você explorar e implementar.

• Aplicativos públicos: Disponíveis na Cielo Store, esses apps podem ser acessados por qualquer usuário da Cielo LIO. São ideais para soluções com grande alcance, como controle de vendas, gestão de estoque, delivery, entre outros. A monetização pode ser feita por assinatura, licenciamento ou modelo de uso.
• Aplicativos privados: Desenvolvidos sob medida para um cliente ou grupo específico, esses aplicativos não ficam visíveis na loja pública. São muito utilizados por redes, franquias ou empresas que precisam de soluções personalizadas e exclusivas.
• Integração com sistemas de automação comercial: A Cielo Smart pode ser conectada a sistemas de frente de caixa (PDV) e ERPs, permitindo a sincronização de vendas, controle de estoque, emissão de notas fiscais e muito mais. É a escolha ideal para empresas que já possuem um sistema próprio e desejam integrá-lo à maquininha.
• Soluções de parceiros: Empresas também podem atuar como parceiras da Cielo, oferecendo soluções homologadas. Isso inclui desde o desenvolvimento de aplicativos até serviços de integração, suporte técnico e consultoria especializada.
  

Estamos em processo de migração para a nova geração de terminais Cielo Smart.

Para aprender mais sobre funcionalidades e especificidades técnicas, acesse a seção Visão Geral Técnica.

Primeiros passos

Está iniciando agora a sua jornada de integração e não sabe por onde começar? Aqui, você encontra uma visão simplificada dos principais passos para integrar com a Cielo Smart e publicar seu aplicativo na Cielo Store.

A primeira seção desta documentação, intitulada Introdução, apresenta uma visão geral da Cielo Smart, explicando sua proposta e benefícios. Nessa parte, você encontra este guia de primeiros passos com orientações básicas para iniciar a integração, um glossário com os principais termos técnicos utilizados ao longo da documentação, os canais de suporte disponíveis e uma área dedicada às últimas atualizações da plataforma.

A seção Visão geral técnica aprofunda os aspectos técnicos da Cielo Smart, detalhando as funcionalidades disponíveis nos terminais, os modelos de equipamentos compatíveis e as boas práticas recomendadas para desenvolvedores que desejam garantir qualidade, segurança e desempenho em suas soluções.

Em Publicando um aplicativo, o foco está no processo de criação, testes e publicação de aplicativos. Você aprende desde os primeiros passos no desenvolvimento até o uso do Cielo Store Dev Console, ferramenta que permite gerenciar os aplicativos dentro da plataforma. Também são explicadas as diferenças entre loja pública e loja privada, como acompanhar o status do aplicativo, os critérios para publicação e como utilizar o ambiente Sandbox, que funciona como um emulador para testes sem a necessidade de um terminal físico.

A seção Integração apresenta os diferentes tipos de integração possíveis com a Cielo Smart, incluindo a Integração via Deeplink e a Integração remota.

Por fim, a seção de Perguntas Frequentes reúne as dúvidas mais comuns entre os usuários da plataforma. Ela funciona como um complemento prático à documentação, oferecendo respostas objetivas e diretas sobre temas recorrentes, como erros comuns, processos de publicação, uso do emulador, integração com APIs e outras questões que podem surgir durante o desenvolvimento.

Glossário

Este glossário reúne os principais termos utilizados no ecossistema de desenvolvimento da Cielo Smart. Ele foi criado para facilitar a compreensão de conceitos técnicos e operacionais, promovendo uma integração mais eficiente com nossas soluções. Consulte-o sempre que tiver dúvidas sobre nomenclaturas ou funcionalidades.

Suporte técnico

Aqui, você encontra tudo o que precisa para começar a desenvolver soluções integradas com a Cielo Smart. Nosso objetivo é apoiar você em cada etapa do desenvolvimento, desde o planejamento até a publicação da sua solução.

Caso tenha dúvidas envie um e-mail para: suportesolucoesintegradas@cielo.com.br ou envie sua pergunta pelo portal.

Você também pode agendar uma chamada no dia e horário que preferir para conversar diretamente com nossos desenvolvedores especializados em suporte às soluções integradas da Cielo Smart.

Ou, se preferir, entrar em contato pela Central de Atendimento:

• Capitais e regiões metropolitanas: (11) 4002-5472
• Demais localidades: 0800 570 8472

Seja um parceiro

A Aliança Cielo objetiva construir parcerias estratégicas com empresas de tecnologia, ampliando nossa atuação no mercado com soluções integradas e completas. A proposta é democratizar o acesso à inovação, conectando nossos serviços às soluções dos parceiros.

Como funciona a parceria?

A maioria das parcerias é formada por meio da integração entre os produtos da Cielo e as soluções dos parceiros. Também há troca de leads qualificados, criando oportunidades comerciais para ambos os lados.

Quais são os benefícios de ser parceiro da Cielo?

Além de fazer parte de uma das líderes em meios de pagamento, os parceiros têm acesso a benefícios como:

• Compartilhamento de resultados
• Relacionamento direto com executivos da adquirente
• Acesso a conteúdos exclusivos
• Networking com empresas do setor
• Participação em viagens e eventos especiais
• Visibilidade em canais da Cielo
• Apoio em feiras e eventos do setor

Quem pode ser parceiro?

O programa é destinado a empresas de tecnologia de todos os portes que atuam nos segmentos do varejo físico e do e-commerce. Isso inclui Software Houses, TEF Houses, desenvolvedores de soluções integradas com maquininhas e aplicativos para Cielo Smart, além de plataformas de e-commerce, orquestradores de pagamento, agências implementadoras e criadores de marketplaces.

Que etapas devo seguir para me tornar parceiro da Cielo?

O processo é simples e estruturado em 7 etapas:

1. Cadastre-se como candidato a parceiro via formulário
2. Aguarde a avaliação de viabilidade da parceria pelo Time Aliança
3. Assine o termo de confidencialidade via Portal do Parceiro
4. Preencha o modelo Know Your Partner (KYP) e aceite os termos e políticas
5. Aguarde a análise documental pela equipe da Cielo
6. Assine o contrato de parceria
7. Pronto! A parceria foi formalizada e agora você tem acesso completo ao Portal do Parceiro

Ficou com dúvidas? Envie um e-mail para parcerias@cielo.com.br ou acesse o site com mais informações sobre o programa de parcerias.

Comunicados

Atualização obrigatória dos seus apps para a Cielo Smart!

Julho de 2025

Estamos em processo de migração para a nova geração de terminais Cielo Smart. Para garantir o funcionamento dos seus aplicativos, é essencial que eles estejam adaptados até 15/10/2025.

Datas importantes:

• 15/08: Live para tirar dúvidas sobre a migração (divulgaremos link em breve).
• 29/08: Fim do suporte a apps não adaptados (sem Deeplink ou SDK < 2.1.0).
• 15/10: Corte definitivo — apps não adaptados poderão deixar de funcionar.

Para migrar:

• Utilize a integração via Deeplink.
• Solicite um terminal Smart para testes via Portal do Desenvolvedor.
• Em caso de dúvidas, abra um chamado no portal ou envie e-mail para atendimentosmart@cielo.com.br

Cielo Smart: A evolução da LIO On

Março de 2025

A Cielo Smart chegou para transformar a experiência de desenvolvimento na plataforma Cielo. Evolução direta da LIO On, ela oferece mais performance, compatibilidade e foco em inovação.

Com a Cielo Smart, você aproveita:

• Compatibilidade ampliada: Seu app roda em novos terminais sem necessidade de ajustes ou retrabalho.
• Mais robustez e velocidade: Melhorias significativas no desempenho e no tempo de aprovação de pagamentos.
• Smart first: Todas as novas funcionalidades e atualizações serão lançadas exclusivamente para a Cielo Smart.

Conheça os benefícios da integração via Deeplink

Dezembro de 2024

Adapte seus aplicativos com a integração via Deeplink e aproveite novas funcionalidades sem precisar atualizar bibliotecas externas.

Se você já utiliza a integração via Deeplink, veja abaixo como se adaptar ao novo Cielo Smart:

1. Atualize o arquivo AndroidManifest.xml. Para fazer isso, adicione a seguinte tag para garantir que o app seja distribuído corretamente nos terminais durante o processo de publicação:

<application>

    ...
    
    <meta-data
    android:name="cs_integration_type"
    android:value="uri" />
    
    <activity>
    ...
    <activity/>

<application/>

1. Certifique-se de que seu app está em conformidade com os requisitos do Android 10, incluindo permissões, notificações, criação de intents, entre outros.

Recomendamos fortemente a migração para a integração via Deeplink, que oferece uma solução mais leve, flexível e segura para o seu app. Ao eliminar a dependência de SDKs, a integração se torna mais rápida, personalizável e compatível com diferentes dispositivos e versões. Além disso, reduz conflitos com bibliotecas externas, facilita a manutenção e melhora o desempenho, ao evitar a sobrecarga de código de terceiros.

Para saber mais, acesse a documentação de integração via DeepLink.

VISÃO GERAL TÉCNICA

Funcionalidades

A Cielo Smart oferece funcionalidades exclusivas que agregam valor à experiência do cliente. Entre os principais destaques, estão:

• Impressora térmica: Permite a impressão da 1ª e 2ª via do comprovante após a finalização do pagamento. Além disso, aplicações parceiras podem utilizar os recursos da impressora para gerar documentos relevantes ao negócio do cliente.

• Tecnologia NFC: Compatível com pagamentos por aproximação (contactless), oferecendo mais agilidade e praticidade nas transações.
• Cielo Store: Loja de aplicativos integrada com mais de 50 apps voltados para gestão de vendas, estoque, equipe, entre outros.
• Multiconexão (Wi-Fi + 4G): Garante conectividade em diferentes ambientes, permitindo mobilidade e vendas em qualquer ponto da loja.
• Frente de caixa móvel: Pode ser usada como um ponto de venda portátil, ideal para atendimento em movimento.
• Leitor de código de barras: Facilita o cadastro e a venda de produtos com leitura rápida e precisa.
• Calculadora integrada: Para facilitar o cálculo de valores antes de finalizar a venda.
• Múltiplas formas de pagamento: Inclui débito, crédito (à vista e parcelado), voucher, Pix, QR Code e mais de 80 bandeiras de cartões.
• Integração com sistemas de automação comercial: Via APIs REST permitindo que desenvolvedores criem soluções personalizadas para o terminal.

Arquitetura

A plataforma Cielo LIO é baseada em Android que consiste em:

• Uma loja de aplicativos Cielo Store para os desenvolvedores publicarem seus aplicativos e os disponibilizarem para os estabelecimentos comerciais (lojistas).
• Uma plataforma com arquitetura em nuvem e APIs REST que permite a integração com sistemas de automação comercial de parceiros. Acesse a documentação da integração remota
• Chamadas via intent, de forma que aplicativos de parceiros possam se integrar com as funcionalidades de pagamento da Cielo LIO. Acesse a documentação da integração via Deeplink

Terminais e características da Cielo Smart

Atualmente, dois terminais da Cielo Smart estão disponíveis: Cielo LIO (L300) e DX 8000.

Cielo Lio: L300 - Positivo

DX8000 - Ingenico

Abaixo, você encontra as especificações técnicas dos modelos disponíveis:

Boas práticas para desenvolvedores

Aqui, estão reunidas orientações essenciais para garantir que sua integração aconteça de forma eficiente, segura e alinhada à experiência esperada na Cielo Smart.

Segurança e Privacidade

• Proteja dados sensíveis de clientes e funcionários.
• Nunca exponha tokens de autenticação ou senhas.

Rate limiting e performance

• Escalone as solicitações da Automação Comercial ou PDV para evitar picos de tráfego.
• Utilize cache para dados grandes ou para armazenar valores especializados.
• Evite chamadas POST em multi-threading para prevenir deadlocks.
• Minimize o uso de dados, considerando conexões móveis limitadas.
• Otimize as operações visando o baixo consumo de bateria.

Qualidade de código

• O aplicativo deve seguir as boas práticas de desenvolvimento Java e Android, conforme as diretrizes oficiais para desenvolvedores da plataforma Android.
• Aplique os princípios Design Orientado a Objetos (S.O.L.I.D.) e diretrizes de estilo Java.
• Entenda e configure corretamente compileSdkVersion, targetSdkVersion e minSdkVersion.
• Aproveite os botões nativos do Android, como os botões “Voltar” e “Início”.

Usabilidade e experiência do usuário

• Utilize ícones com dimensionamento padrão Android. Siga esta guideline
• Implemente ferramentas de monitoramento de falhas em seus produtos Android com o objetivo de manter a consciência operacional do produto. Sugerimos a utilização do Crashlytics.
• Colete métricas de uso do aplicativo para melhorar o produto.
• Priorize clareza e acessibilidade no design do seu aplicativo: contraste, fontes legíveis e texto grande.
• Esclareça os termos de uso da aplicação e ofereça suporte adequado ao usuário.
• Seu aplicativo será usado em condições de trabalho de ritmo rápido em ambientes dinâmicos, portanto, construa fluxos de fácil com o mínimo de passos possível.
• Ao adaptar um aplicativo desenvolvido para outra plataforma, mantenha apenas os recursos e botões relevantes para o usuário da Cielo Smart.
• Recomenda-se o uso do Material Design no desenvolvimento de aplicações para a Cielo Smart, promovendo a adoção de boas práticas de design e melhorando a experiência em dispositivos móveis.

PRÉ-PUBLICAÇÃO DE APLICATIVO

Pré-requisitos

Com a Cielo Smart, empresas e parceiros podem executar seus aplicativos diretamente na plataforma da Cielo. Esses aplicativos podem ou não estar integrados com o pagamento, dependendo dos objetivos específicos de cada negócio.

Antes de iniciar o desenvolvimento de um aplicativo para a Cielo Smart, é importante atender a alguns requisitos técnicos que garantem compatibilidade e desempenho. A seguir, apresentamos os principais pontos que devem ser considerados para uma integração eficiente com a plataforma.

Linguagem de programação

A Cielo Smart é compatível com aplicativos desenvolvidos em Java ou Kotlin. Recomenda-se o uso dessas linguagens para garantir melhor desempenho, estabilidade e integração com o sistema.

Embora outras linguagens possam ser utilizadas, a responsabilidade pela compatibilidade e funcionamento do aplicativo será inteiramente do desenvolvedor.

Ambiente de desenvolvimento

Recomenda-se o uso da a IDE Android Studio, versão 2.2.2 ou superior, para garantir a correta execução dos aplicativos na Cielo Smart.

Os links abaixos oferecem direcionamentos de instalação, configuração e criação de projetos.

• Guia de instalação e configuração do Android Studio
• Criando um novo projeto no Android Studio

Versão target da aplicação

Para garantir compatibilidade com os modelos e versões do Android utilizados nos terminais LIO, recomenda-se:

• SDK mínima: 24
• SDK target: 29

Aplicativos com target inferior à versão 29 não poderão ser distribuídos na Cielo Smart. Além disso, é essencial que o aplicativo esteja em conformidade com os requisitos do Android 10, como permissões, notificações e uso de serviços em foreground.

Modelos de integração

Integração é o processo de conectar diferentes sistemas ou aplicações para que eles possam trabalhar juntos de forma fluida. No contexto da Cielo Smart, isso significa permitir que o sistema de automação comercial ou Ponto de Venda (PDV) do cliente se comunique com os serviços da Cielo, como pagamentos, cancelamentos e impressão de comprovantes, de maneira segura e eficiente.

A Cielo oferece dois principais modelos de integração para facilitar a comunicação entre o sistema do cliente e a Cielo Smart: Integração via Deeplink e Integração remota.

Integração via Deeplink

Esse modelo utiliza deep links para permitir que aplicativos Android se comuniquem diretamente com os recursos da Cielo.

Vantagens:

• Simples de implementar em apps Android.
• Permite chamadas diretas para funcionalidades específicas da Cielo.
• Boa opção para soluções mais leves ou apps móveis.

Clique aqui para aprender mais sobre a integração via Deeplink.

Integração remota

Neste modelo, você continua utilizando seu sistema de PDV normalmente. Quando chega o momento de realizar o pagamento, o sistema se conecta ao Order Manager por meio de um conjunto de APIs.

Vantagens:

• Mantém todas as funcionalidades do sistema atual.
• Comunicação rápida e segura com o gerenciador de pedidos da Cielo.
• Ideal para quem já possui uma solução robusta de automação comercial.

Clique aqui para aprender mais sobre a integração remota.

Emulador Cielo

Disponibilizamos um aplicativo que facilita a validação da sua integração com a Cielo Smart, eliminando a necessidade de utilizar o hardware físico em modo debug. Essa solução simula o comportamento da Cielo Smart, processando solicitações e gerando respostas para o software de integração. Com isso, você pode realizar testes e depuração diretamente no ambiente de desenvolvimento, sem precisar de um dispositivo físico da Cielo Smart.

Baixando o Emulador Cielo

1. Clique aqui para fazer o download do emulador.

2. Após a instalação, abra o aplicativo. A primeira tela exibida será a de boas-vindas, contendo uma mensagem inicial e dois botões. O botão para limpar dados irá remover os pedidos criados pelo integrador. Já o botão de configurações permite ajustar as respostas automáticas para testes de chamadas de impressão.

3. Então, instale o aplicativo de integração. Para fins didáticos, utilizamos o aplicativo Sample, disponível no GitHub da Cielo. Para instalar o aplicativo Sample, baixe os arquivos do projeto disponíveis no GitHub. Assim, você terá um APK que poderá ser instalado no seu dispositivo.

4. Em seguida, abra o arquivo no Android Studio e clique em Run App para instalar o aplicativo no seu dispositivo.

Utilizando o emulador da Cielo Smart

1. Ao entrar no Cielo Emulador, a primeira tela exibida será a de boas-vindas, contendo uma mensagem introdutória e dois botões principais:

• Limpar dados: essa opção apaga os pedidos que foram criados pelo sistema integrador, permitindo começar os testes do zero.
• Configurações: abre um menu com opções para definir respostas automáticas, especialmente úteis para simular chamadas de impressão durante os testes.

2. Com o aplicativo de integração instalado, você deve selecionar o tipo de integração desejada: Integração Local ou Integração via Deep Link.

3. Ao selecionar a integração, você verá as opções para realizar pagamentos ou para imprimir textos e imagens. Abaixo, detalhamos esses fluxos.

Realizando pagamentos

1. Ao clicar em Realizar Pagamento, serão exibidos os dados de pagamento.

• Valor da transação: corresponde ao valor informado no campo amount da requisição.
• Produto principal (Primary Product): menu suspenso com todas as opções de produtos principais disponíveis para a transação.
• Produto secundário (Secondary Product): menu suspenso que exibe os produtos secundários vinculados ao produto principal selecionado.
• Lista de Estabelecimentos Comerciais (ECs): campo que apresenta os ECs disponíveis para seleção.

2. Ao clicar em Pagar, você verá as opções de resposta para o integrador.

• Sucesso: Simula uma operação de pagamento bem-sucedida e retorna os dados correspondentes.
• Cancelado: Interrompe a operação de pagamento.
• Erro: Retorna uma falha genérica na operação de pagamento.

3. Ao selecionar uma dessas opções de resposta, o resultado é enviado ao sistema integrado e nossa aplicação é movida para o plano de fundo.

Além da operação de pagamento, oferecemos suporte a diversas funcionalidades, como: cancelamento de pedidos; consulta de métodos de pagamento disponíveis (Crédito, Débito, Pix, entre outros); e consulta de pedidos criados, tanto individualmente quanto em formato de lista.

Em seguida, você aprende como funciona a simulação do fluxo de cancelamento de pagamentos.

Cancelando pagamentos

É possível simular a requisição de cancelamento de um pagamento realizado para um pedido específico. No exemplo abaixo, demonstramos esse fluxo.

1. Ao clicar em Cancelar Ordem, o emulador exibe uma tela com os detalhes da transação.

2. Em seguida, basta clicar em Confirmar Cancelamento para prosseguir.

3. Após confirmar o cancelamento do pagamento, serão exibidas as opções de resposta para o sistema integrador. Basta selecionar o tipo de resposta desejado.

Realizando teste de impressão

1. Para realizar testes de impressão, selecione o tipo de conteúdo que deseja imprimir: texto simples ou imagem (como QR code ou código de barras).

2. Em seguida, selecione o cenário de resposta você deseja simular: Impressão realizada, Erro na impressão ou Sem papel.

Se você deseja manter sempre a mesma resposta para todas as chamadas futuras, basta marcar a opção Não perguntar novamente. Com essa opção ativada, as próximas respostas serão automaticamente definidas com base na última escolha feita.

Caso queira alterar esse comportamento e configurar uma nova resposta automática, é necessário retornar à tela de boas-vindas e acessar o botão Configurações. Nessa tela, você pode:

• Habilitar a opção Perguntar sempre, retornando ao cenário padrão em que a tela de opções é exibida a cada chamada de impressão;
• Ou escolher uma nova resposta automática, conforme sua preferência.

Solicitando uma Cielo Smart

Para solicitar uma Cielo Smart para testes e publicação de aplicativos, siga os passos abaixo:

1. Acesse o canal de Suporte Desenvolvedores Cielo e selecione a opção Cielo Smart LIO.

2. Em seguida, clique em Envie sua pergunta.

3. Para dar continuidade a sua solicitação, será necessário realizar o login. Para isso, insira seu login e senha. Então, confirme que não é um robô e clique em Entrar.

4. No campo para escolher o tipo de solicitação, selecione o Solicitação de terminal (com modo Debug).

5. Ao selecionar essa opção, novos campos irão aparecer e você deve preenchê-los. Ao finalizar o preenchimento, clique em Enviar.

6. Após enviar sua solicitação, aguarde o recebimento do terminal Cielo Smart.

Em posse do terminal Cielo Smart, você deverá ativá-lo. Clique aqui para aprender como fazer isso.

Ativando uma Cielo Smart

Após solicitar um terminal Cielo Smart, você deve ativá-lo.

Antes de iniciar o processo de ativação, certifique que atende aos pré-requisitos abaixo:

• Mensagem na tela do terminal: Verifique se aparece a seguinte mensagem “Cuidado: Modo de desenvolvimento. Transação de pagamento proibida”. Caso essa mensagem não esteja visível, entre em contato com o suporte.
• Carga da bateria: O terminal deve estar com pelo menos 50% de carga. Isso garante que o processo ocorra sem interrupções e permite que atualizações sejam realizadas com sucesso.
• Conexão com a internet: Certifique-se de que o terminal está conectado a uma rede estável.

Siga o passo-a-passo abaixo para completar o processo de ativação:

1. Abra um chamado clicando aqui para receber informações que serão essenciais no processo de ativação, como o CNPJ fictício gerado pelo time de suporte e número lógico.

2. Em seguida, ligue o terminal e, na tela de boas vindas, clique em Vamos lá.

3. Escolha o modo de conexão desejado, configurando uma rede Wi-Fi ou prosseguindo com a conexão via 4G.

4. Acesse o menu de opções clicando nos três pontinhos no canto superior direito da tela.

5. Selecione a opção Acessar funções técnicas. Em seguida, clique em Prosseguir para continuar.

6. No campo para digitar o número da função desejada, digite 69 e clique em Executar função.

7. Para descobrir a senha ambiente, acesse o Dev Console. Então, clique Meus aplicativos > Apps privados > Ver detalhes > Desinstalar app. Assim, você vai visualizar a senha.

8. Em seguida, selecione o ambiente Certificação para configurar o ambiente.

9. Na tela de Funções técnicas, clique em Cancelar para retornar à tela de preenchimento de CPF/CNPJ.

10. Identifique-se digitando o CNPJ fornecido pelo time Cielo e clique em Continuar.

11. Confirme o seu cadastro clicando na opção Sim para que o processo de inicialização e desbloqueio seja realizado.

Você completou o processo e Sua Cielo Smart foi ativada!

Recursos indisponíveis e sugestões de substitutos

Para garantir desempenho, segurança e estabilidade, o sistema Android da Cielo Smart. Como parte dessa personalização, alguns recursos padrão foram removidos. É importante estar ciente dessas limitações ao planejar e construir seus aplicativos.

Abaixo, seguem os recursos removidos da Cielo Smart:

• Google Play Services: Todos os serviços, APIs e apps do Google foram removidos do sistema operacional. Isso significa que bibliotecas que dependem do Google Play Services não funcionarão na Cielo Smart.
• Componente Webview: O WebView foi removido para evitar vulnerabilidades de segurança. Essa decisão impede que aplicativos acessem links ou conteúdos externos diretamente pela interface visual.

Abaixo, você encontra nossas sugestões de recursos substitutos aos que foram removidos:

APKs removidas dos terminais da Cielo Smart

Abaixo, segue uma tabela com todas as APKs que foram removidas dos terminais da Cielo Smart:

PUBLICANDO UM APLICATIVO

Jornada de publicação de um aplicativo

Está começando sua jornada e quer saber como disponibilizar seu aplicativo na Cielo Smart? Este guia foi criado para ajudar você a entender os principais passos para publicar seu aplicativo!

Para disponibilizar seu aplicativo na Cielo Smart, você precisa garantir que ele esteja pronto para atender às necessidades dos clientes com qualidade e segurança. Com este guia, você tem os recursos necessários para dar os primeiros passos com confiança.

O processo de disponibilização do aplicativo varia conforme o tipo de loja escolhida, podendo ser loja pública ou privada.
Para conferir o passo a passo detalhado de cada cenário, acesse os guias abaixo:

• Publicação do aplicativo em uma loja pública
• Publicação do aplicativo em uma loja privada

Cielo Store Dev Console

O Dev Console é a plataforma oficial da Cielo para upload, gerenciamento e distribuição de aplicativos desenvolvidos para os terminais Cielo Smart.

Entre as funcionalidades disponíveis no Dev Console estão:

• Envio de aplicativos para análise e publicação.
• Visualização e controle de todos os aplicativos cadastrados, públicos ou privados.
• Distribuição personalizada para estabelecimentos comerciais via loja privada.
• Acompanhamento do status de certificação.

Todo aplicativo submetido ao Dev Console passa pelo processo de certificação e é avaliado por uma equipe técnica especializada. A certificação é obrigatória para publicação na Cielo Store (loja pública) ou para distribuição via loja privada para parceiros comerciais.

Acessando o Dev Console

1. Clique aqui para acessar o Dev Console.

2. Caso seja o seu primeiro acesso, clique em Criar Conta.

3. Agora você já pode iniciar o processo de submissão do seu aplicativo.

Tipos de loja na Cielo Store

A Cielo Store é a plataforma oficial de distribuição de aplicativos para os terminais Cielo LIO. Ao desenvolver um aplicativo para esse ecossistema, é fundamental entender os dois modelos de publicação disponíveis: loja pública e loja privada. Cada uma atende a diferentes necessidades de negócio e possui requisitos específicos de certificação e distribuição.

Loja pública

A loja pública é voltada para aplicativos que podem ser utilizados por qualquer estabelecimento comercial que possua um terminal Cielo Smart. Após a aprovação técnica e de segurança, o aplicativo é disponibilizado na Cielo Store e pode ser instalado por qualquer cliente Cielo.

As principais características das lojas públicas são:

• Visibilidade ampla: disponível para todos os usuários da plataforma.
• Certificação obrigatória: o aplicativo passa por uma análise técnica rigorosa antes da publicação.
• Recebimento de pagamentos: o desenvolvedor pode monetizar o aplicativo e receber valores pelas transações realizadas.
• Atualizações controladas: qualquer nova versão precisa passar novamente pelo processo de certificação.

As lojas públicas são ideais para soluções com aplicação geral, como gestão de vendas, controle de estoque, fidelização de clientes, entre outros.

Clique aqui para aprender como realizar o upload de um aplicativo em loja pública.

Loja Privada

A loja privada é destinada à distribuição de aplicativos para um grupo específico de estabelecimentos comerciais. Essa modalidade é indicada para soluções personalizadas, desenvolvidas sob demanda ou para uso interno de parceiros da Cielo.

As principais características das lojas privadas são:

• Distribuição restrita: o aplicativo é visível apenas para os ECs (Estabelecimentos Comerciais) autorizados.
• Certificação obrigatória: mesmo sendo privada, o app precisa atender aos critérios técnicos da Cielo.
• Controle de acesso: o desenvolvedor define quais ECs terão acesso ao aplicativo.
• Flexibilidade de uso: ideal para soluções customizadas ou integradas a sistemas proprietários.

A loja privada é recomendada para parceiros que desejam distribuir aplicativos exclusivos para seus clientes ou para uso interno em operações comerciais específicas.

Clique aqui para aprender como realizar o upload de um aplicativo em loja pública.

Status de um aplicativo

Durante o processo de publicação de um aplicativo, ele passará pelos seguintes status no Dev Console:

• Assinatura
• Desenvolvimento
• Certificação
• Piloto/Produção

Assinatura

Após realizar o upload de um novo aplicativo ou uma nova versão do aplicativo, ele fica automaticamente com o status Aguardando assinatura.

Neste estágio, o aplicativo será assinado para atender regra de segurança/PCI para que possa ser executado nos terminais.

Desenvolvimento

Após ser assinado, o aplicativo fica automaticamente com o status Em desenvolvimento. Neste estágio, você consegue realizar testes do aplicativo na Cielo Smart. Caso precise fazer alguma correção, basta publicar uma nova versão do aplicativo no Dev Console e atualizar no terminal.

Clique aqui para aprender como solicitar um terminal para testar seu aplicativo ou como utilizar o Emulador Cielo.

Certificação

Com os testes finalizados, o próximo passo é enviar o aplicativo para certificação. Nessa fase, o time especializado da Cielo irá validar o funcionamento do app.

Clique aqui para conferir as boas práticas e entender o que é permitido e o que é proibido nos aplicativos públicos e privados da Cielo Smart.

Assim que o envio para certificação é realizado, o aplicativo passa automaticamente para o status Aguardando certificação. O processo pode levar até 48 horas úteis. Você será notificado por e-mail assim que a certificação for concluída.

Piloto/Produção

Assim que o aplicativo for aprovado na etapa de certificação, o desenvolvedor poderá seguir com a publicação. Existem duas opções:

• Promover para produção: Disponibiliza o aplicativo para todos os usuários da loja pública da Cielo Smart.
• Promover para piloto (apenas para aplicativos privados): Permite liberar o aplicativo para um grupo restrito de terminais, ideal para testes em ambiente real antes da liberação completa.

Essa escolha depende do tipo de aplicativo (público ou privado) e da estratégia de lançamento definida pelo desenvolvedor.

Boas práticas para publicação de aplicativos

Para que um aplicativo seja aprovado na certificação da Cielo Smart, é fundamental que ele esteja em conformidade com as regras, critérios técnicos e de segurança definidos pela Cielo. Este guia apresenta as boas práticas recomendadas para garantir que o processo de certificação ocorra de forma eficiente e sem impedimentos, tanto para aplicativos públicos quanto privados.

Boas práticas para publicar aplicativos públicos e privados

• Realize todos os testes necessários em ambiente de desenvolvimento antes de encaminhar a versão para certificação. Clique aqui para aprender como baixar o emulador.
• Certifique-se de que o processo de cadastro no aplicativo seja simples e acessível para o cliente.
• Complete corretamente os formulários aos submeter uma versão do aplicativo. Todos os campos obrigatórios devem ser preenchidos. A ausência de informações pode resultar na reprovação do aplicativo.
• O vídeo que será exibido na vitrine do app deve estar hospedado no YouTube com visibilidade definida como “Público” ou “Não listado”. Vídeos “Privados” não serão aceitos.
• A versão enviada para certificação deve ser superior à versão anterior. Por exemplo, se a versão anterior era 1.0, a nova versão deve ser 1.1 ou superior.
• Caso o aplicativo utilize WebView, a URL não deve ser exibida ou disponibilizada para alteração dentro do app.
• Certifique-se de que o fluxo de pagamento funcione corretamente em todos os cenários.
• Imagens, ícones e screenshots devem estar formato correto e elegível
• Mantenha seu aplicativo sempre atualizado com as versões mais recentes do SDK. Confira as versões disponíveis no menu SDK Cielo disponível na Cielo Store Dev Console.

O que os aplicativos públicos e privados não podem conter?

• ❌ Nome ou logotipo da Cielo;
• ❌ Linguagem ofensiva;
• ❌ Imagens inapropriadas;
• ❌ Referências visuais ou textuais a concorrentes.

Enquanto algumas boas práticas são comuns a aplicativos públicos e privados, outras são específicas para cada tipo de loja. Abaixo, listamos boas práticas específicas para aplicativos públicos.

Boas práticas para aplicativos públicos

• Preencha corretamente os termos de uso, detalhando as regras e condições do serviço oferecido.
• O aplicativo deve estar disponível para todos os clientes da Cielo Store, sem restrições.
• O app público não pode conter integração com sistemas ERP nem acesso restrito e personalizado voltado exclusivamente para um cliente.

Em seguida, estão listadas boas práticas específicas para aplicativos privados.

Boas práticas para aplicativos privados

• O aplicativo deve oferecer acesso restrito, direcionado exclusivamente ao cliente em questão.
• É possível conectar o aplicativo a sistemas de gestão empresarial (ERP), conforme a necessidade do cliente.
• Caso o aplicativo seja executado em um servidor local, é obrigatório o envio de um vídeo demonstrando o fluxo completo do app.

Loja Pública

A loja pública é voltada para aplicativos que podem ser utilizados por qualquer estabelecimento comercial que possua um terminal Cielo Smart. Após a aprovação técnica e de segurança, o aplicativo é disponibilizado na Cielo Store e pode ser instalado por qualquer cliente Cielo.

Agora, você vai aprender como publicar um aplicativo em uma loja pública.

Publicando um aplicativo em uma loja pública

Siga os passos abaixo para publicar um novo aplicativo público:

1. Acesse o Dev Console.
2. Uma vez logado, no topo superior direito, clique em + Aplicativo. 3. Clique em Subir na Cielo Store.

4. Ao selecionar essa opção, você verá uma lista de pré-requisitos necessários para realizar o upload do seu aplicativo nas etapas seguintes. Clique em Continuar.

Realizando o upload do aplicativo: Preenchendo formulários

Para realizar o upload do aplicativo, você passará por cinco etapas:

1. Na seção Upload do apk, faça o upload do arquivo .apk clicando em Selecionar arquivo. Em seguida, clique em Salvar e continuar.

2. Na seção Sobre o aplicativo, preencha os seguintes campos: Descrição resumida, Descrição principal, Segmento do aplicativo, além de adicionar um vídeo de apresentação, ícone e capturas de tela. Essas informações serão exibidas na Cielo Store.

3. Em seguida, na seção Modelo de cobrança, defina se o aplicativo será gratuito, se terá um valor fixo ou será cobrado por assinatura mensal. Caso opte pelo modelo pago, informe o Nome do plano, o Valor e uma Descrição do plano. Após preencher todos os campos, clique em Salvar.

O plano gratuito não possui qualquer custo para o usuário; o fixo envolve um pagamento único, com gratuidade no primeiro mês após a compra inicial; e o mensal consiste em uma cobrança recorrente a cada mês, também oferecendo o primeiro mês gratuitamente na primeira aquisição.

4. Na seção Suporte, preencha os campos Nome da empresa, E-mail, Site, Celular, Telefone e Termos e condições de uso. Então, clique em Salvar e continuar.

5*. Na seção **Certificação, preencha os campos de Versão do SDK e, se o aplicativo tiver login, complete os campos de Usuário, Senha e Informações adicionais para o time Cielo conseguir acessar. Então, clique em Salvar e continuar.

Pronto! Seu aplicativo foi submetido e agora passará pelo processo de certificação para ser aprovado.

Testando um aplicativo

Após ser assinado, o aplicativo fica automaticamente com o status Em desenvolvimento. Neste estágio, você consegue realizar testes do aplicativo na Cielo Smart. Caso precise fazer alguma correção, basta publicar uma nova versão do aplicativo no Dev Console e atualizar no terminal.

Para testar um aplicativo na Cielo Smart, você deve:

1. No Dev Console, acesse Meus aplicativos e clique em Ver detalhes do aplicativo.

2. Clique em Detalhes.

3. Clique em Baixar App.

4. Escolha o tipo de terminal em que o QR Code será gerado.

1. Abra o aplicativo Test Your App no terminal e escaneie o QR Code gerado no Dev Console.

2. Após a leitura do QR Code, o download do app será realizado.

Enviando um aplicativo para Cielo Store

Após o aplicativo público ser certificado, você deve promover seu aplicativo para produção.

Para fazer isso, acesse o menu Meus aplicativos, na aba Apps públicos. Então, clique em Ver detalhes do aplicativo.

Na aba Versões, clique em Enviar para produção.

Após enviado para produção, o aplicativo será disponibilizado na Cielo Store para os clientes realizarem o download do aplicativo.

Fazendo alterações em aplicativos públicos

Caso realize alguma alteração no aplicativo público, você deve fazer o upload de uma nova versão do aplicativo e utilizar a mesma assinatura da versão anterior.

Para fazer isso, siga o passo-a-passo abaixo:

1. No Dev Console, acesse o menu superior Meus aplicativos e na aba Apps públicos, clique em Ver detalhes do aplicativo.

2. Então, clique no botão + Nova versão para fazer o upload de uma nova versão.

Ao realizar uma alteração, siga os critérios abaixo:

• Garanta que a versão mais recente do aplicativo tenha o mesmo package name da versão anterior;
• Altere o version code e o version name dentro do arquivo manifest do aplicativo;
• Confira ou atualize as informações dos formulários e preencha os dados para certificação.

Compra e download de aplicativos públicos na Cielo Store

A Cielo Store oferece uma variedade de aplicativos públicos que podem ser instalados diretamente nos terminais Cielo Smart. A seguir, veja como realizar a compra e o download desses aplicativos.

Os aplicativos públicos certificados e promovidos para produção pelos desenvolvedores ficam disponíveis na Cielo Store, acessível diretamente nos terminais Cielo Smart.

Para adquirir um aplicativo, o lojista deve:

1. No terminal Cielo Smart, clique em Apps e em seguida selecione a Cielo Store caso estejando utilizando o terminal L300. Se estiver usando o terminal DX8000, clique diretamente em Cielo Store no menu inferior.

2. Selecione o aplicativo desejado.

3. Clique em Instalar ou Comprar.

4. Informe as credenciais utilizadas no site da Cielo para autenticação e cobrança.

Após a confirmação da compra ou instalação, o aplicativo estará disponível para uso na Cielo Smart.

Loja Privada

A loja privada é destinada à distribuição de aplicativos para um grupo específico de estabelecimentos comerciais. Essa modalidade é indicada para soluções personalizadas, desenvolvidas sob demanda ou para uso interno de parceiros da Cielo.

Criando uma loja privada

Se você optou por publicar seu aplicativo em uma loja privada, será necessário criar uma loja para o envio do app.

Para fazer isso, siga o passo-a-passo abaixo:

1. Acesse o Dev Console e clique em Lojas privadas.

2. Clique em + Criar loja privada.

3. Digite o nome da loja e clique em Concluir.

Pronto! Sua loja privada foi criada.

Realizando o upload do aplicativo privado

Agora você pode seguir em frente e realizar o upload do seu aplicativo na sua loja privada.

Para fazer isso, siga o passo-a-passo abaixo:

1. No Dev Console, na aba Meus aplicativos, clique em + Aplicativo.

2. Clique em Subir na Loja Privada.

3. Ao selecionar essa opção, você verá uma lista de pré-requisitos necessários para realizar o upload do seu aplicativo nas etapas seguintes. Clique em Continuar.

Preenchendo formulários

Para realizar o upload do aplicativo, você precisará preencher formulários divididos em quatro etapas:

1. Na seção Upload do apk, faça o upload do arquivo .apk clicando em Selecionar arquivo. Em seguida, clique em Salvar e continuar.

2. Na seção Sobre o aplicativo, preencha os seguintes campos: Descrição resumida, Descrição principal, Segmentos, além de adicionar um vídeo e ícone. Essas informações serão exibidas na loja privada.

3. Em seguida, na seção Suporte, preencha os campos Nome da empresa, E-mail, Site, Celular e Telefone. Então, clique em Salvar e continuar.

4. Na seção Certificação, preencha os campos de Versão do SDK e, se o aplicativo tiver login, complete os campos de Usuário, Senha e Informações adicionais para o time Cielo conseguir acessar. Por fim, insira a URL de vídeo para homologação bem como o comprovante de transação. Então, clique em Salvar e concluir.

Pronto! Seu aplicativo foi submetido e agora passará pelo processo de certificação para ser aprovado.

Após o aplicativo ser aprovado e promovido para produção, o app ficará disponível para os clientes associados à loja privada selecionada.

Criando um piloto para um aplicativo privado

Antes de liberar uma nova versão de um aplicativo privado em produção, é altamente recomendável realizar um piloto. Essa etapa permite validar o funcionamento da versão em ambiente real, com controle sobre os estabelecimentos que irão recebê-la.

Entre os benefícios do piloto estão:

• Validação em ambiente produtivo: Teste a versão do aplicativo diretamente em máquinas específicas, garantindo que tudo funcione como esperado antes da liberação geral.
• Testes paralelos de versões: É possível executar pilotos com diferentes versões simultaneamente, facilitando comparações e ajustes antes da publicação definitiva.

Siga o passo-a-passo abaixo para criar um piloto:

1. No Dev Console, clique em Meus aplicativos. Na aba Apps privados, clique em Ver detalhes do aplicativo.

2. Clique em Publicar.

3. Selecione a opção Criar Piloto.

4. Adicione os ECs (Estabelecimentos Comerciais) e/ou EC Lógico que irão receber a versão piloto.

Enviando um aplicativo privado para produção

Após a criação do piloto para o aplicativo privado, para que todos os ECs vinculados à loja recebam o aplicativo, siga os passos abaixo:

1. No Dev Console, clique em Meus aplicativos. Na aba Apps privados, clique em Ver detalhes do aplicativo.

2. Clique em Publicar.

3. Selecione a opção Publicar em produção.

Após ter publicado o aplicativo em produção, você deve distribuir os aplicativos nas lojas privadas associadas aos ECs que devem acessar o app.

Distribuindo aplicativos na loja privada

Enquanto aplicativos de loja pública são disponibilizados na Cielo Store, aplicativos privados são distribuídos aos estabelecimentos específicos.

Para distribuir o aplicativo apenas para clientes específicos, você deve associar o Estabelecimento Comercial (EC) do cliente a sua loja privada. Somente o desenvolvedor que realizou a publicação do aplicativo poderá gerenciar a distribuição dos aplicativos da loja aos ECs do cliente.

Associando o EC a uma loja privada

1. Acesse no menu Lojas Privadas. 2. Você verá uma lista com as lojas privadas disponíveis, incluindo a data de criação e os ECs associados.

3. Para associar novos ECs, clique no botão + Associar ECs correspondente à loja desejada.

4. Digite todos os ECs que serão associados àquela loja. Você tem duas opções para incluir os ECs a serem associados:

• Digitar ECs manualmente: Associe estabelecimentos à loja privada digitando os números de ECs manualmente.

• Enviar planilha: Use nosso modelo de planilha para informar e associar vários números de EC de uma vez.

5. Após incluir os ECs a serem associados, clique em Concluir para finalizar o processo.

Desassociando EC de uma loja privada

1. Para desassociar uma EC de uma loja privada, no Dev Console, acesse a aba Lojas privadas. 2. Então, clique em Ver ECs referente a loja desejada.

3. Para desassociar uma EC individual, clique no botão Desassociar ao lado da EC desejada.

Fazendo alterações em aplicativos privados

Caso realize uma alteração ou atualização no aplicativo privado, você deverá fazer o upload de uma nova versão do aplicativo e utilizar a mesma assinatura da versão anterior.

1. Para isso, no Dev Console, clique em Meus aplicativos. 2. Na aba Apps privados, clique em Ver detalhes do aplicativo. 3. Clique no botão + Nova versão para fazer o upload de uma nova versão.

Ao realizar uma alteração, siga os critérios abaixo:

• Garanta que a versão mais recente do aplicativo tenha o mesmo package name da versão anterior;
• Altere o “version code” e o “version name” dentro do arquivo manifest do aplicativo;
• Confira ou atualize as informações dos formulários e preencha os dados para certificação.

Download de aplicativos privados

A Cielo Smart possui uma rotina automática que identifica e realiza o download ou atualização dos aplicativos privados necessários em cada terminal.

Para que esse processo ocorra corretamente, o terminal deve estar com a bateria acima de 50% e conectado à internet, seja via Wi-Fi ou rede 3G.

Desinstalando um aplicativo privado

A desinstalação de um aplicativo privado deve ser feita diretamente pelo cliente.

Para isso, é necessário primeiro desassociar o estabelecimento comercial (EC) da loja privada correspondente.

Após essa etapa, o cliente pode seguir com o processo de desinstalação conforme as instruções seguintes.

LIO ON (V3):

1. Acesse Ajuda > Ajustes > Apps. 2. Digite a senha (disponível no Dev Console). 3. Escolha o app e em seguida a opção Desinstalar.

Cielo Smart (DX8000):

1. Acesse Configurações > Atualização de software. 2. Selecione o menu no topo e em seguida Mostrar demais apps. 3. Escolha o app e selecione a opção Desinstalar. 4. Digite a senha (disponível no Dev Console).

Configurando um aplicativo: Frente de caixa e Aplicativo padrão

Você pode configurar seu aplicativo na Cielo Smart como Frente de Caixa e/ou como Aplicativo Padrão, garantindo uma experiência de pagamento mais integrada e exclusiva.

• Frente de caixa: Ao ativar essa opção, seu aplicativo será iniciado automaticamente assim que a máquina for ligada. Todas as transações serão realizadas por ele, desde que o cliente o configure como app de vendas.
• Aplicativo padrão: Ao selecionar essa opção, somente o seu aplicativo poderá realizar pagamentos, bloqueando o uso da interface de pagamento padrão da Cielo Smart.

Frente de caixa

Siga o passo-a-passo abaixo para configurar seu aplicativo como frente de caixa:

1. No Dev Console, clique em Apps públicos ou em Apps privados, depois em Ver detalhes do aplicativo desejado.

2. Clique em Configurar app.

3. Selecione a opção Frente de caixa.

Ao habilitar somente esta opção, o cliente deverá configurar o seu aplicativo na Cielo Smart para que todas as transações sejam realizadas através desse aplicativo.

Oriente o seu cliente para seguir o passo-a-passo abaixo para realizar a configuração em seu terminal:

• LIO (L300): Ajuda > Minha Lio > App padrão de vendas
• DX8000: Abra o aplicativo Cielo Router na tela inicial > Selecione o seu app

Frente de caixa + Aplicativo padrão

Ao habitar as opções Frente de caixa e Aplicativo padrão, todas as Cielo Smart que possuem esse aplicativo instalado conseguirão transacionar somente pelo aplicativo.

1. No Dev Console, clique em Apps privados, depois em Ver detalhes do aplicativo desejado.

2. Clique em Configurar app.

3. Habilite as opções Frente de caixa e Aplicativo padrão.

Intent para recebimento do valor da venda

Ao submeter seu aplicativo, a intent informada deve apontar para a tela inicial de vendas do app.

Essa intent permite que o aplicativo receba o valor da transação quando o usuário inicia uma venda pelo App Cielo Vender (aplicativo padrão da Cielo), em vez de utilizar diretamente o seu aplicativo como padrão.

A intent será chamada em dois cenários:

• Quando o aplicativo estiver definido como aplicativo padrão e o Pinpad for conectado.
• Quando uma transação for iniciada por meio do App Cielo Vender, mesmo que o seu aplicativo esteja marcado como padrão. Nesse caso, o valor da venda será enviado como um extra na intent.

Configurando a intent e o parâmetro

Para configurar a intent e o parâmetro:

1. Certifique-se de que o aplicativo está marcado como Frente de Caixa e Aplicativo Padrão.

2.Clique no botão Frente de Caixa para acessar a tela de configuração.

3. Informe a intent e, se necessário, o parâmetro para recebimento do valor da venda.

INTEGRAÇÃO VIA DEEPLINK

A Cielo disponibiliza uma integração baseada em intents Android, permitindo que aplicativos se comuniquem diretamente com funcionalidades do terminal por meio de deep links. Essa abordagem facilita a execução de ações como pagamentos, cancelamentos e impressão de comprovantes, de forma rápida e segura, sem a necessidade de SDKs complexos ou dependência direta de APIs.

Exemplo de código

Disponiblizamos dois exemplos em diferentes linguagens para auxiliar no desenvolvimento:

• Acesse o nosso projeto de exemplo em React Native
• Acesse o nosso projeto de exemplo em Flutter

Gerenciando credenciais

Para integrar sua aplicação com os serviços da Cielo via deep links, é necessário obter credenciais de autenticação: o Client-ID e o Access Token.

Todo o processo de cadastro é feito pelo Portal de Desenvolvedores da Cielo. Siga os passos abaixo:

1. Acesse o Portal de desenvolvedores e clique aqui para ir diretamente para a página de cadastro de aplicativo.

2. Preencha os campos obrigatórios, incluindo: Ícone do aplicativo, Nome, Descrição.

3. Selecione a API desejada entre as opções disponíveis.

4. Clique em Registrar para concluir o processo.

Consultando credenciais de autenticação

Agora que você registrou suas credenciais de autenticações, você pode consultá-las clicando em Perfil > Client-IDs Cadastrados.

Você será redirecionado para uma tela que exibirá o Client ID. Para ver o Access Tokens, clique em detalhes.

Configurando o AndroidManifest.xml

É necessário definir um contrato de resposta com a Cielo Smart para que ela possa responder após o fluxo de pagamento, cancelamento e/ou impressão. Esse contrato deve ser definido no manifest.xml da aplicação conforme o exemplo abaixo:

<activity android:name=".ResponseActivity">
  <intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <data android:host="response" android:scheme="order" />
  </intent-filter>
</activity>

Os nomes utilizados nos campos, como response e order, são apenas exemplos e podem ser adaptados conforme a estrutura e a lógica do seu aplicativo. No entanto, é importante garantir que os mesmos nomes sejam utilizados na chamada de pagamento para que o callback da Cielo Smart funcione corretamente.

Códigos de erro

Durante o envio de requisições via deeplink, o uso de parâmetros incorretos ou incompletos pode resultar em falhas. Quando isso ocorre, o sistema retorna mensagens de erro como resposta, com o objetivo de ajudar na identificação e correção do problema.

Aqui, reunimos os principais códigos de erro que podem surgir durante o uso de deeplinks e suas causas.

Os erros retornados aparecem no formato Base64, como no exemplo abaixo:

order://response?response=eyJjb2RlIjoxLCJyZWFzb24iOiJDQU5DRUxBRE8gUEVMTyBVU1XDgVJJTyJ9&responsecode=0

Após a decodificação da string Base64, o conteúdo é convertido em um objeto JSON estruturado, que facilita a interpretação do erro:

{ 
   "code":1, 
   "reason":"CANCELADO PELO USUÁRIO" 
}

Próximo ao código numérico de erro code, a chave reason explica de forma mais específica o que causou o erro.

Entre os principais códigos de erro identificados na integração via deeplink, destacam-se os seguintes:

Pagamento

Para realizar um pedido de pagamento, é necessário criar um JSON seguindo o formato especificado e, em seguida, convertê-lo para Base64 antes de enviá-lo ao terminal.

{
  "accessToken": "Seu Access-token",
  "clientID": "Seu Client-id",
  "reference": "Referência do pedido", /* Não obrigatório */
  "merchantCode": "Em caso de MULTI-EC", /* Não obrigatório */
  "email": "emaildocliente@email.com",
  "installments": 0,
  "items": [
    {
      "name": "Geral",
      "quantity": 1,
      "sku": "10",
      "unitOfMeasure": "unidade",
      "unitPrice": 10
    }
  ],
  "paymentCode": "DEBITO_AVISTA",
  "value": "10"
}

Campos utilizados para envio

Pedidos de Subadiquirente

Quando o pagamento for realizado por meio de um subadquirente, é necessário incluir as informações específicas no campo subAcquirer dentro do JSON de requisição. Esses dados devem estar corretamente formatados para que o terminal processe o pagamento conforme esperado.

{
  "accessToken": "Seu Access-token",
  "clientID": "Seu Client-id",
  "email": "emaildocliente@email.com",
  "installments": 0,
  "items": [
    	{
      		"name": "Geral",
      		"quantity": 1,
      		"sku": "10",
      		"unitOfMeasure": "unidade",
      		"unitPrice": 10
    	}
  ],
  "paymentCode": "DEBITO_AVISTA",
  "value": "10",
  "subAcquirer": {
  	"softDescriptor": "softDescriptorValue",
  	"terminalId": "terminalIdValue",
 	 "merchantCode": "merchantCodeValue",
  	"city": "cityValue",
  	"telephone": "telephoneValue",
  	"state": "stateValue",
  	"postalCode": "postalCodeValue",
  	"address": "addressValue",
  	"identifier": "identifierValue",
  	"merchantCategoryCode": "merchantCategoryCodeValue",
  	"countryCode": "countryCodeValue",
  	"informationType": "informationTypeValue",
  	"document": "documentValue",
  	"businessName": "businessName",
	"ibgeCode": "00000000"
  }
}

Campos utilizados para envio

Todos os campos dentro do objeto subAcquirer devem ser preenchidos com valores do tipo texto (string). O preenchimento completo é obrigatório.

Caso algum campo esteja ausente, o terminal retornará um erro, conforme demonstrado abaixo:

{
    "code": 2,
    "reason": " Parâmetros inválidos: Json inválido"
}

Valores aceitos no campo paymentCode

Abaixo, você encontra a lista completa de valores aceitos no campo paymentCode, que devem ser utilizados na configuração da requisição de pagamento conforme o tipo de transação desejada.

Configurando a URI de pagamento

Para realizar uma chamada de pagamento utilizando a Cielo Smart, é necessário configurar corretamente a URI de pagamento.

Defina o contrato de resposta (host e scheme). Aqui será utilizada essa configuração no parâmetro urlCallback. A chamada de pagamento deve ser feita da seguinte forma:

var base64 = getBase64(jsonString)
var checkoutUri = "lio://payment?request=$base64&urlCallback=order://response"

Após preparar a URI, basta realizar a chamada de intent do Android utilizando o comando específico da linguagem híbrida.

var intent = Intent(Intent.ACTION_VIEW, Uri.parse(checkoutUri))
intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP)
startActivity(intent)

Recuperando dados do pagamento

Para recuperar os dados do pagamento, basta fazer o seguinte:

1. Na Activity de resposta, acesse a Intent recebida.

2. Use o parâmetro data da Intent para obter a URI com as informações da transação.

val responseIntent = intent
if (Intent.ACTION_VIEW == responseIntent.action) {
   val uri = responseIntent.data
   val response = uri.getQueryParameter("response")
   val data = Base64.decode(response, Base64.DEFAULT)
   val json = String(data)
}

Assim que o pagamento é concluído, a Cielo Smart envia uma resposta para a URI configurada previamente. Essa resposta será um JSON contendo os dados da transação, seguindo o formato exemplificado abaixo:

{
   "createdAt":"Jun 8, 2018 1:51:58 PM",
   "id":"ba583f85-9252-48b5-8fed-12719ff058b9",
   "items":[
      {
         "description":"",
         "details":"",
         "id":"898e7f40-fa21-42d0-94d4-b4e95c4fd615",
         "name":"cocacola",
         "quantity":2,
         "reference":"",
         "sku":"1234",
         "unitOfMeasure":"unidade",
         "unitPrice":250
      },
      {
         "description":"",
         "details":"",
         "id":"4baea4c2-5499-4783-accc-0f8904970861",
         "name":"pepsi",
         "quantity":2,
         "reference":"",
         "sku":"4321",
         "unitOfMeasure":"unidade",
         "unitPrice":280
      }
   ],
   "notes":"",
   "number":"",
   "paidAmount":1450,
   "payments":[
      {
         "accessKey":"XXXXXXXXXXXXXXX",
         "amount":1450,
         "applicationName":"com.ads.lio.uriappclient",
         "authCode":"140126",
         "brand":"Visa",
         "cieloCode":"799871",
         "description":"",
         "discountedAmount":0,
         "externalId":"6d5f6f86-7870-4aed-b79f-0a26d6c61743",
         "id":"bb9c6305-95e5-4024-8152-503d064c0224",
         "installments":0,
         "mask":"424242-4242",
         "merchantCode":"0000000000000003",
         "paymentFields":{
            "isDoubleFontPrintAllowed":"false",
            "hasPassword":"false",
            "primaryProductCode":"4",
            "isExternalCall":"true",
            "primaryProductName":"CREDITO",
            "receiptPrintPermission":"1",
            "isOnlyIntegrationCancelable":"false",
            "upFrontAmount":"0",
            "creditAdminTax":"0",
            "firstQuotaDate":"0",
            "isFinancialProduct":"true",
            "hasSignature":"true",
            "hasPrintedClientReceipt":"false",
            "hasWarranty":"false",
            "applicationName":"com.ads.lio.uriappclient",
            "interestAmount":"0",
            "changeAmount":"0",
            "serviceTax":"0",
            "cityState":"Barueri - SP",
            "hasSentReference":"false",
            "v40Code":"4",
            "secondaryProductName":"A VISTA",
            "paymentTransactionId":"6d5f6f86-7870-4aed-b79f0a26d6c61743",
            "avaiableBalance":"0",
            "pan":"424242-4242",
            "originalTransactionId":"0",
            "originalTransactionDate":"08/06/18",
            "secondaryProductCode":"204",
            "hasSentMerchantCode":"false",
            "documentType":"J",
            "statusCode":"1",
            "merchantAddress":"Alameda Grajau, 219",
            "merchantCode":"0000000000000003",
            "paymentTypeCode":"1",
            "hasConnectivity":"true",
            "productName":"CREDITO A VISTA - I",
            "merchantName":"POSTO ABC",
            "entranceMode":"141010104080",
            "firstQuotaAmount":"0",
            "cardCaptureType":"1",
            "totalizerCode":"0",
            "requestDate":"1528476655000",
            "boardingTax":"0",
            "applicationId":"cielo.launcher",
            "numberOfQuotas":"0",
            "document":"000000000000000"
         },
         "primaryCode":"4",
         "requestDate":"1528476655000",
         "secondaryCode":"204",
         "terminal":"69000007"
      }
   ],
"pendingAmount":0,
"price":1060,
"reference":"Order",
"status":"ENTERED",
"type”:”9”,
"updatedAt":"Jun 8, 2018 1:51:58 PM"
}

Exemplos de retorno: sucesso e erro

Segue exemplos de retorno com sucesso e erro nas operações via intent na integração híbrida. Lembrando que em ambos os cenários abaixos é o conteúdo da URI e o campo resonse está em formato Base64.

Retorno de sucesso

order://response?response=eyJjcmVhdGVkQXQiOiJKYW4gMzEsIDIwMjQgMTE6Mzc6MjYgQU0iLCJpZCI6IjFkYjU1NzdmLWZjZDAtNDllOC04Y2FjLTVlMjRhYWZiMjUxZiIsIml0ZW1zIjpbeyJkZXNjcmlwdGlvbiI6IiIsImRl
dGFpbHMiOiIiLCJpZCI6IjkzMzA5ODkyLWMyMGItNDUyYy1iYTZmLTY4Mjc5NmI0YTk2ZSIsIm5hbWUiOiJwcm9kdXRvIiwicXVhbnRpdHkiOjEsInJlZmVyZW5jZSI6IiIsInNrdSI6IjQ2ODIiLCJ1bml0T2ZNZWFzdXJlIjoidW5pZGFkZSIsInVuaXRQcmljZSI6OTI1fV0sIm5vdGVzIjoiIiwibnVtYmVyIjoiIiwicGFpZEFtb3VudCI6OTI1LCJwYXltZW50cyI6W3siYWNjZXNzS2V5IjoiclNBcU5QR3ZGUEpJIiwiYW1vdW50Ijo5MjUsImFwcGxpY2F0aW9uTmFtZSI6ImNvbS5hZHMubGlvLnVyaWFwcGNsaWVudCIsImF1dGhDb2RlIjoiMTEzNzMwIiwiYnJhbmQiOiIiLCJjaWVsb0NvZGUiOiI4NDcyNjIiLCJkZXNjcmlwdGlvbiI6IiIsImRpc2NvdW50ZWRBbW91bnQiOjAsImV4dGVybmFsSWQiOiI0OGZhNjNjOS05NWVlLTQ4M2UtOWU3Yi1jZTMyNjMzZjEyOWIiLCJpZCI6IjgwY2U1MjhjLTJjY2MtNDgwMC1iZGMxLTViNWRkZGU1OGZiMSIsImluc3RhbGxtZW50cyI6MCwibWFzayI6IioqKioqKioqKioqKjAwMDAiLCJtZXJjaGFudENvZGUiOiIwMDAwMDAwMDAwMDAwMDAzIiwicGF5bWVudEZpZWxkcyI6eyJpc0RvdWJsZUZvbnRQcmludEFsbG93ZWQiOiJmYWxzZSIsImJpbiI6IjAiLCJoYXNQYXNzd29yZCI6ImZhbHNlIiwicHJpbWFyeVByb2R1Y3RDb2RlIjoiNCIsImlzRXh0ZXJuYWxDYWxsIjoidHJ1ZSIsInByaW1hcnlQcm9kdWN0TmFtZSI6IkNSRURJVE8iLCJyZWNlaXB0UHJpbnRQZXJtaXNzaW9uIjoiMSIsImlzT25seUludGVncmF0aW9uQ2FuY2VsYWJsZSI6ImZhbHNlIiwidXBGcm9udEFtb3VudCI6IjAiLCJjcmVkaXRBZG1pblRheCI6IjAiLCJleHRlcm5hbENhbGxNZXJjaGFudENvZGUiOiIwMDAwMDAwMDAwMDAwMDAzIiwiZmlyc3RRdW90YURhdGUiOiIwIiwiaXNGaW5hbmNpYWxQcm9kdWN0IjoidHJ1ZSIsImhhc1ByaW50ZWRDbGllbnRSZWNlaXB0IjoiZmFsc2UiLCJoYXNTaWduYXR1cmUiOiJmYWxzZSIsImFwcGxpY2F0aW9uTmFtZSI6ImNvbS5hZHMubGlvLnVyaWFwcGNsaWVudCIsImhhc1dhcnJhbnR5IjoiZmFsc2UiLCJpbnRlcmVzdEFtb3VudCI6IjAiLCJjaGFuZ2VBbW91bnQiOiIwIiwic2VydmljZVRheCI6IjAiLCJjaXR5U3RhdGUiOiJCYXJ1ZXJpIC0gU1AiLCJoYXNTZW50UmVmZXJlbmNlIjoiZmFsc2UiLCJ2NDBDb2RlIjoiNCIsInNlY29uZGFyeVByb2R1Y3ROYW1lIjoiQSBWSVNUQSIsInBheW1lbnRUcmFuc2FjdGlvbklkIjoiNDhmYTYzYzktOTVlZS00ODNlLTllN2ItY2UzMjYzM2YxMjliIiwiYXZhaWFibGVCYWxhbmNlIjoiMCIsInBhbiI6IioqKioqKioqKioqKjAwMDAiLCJvcmlnaW5hbFRyYW5zYWN0aW9uSWQiOiIwIiwib3JpZ2luYWxUcmFuc2FjdGlvbkRhdGUiOiIzMS8wMS8yNCIsInNlY29uZGFyeVByb2R1Y3RDb2RlIjoiMjA0IiwiZG9jdW1lbnRUeXBlIjoiSiIsImhhc1NlbnRNZXJjaGFudENvZGUiOiJmYWxzZSIsInN0YXR1c0NvZGUiOiIxIiwibWVyY2hhbnRBZGRyZXNzIjoiQWxhbWVkYSBHcmFqYXUsIDIxOSIsIm1lcmNoYW50Q29kZSI6IjAwMDAwMDAwMDAwMDAwMDMiLCJwYXltZW50VHlwZUNvZGUiOiIxIiwiaGFzQ29ubmVjdGl2aXR5IjoidHJ1ZSIsInByb2R1Y3ROYW1lIjoiQ1JFRElUTyBBIFZJU1RBIC0gSSIsIm1lcmNoYW50TmFtZSI6IlBPU1RPIEFCQyIsImVudHJhbmNlTW9kZSI6IjY2MTAxMDEwNzA4MCIsImNhcmRDYXB0dXJlVHlwZSI6IjYiLCJmaXJzdFF1b3RhQW1vdW50IjoiMCIsInRvdGFsaXplckNvZGUiOiIwIiwicmVxdWVzdERhdGUiOiIxNzA2NzEwMzg0NDAyIiwiYXBwbGljYXRpb25JZCI6ImNpZWxvLmxhdW5jaGVyIiwiYm9hcmRpbmdUYXgiOiIwIiwibnVtYmVyT2ZRdW90YXMiOiIwIiwiZG9jdW1lbnQiOiIwMDAwMDAwMDAwMDAwMCJ9LCJwcmltYXJ5Q29kZSI6IjQiLCJyZXF1ZXN0RGF0ZSI6IjE3MDY3MTAzODQ0MDIiLCJzZWNvbmRhcnlDb2RlIjoiMjA0IiwidGVybWluYWwiOiI2MjAwMDExMiJ9XSwicGVuZGluZ0Ftb3VudCI6MCwicHJpY2UiOjkyNSwicmVmZXJlbmNlIjoiUmVmZXJlbmNlIiwic3RhdHVzIjoiRU5URVJFRCIsInR5cGUiOiJQQVlNRU5UIiwidXBkYXRlZEF0IjoiSmFuIDMxLCAyMDI0IDExOjM3OjMxIEFNIn0=&responsecode=0

Retorno de erro

Se houver algum erro no pagamento, seja ele cancelado por usuário ou por saldo insuficiente, continuamos olhando para o campo response onde será retornando um Base64 com o motivo do pagamento não realizado com sucesso.

order://response?response=eyJjb2RlIjoxLCJyZWFzb24iOiJDQU5DRUxBRE8gUEVMTyBVU1XDgVJJTyJ9&responsecode=0

{
   "code":1,
   "reason":"CANCELADO PELO USUÁRIO"
}

Listagem de Pedidos

Na listagem de pedidos, é possível obter os pedidos (orders) abertas na Cielo Smart pelo aplicativo do parceiro. Para isso, basta definir o JSON abaixo e formata-lo para Base64:

{
“pageSize”: 5,
“page”: 0,
“clientID”: “seu cliente ID”,
“accessToken”: “seu access token”
}

A chamada deve ser feita da seguinte forma:

var base64 = getBase64(jsonString)
var checkoutUri = "lio://orders?request=$base64&urlCallback=order://response"

Para recuperar os dados da transação após o pagamento, basta acessar a Intent recebida na Activity de resposta, que deve estar registrada no seu AndroidManifest.xml. Em seguida, utilize o parâmetro data da Intent para obter a URI com as informações da transação:

val responseIntent = intent
if (Intent.ACTION_VIEW == responseIntent.action) {
   val uri = responseIntent.data
   val response = uri.getQueryParameter("response")
   val data = Base64.decode(response, Base64.DEFAULT)
   val json = String(data)
}

Exemplos de retorno da Listagem de Pedidos

Retorno de sucesso

orders://response?response=eyJjdXJyZW50UGFnZSI6MCwicmVzdWx0cyI6W3siY3JlYXRlZEF0IjoiQXByIDgsIDIwMjQgNDowNzo1OSBQTSIsImlkIjoiNTEyZjdjNjEtMjkzYy00NDY4LWJkM2UtMjk4Mjg2ZDA0ZjBiIiwiaXRlbXMiOlt7ImRlc2NyaXB0aW9uIjoiIiwiZGV0YWlscyI6IiIsImlkIjoiNjMyOWRiMTYtMzY4Ny00MmJjLTgzNWYtZmUwZGYxMGZjZGRmIiwibmFtZSI6InByb2R1dG8iLCJxdWFudGl0eSI6MywicmVmZXJlbmNlIjoiIiwic2t1IjoiNzg5NzIiLCJ1bml0T2ZNZWFzdXJlIjoidW5pZGFkZSIsInVuaXRQcmljZSI6NTY2fV0sIm5vdGVzIjoiIiwibnVtYmVyIjoiIiwicGFpZEFtb3VudCI6MTY5OCwicGF5
bWVudHMiOlt7ImFjY2Vzc0tleSI6InJTQXFOUEd2RlBKSSIsImFtb3VudCI6MTY5OCwiYXBwbGlj
YXRpb25OYW1lIjoiY29tLmFkcy5saW8udXJpYXBwY2xpZW50IiwiYXV0aENvZGUiOiIxNjA4NTEi
LCJicmFuZCI6IiIsImNpZWxvQ29kZSI6IjEwODE0NCIsImRlc2NyaXB0aW9uIjoiIiwiZGlzY291
bnRlZEFtb3VudCI6MCwiZXh0ZXJuYWxJZCI6IjZiYmI2ZDhhLTQ5NWYtNDY3MC04MzVmLWY4YWNlYjlkZTA2OCIsImlkIjoiNWU2MmFmNGMtNzM5ZC00Zjc4LWFhYjgtNWQxNDE5NmIwN2I2IiwiaW5zdGFsbG1lbnRzIjowLCJtYXNrIjoiKioqKioqKioqKjQyNDIiLCJtZXJjaGFudENvZGUiOiIwMDEw
MDAwMjQ0NDcwMDAxIiwicGF5bWVudEZpZWxkcyI6eyJpc0RvdWJsZUZvbnRQcmludEFsbG93ZWQiOiJ0cnVlIiwiYmluIjoiNDI0MjQyIiwiaGFzUGFzc3dvcmQiOiJ0cnVlIiwicHJpbWFyeVByb2R1
Y3RDb2RlIjoiNCIsImlzRXh0ZXJuYWxDYWxsIjoidHJ1ZSIsInByaW1hcnlQcm9kdWN0TmFtZSI6
IkNSRURJVE8iLCJyZWNlaXB0UHJpbnRQZXJtaXNzaW9uIjoiMSIsImlzT25seUludGVncmF0aW9u
Q2FuY2VsYWJsZSI6ImZhbHNlIiwidXBGcm9udEFtb3VudCI6IjAiLCJjcmVkaXRBZG1pblRheCI6
IjAiLCJleHRlcm5hbENhbGxNZXJjaGFudENvZGUiOiIwMDEwMDAwMjQ0NDcwMDAxIiwiZmlyc3RRdW90YURhdGUiOiIwIiwiaXNGaW5hbmNpYWxQcm9kdWN0IjoidHJ1ZSIsImhhc1ByaW50ZWRDbGllbnRSZWNlaXB0IjoiZmFsc2UiLCJoYXNTaWduYXR1cmUiOiJmYWxzZSIsImFwcGxpY2F0aW9uTmFtZSI6ImNvbS5hZHMubGlvLnVyaWFwcGNsaWVudCIsImhhc1dhcnJhbnR5IjoiZmFsc2UiLCJpbnRlcmVzdEFtb3VudCI6IjAiLCJjaGFuZ2VBbW91bnQiOiIwIiwic2VydmljZVRheCI6IjAiLCJjaXR5
U3RhdGUiOiJCYXJ1ZXJpIC0gU1AiLCJoYXNTZW50UmVmZXJlbmNlIjoiZmFsc2UiLCJ2NDBDb2Rl
IjoiNCIsInNlY29uZGFyeVByb2R1Y3ROYW1lIjoiQSBWSVNUQSIsInBheW1lbnRUcmFuc2FjdGlv
bklkIjoiNmJiYjZkOGEtNDk1Zi00NjcwLTgzNWYtZjhhY2ViOWRlMDY4IiwiYXZhaWFibGVCYWxh
bmNlIjoiMCIsInBhbiI6IioqKioqKioqKio0MjQyIiwib3JpZ2luYWxUcmFuc2FjdGlvbklkIjoi
MCIsIm9yaWdpbmFsVHJhbnNhY3Rpb25EYXRlIjoiMDgvMDQvMjQiLCJzZWNvbmRhcnlQcm9kdWN0Q29kZSI6IjIwNCIsImRvY3VtZW50VHlwZSI6IkoiLCJoYXNTZW50TWVyY2hhbnRDb2RlIjoiZmFsc2UiLCJzdGF0dXNDb2RlIjoiMSIsIm1lcmNoYW50QWRkcmVzcyI6IkFsYW1lZGEgR3JhamF1LCAy
MTkiLCJtZXJjaGFudENvZGUiOiIwMDEwMDAwMjQ0NDcwMDAxIiwicGF5bWVudFR5cGVDb2RlIjoiMSIsImhhc0Nvbm5lY3Rpdml0eSI6InRydWUiLCJwcm9kdWN0TmFtZSI6IkNSRURJVE8gQSBWSVNUQSAtIEkiLCJtZXJjaGFudE5hbWUiOiJMT0pBIE9OIiwiZW50cmFuY2VNb2RlIjoiNjQyMDE3MjA0
MDgwIiwiY2FyZENhcHR1cmVUeXBlIjoiMSIsImZpcnN0UXVvdGFBbW91bnQiOiIwIiwidG90YWxp
emVyQ29kZSI6IjAiLCJyZXF1ZXN0RGF0ZSI6IjE3MTI2MDMyNjcxMjgiLCJhcHBsaWNhdGlvbklk
IjoiY2llbG8ubGF1bmNoZXIiLCJib2FyZGluZ1RheCI6IjAiLCJudW1iZXJPZlF1b3RhcyI6IjAi
LCJkb2N1bWVudCI6IjcwOTU3ODk4MDAwMTc2In0sInByaW1hcnlDb2RlIjoiNCIsInJlcXVlc3RE
YXRlIjoiMTcxMjYwMzI2NzEyOCIsInNlY29uZGFyeUNvZGUiOiIyMDQiLCJ0ZXJtaW5hbCI6IjYy
MDAwMTQwIn1dLCJwZW5kaW5nQW1vdW50IjowLCJwcmljZSI6MTY5OCwicmVmZXJlbmNlIjoiUmVmZXJlbmNlIiwic3RhdHVzIjoiUEFJRCIsInR5cGUiOiJQQVlNRU5UIiwidXBkYXRlZEF0IjoiQXBy
IDgsIDIwMjQgNDowNzo1MyBQTSJ9LHsiY3JlYXRlZEF0IjoiQXByIDgsIDIwMjQgNDowNzo0MyBQ
TSIsImlkIjoiZjJlNGIxZDMtYWI2Ny00NzM2LWEzMDctYjM0ZWJkZGIyM2QwIiwiaXRlbXMiOlt7
ImRlc2NyaXB0aW9uIjoiIiwiZGV0YWlscyI6IiIsImlkIjoiZDBjOGE4MzYtOTM4OC00MTdiLThk
MzAtMmViOWQ0YzA2ODFmIiwibmFtZSI6InByb2R1dG8iLCJxdWFudGl0eSI6MSwicmVmZXJlbmNlIjoiIiwic2t1IjoiNzY2MTgiLCJ1bml0T2ZNZWFzdXJlIjoidW5pZGFkZSIsInVuaXRQcmljZSI6
ODM4fV0sIm5vdGVzIjoiIiwibnVtYmVyIjoiIiwicGFpZEFtb3VudCI6ODM4LCJwYXltZW50cyI6
W3siYWNjZXNzS2V5IjoiclNBcU5QR3ZGUEpJIiwiYW1vdW50Ijo4MzgsImFwcGxpY2F0aW9uTmFt
ZSI6ImNvbS5hZHMubGlvLnVyaWFwcGNsaWVudCIsImF1dGhDb2RlIjoiMTYwODE2IiwiYnJhbmQi
OiIiLCJjaWVsb0NvZGUiOiIxMDgxNDIiLCJkZXNjcmlwdGlvbiI6IiIsImRpc2NvdW50ZWRBbW91
bnQiOjAsImV4dGVybmFsSWQiOiI5M2NiYmUzOS1hNWI2LTQ4MmItODBhZi00MDgxOGYyZTQyMjEiLCJpZCI6ImNiZjMxY2M4LWMzMzgtNDUxMC1iMGY4LTA3NWFlNzM4ODNlYSIsImluc3RhbGxtZW50cyI6MCwibWFzayI6IioqKioqKioqKio0MjQyIiwibWVyY2hhbnRDb2RlIjoiMDAxMDAwMDI0NDQ3MDAwMSIsInBheW1lbnRGaWVsZHMiOnsiaXNEb3VibGVGb250UHJpbnRBbGxvd2VkIjoidHJ1ZSIsImJpbiI6IjQyNDI0MiIsImhhc1Bhc3N3b3JkIjoidHJ1ZSIsInByaW1hcnlQcm9kdWN0Q29kZSI
IjQiLCJpc0V4dGVybmFsQ2FsbCI6InRydWUiLCJwcmltYXJ5UHJvZHVjdE5hbWUiOiJDUkVESVRP
IiwicmVjZWlwdFByaW50UGVybWlzc2lvbiI6IjEiLCJpc09ubHlJbnRlZ3JhdGlvbkNhbmNlbGFi
bGUiOiJmYWxzZSIsInVwRnJvbnRBbW91bnQiOiIwIiwiY3JlZGl0QWRtaW5UYXgiOiIwIiwiZXh0
ZXJuYWxDYWxsTWVyY2hhbnRDb2RlIjoiMDAxMDAwMDI0NDQ3MDAwMSIsImZpcnN0UXVvdGFEYXRlIjoiMCIsImlzRmluYW5jaWFsUHJvZHVjdCI6InRydWUiLCJoYXNQcmludGVkQ2xpZW50UmVjZWlwdCI6ImZhbHNlIiwiaGFzU2lnbmF0dXJlIjoiZmFsc2UiLCJhcHBsaWNhdGlvbk5hbWUiOiJjb20u
YWRzLmxpby51cmlhcHBjbGllbnQiLCJoYXNXYXJyYW50eSI6ImZhbHNlIiwiaW50ZXJlc3RBbW91
bnQiOiIwIiwiY2hhbmdlQW1vdW50IjoiMCIsInNlcnZpY2VUYXgiOiIwIiwiY2l0eVN0YXRlIjoi
QmFydWVyaSAtIFNQIiwiaGFzU2VudFJlZmVyZW5jZSI6ImZhbHNlIiwidjQwQ29kZSI6IjQiLCJz
ZWNvbmRhcnlQcm9kdWN0TmFtZSI6IkEgVklTVEEiLCJwYXltZW50VHJhbnNhY3Rpb25JZCI6Ijkz
Y2JiZTM5LWE1YjYtNDgyYi04MGFmLTQwODE4ZjJlNDIyMSIsImF2YWlhYmxlQmFsYW5jZSI6IjAi
LCJwYW4iOiIqKioqKioqKioqNDI0MiIsIm9yaWdpbmFsVHJhbnNhY3Rpb25JZCI6IjAiLCJvcmln
aW5hbFRyYW5zYWN0aW9uRGF0ZSI6IjA4LzA0LzI0Iiwic2Vjb25kYXJ5UHJvZHVjdENvZGUiOiIy
MDQiLCJkb2N1bWVudFR5cGUiOiJKIiwiaGFzU2VudE1lcmNoYW50Q29kZSI6ImZhbHNlIiwic3Rh
dHVzQ29kZSI6IjEiLCJtZXJjaGFudEFkZHJlc3MiOiJBbGFtZWRhIEdyYWphdSwgMjE5IiwibWVy
Y2hhbnRDb2RlIjoiMDAxMDAwMDI0NDQ3MDAwMSIsInBheW1lbnRUeXBlQ29kZSI6IjEiLCJoYXNDb25uZWN0aXZpdHkiOiJ0cnVlIiwicHJvZHVjdE5hbWUiOiJDUkVESVRPIEEgVklTVEEgLSBJIiwi
bWVyY2hhbnROYW1lIjoiTE9KQSBPTiIsImVudHJhbmNlTW9kZSI6IjY0MjAxNzIwNDA4MCIsImNh
cmRDYXB0dXJlVHlwZSI6IjEiLCJmaXJzdFF1b3RhQW1vdW50IjoiMCIsInRvdGFsaXplckNvZGUi
OiIwIiwicmVxdWVzdERhdGUiOiIxNzEyNjAzMjY3ODQ1IiwiYXBwbGljYXRpb25JZCI6ImNpZWxv
LmxhdW5jaGVyIiwiYm9hcmRpbmdUYXgiOiIwIiwibnVtYmVyT2ZRdW90YXMiOiIwIiwiZG9jdW1l
bnQiOiI3MDk1Nzg5ODAwMDE3NiJ9LCJwcmltYXJ5Q29kZSI6IjQiLCJyZXF1ZXN0RGF0ZSI6IjE3
MTI2MDMyNjc4NDUiLCJzZWNvbmRhcnlDb2RlIjoiMjA0IiwidGVybWluYWwiOiI2MjAwMDE0MCJ9XSwicGVuZGluZ0Ftb3VudCI6MCwicHJpY2UiOjgzOCwicmVmZXJlbmNlIjoiUmVmZXJlbmNlIiwi
c3RhdHVzIjoiUEFJRCIsInR5cGUiOiJQQVlNRU5UIiwidXBkYXRlZEF0IjoiQXByIDgsIDIwMjQg
NDowNzo1NCBQTSJ9XSwidG90YWxJdGVtcyI6MzYyLCJ0b3RhbFBhZ2VzIjo3M30=
&responsecode=0

Quando o campo ResponseCode for igual a 0, isso indica que o pagamento foi realizado com sucesso. Após decodificar o conteúdo retornado, você terá acesso a um objeto JSON contendo os detalhes da transação.

{
    "currentPage":0,
    "results":[],
    "totalItems":30,
    "totalPages":6
 }

O results estará uma lista com os pedidos.

Retorno de erro

order://response?response=eyJjb2RlIjoxLCJyZWFzb24iOiJDQU5DRUxBRE8gUEVMTyBVU1XDgVJJTyJ9&responsecode=2

Listagem de Produtos

É possível obter todos os produtos (tipos de pagamento) que estão habilitados para o cliente. Para isso basta definir o JSON abaixo e formata-lo para Base64:

{
“clientID”: “seu cliente ID”,
“accessToken”: “seu access token”
}

A chamada deve ser feita da seguinte forma:

var base64 = getBase64(jsonString)
var checkoutUri = "lio://products?request=$base64&urlCallback=order://response"

Para recuperar os dados, basta acessar a intent na activity de resposta cadastrada em seu manifest e no parâmetro data, acessar a URI da seguinte forma:

val responseIntent = intent
if (Intent.ACTION_VIEW == responseIntent.action) {
   val uri = responseIntent.data
   val response = uri.getQueryParameter("response")
   val data = Base64.decode(response, Base64.DEFAULT)
   val json = String(data)
}

Exemplo de retorno dos produtos

order://products?response=W3siY29kZSI6IjQiLCJpZCI6MTAwMCwibmFtZSI6IkNSRURJVE8iLCJzZWNvbmRhcnlQcm9kdWN0cyI6W3siY29kZSI6IjIwNCIsImlkIjoxMDAwLCJuYW1lIjoiQ1JFRElUTyBBIFZJU1RBIC0gSSJ9LHsiY29kZSI6IjIwNSIsImlkIjoxMDAxLCJuYW1lIjoiQ1JFRElUTyBQQVJDRUxBRE8gQURNIC0gSSJ9LHsiY29kZSI6IjIwNiIsImlkIjoxMDAyLCJuYW1lIjoiQ1JFRElUTyBQQVJDRUxBRE8gTE9KQSAtIEkifV19LHsiY29kZSI6IjgiLCJpZCI6MTAwMSwibmFtZSI6IkRFQklUTyIsInNlY29uZGFyeVByb2R1Y3RzIjpbeyJjb2RlIjoiMjA4IiwiaWQiOjEwMDMsIm5hbWUiOiJERUJJVE8gQSBWSVNUQSAtIEkifV19LHsiY29kZSI6IjEzIiwiaWQiOjEwMDIsIm5hbWUiOiJWSVNBIFZBTEUiLCJzZWNvbmRhcnlQcm9kdWN0cyI6W3siY29kZSI6IjI1MCIsImlkIjoxMDA0LCJuYW1lIjoiVklTQS1WQUxFIFJFRkVJQ0FPIC0gSSJ9LHsiY29kZSI6IjI1MSIsImlkIjoxMDA1LCJuYW1lIjoiVklTQS1WQUxFIEFMSU1FTlRBQ0FPIC0gSSJ9XX0seyJjb2RlIjoiNyIsImlkIjoxMDAzLCJuYW1lIjoiUFJFLUFVVCIsInNlY29uZGFyeVByb2R1Y3RzIjpbeyJjb2RlIjoiMCIsImlkIjoyMDAwLCJuYW1lIjoiUFJFLUFVVE9SSVpBQ0FPIC0gSSJ9XX1d&responsecode=0

Depois de decodificar o resultado, será obtido uma lista com todos os produtos que estão habilitados para o EC.

[
    {
        "code": "4",
        "id": 1000,
        "name": "CREDITO",
        "secondaryProducts": [
            {
                "code": "204",
                "id": 1000,
                "name": "CREDITO A VISTA - I"
            },
            {
                "code": "205",
                "id": 1001,
                "name": "CREDITO PARCELADO ADM - I"
            },
            {
                "code": "206",
                "id": 1002,
                "name": "CREDITO PARCELADO LOJA - I"
            }
        ]
    },
    {
        "code": "8",
        "id": 1001,
        "name": "DEBITO",
        "secondaryProducts": [
            {
                "code": "208",
                "id": 1003,
                "name": "DEBITO A VISTA - I"
            }
        ]
    },
    {
        "code": "13",
        "id": 1002,
        "name": "VISA VALE",
        "secondaryProducts": [
            {
                "code": "250",
                "id": 1004,
                "name": "VISA-VALE REFEICAO - I"
            },
            {
                "code": "251",
                "id": 1005,
                "name": "VISA-VALE ALIMENTACAO - I"
            }
        ]
    },
    {
        "code": "7",
        "id": 1003,
        "name": "PRE-AUT",
        "secondaryProducts": [
            {
                "code": "0",
                "id": 2000,
                "name": "PRE-AUTORIZACAO - I"
            }
        ]
    }
]

Listagem de Produtos (PAYMENT_CODE)

É possível obter todos os produtos (tipos de pagamento) que estão habilitados para o cliente, com os mesmos no formato da lista de PAYMENTCODE que se encontra nessa sessão. Para isso basta definir o JSON abaixo e formata-lo para Base64:

{
  “clientID”: “seu cliente ID”,
  “accessToken”: “seu access token”
}

A chamada deve ser feita da seguinte forma:

var base64 = getBase64(jsonString)
var checkoutUri = "lio://enabledproducts?request=$base64&urlCallback=order://response"

Para recuperar os dados basta acessar a intent na activity de resposta cadastrada em seu manifest e no parâmetro data, acessar a URI da seguinte forma:

val responseIntent = intent
if (Intent.ACTION_VIEW == responseIntent.action) {
   val uri = responseIntent.data
   val response = uri.getQueryParameter("response")
   val data = Base64.decode(response, Base64.DEFAULT)
   val json = String(data)
}

Exemplo de retorno dos produtos:

uriappsample://products_response?response=WyJDUkVESVRPX0NSRURJQVJJT19DUkVESVRPIiwiQ1JFRElUT19QQVJDRUxBRE9fQk5DTyIsIkNSRURJVE9fUEFSQ0VMQURPX0FETSIsIkNSRURJVE9fUEFSQ0VMQURPX0xPSkEiLCJERUJJVE9fUEFHVE9fRkFUVVJBX0RFQklUTyIsIkRFQklUT19BVklTVEEiLCJWT1VDSEVSX1JFRkVJQ0FPIiwiVk9VQ0hFUl9BTElNRU5UQUNBTyIsIlZPVUNIRVJfQVVUT01PVElWTyIsIlZPVUNIRVJfQ1VMVFVSQSIsIlZPVUNIRVJfUEVEQUdJTyIsIlZPVUNIRVJfQkVORUZJQ0lPUyIsIlZPVUNIRVJfQVVUTyIsIlZPVUNIRVJfQ09OU1VMVEFfU0FMRE8iLCJWT1VDSEVSX1ZBTEVfUEVEQUdJTyIsIkNBUlRBT19MT0pBX0FWSVNUQSIsIkNBUlRBT19MT0pBX1BBUkNFTEFET19MT0pBIiwiQ0FSVEFPX0xPSkFfUEFSQ0VMQURPX0JBTkNPIiwiQ0FSVEFPX0xPSkFfUEFHVE9fRkFUVVJBX0NIRVFVRSIsIkNBUlRBT19MT0pBX1BBR1RPX0ZBVFVSQV9ESU5IRUlSTyIsIlBSRV9BVVRPUklaQUNBTyIsIlBJWCJd&responsecode=0

Depois de decodificar o resultado, será obtido uma lista com todos os produtos que estão habilitados para o EC.

["CREDITO_AVISTA","CREDITO_PARCELADO_BNCO","CREDITO_PARCELADO_ADM","CREDITO_PARCELADO_LOJA","DEBITO_PAGTO_FATURA_DEBITO","DEBITO_AVISTA","VOUCHER_REFEICAO","VOUCHER_ALIMENTACAO","VOUCHER_AUTOMOTIVO","VOUCHER_CULTURA","VOUCHER_PEDAGIO","VOUCHER_BENEFICIOS","VOUCHER_AUTO","VOUCHER_CONSULTA_SALDO","VOUCHER_VALE_PEDAGIO","CARTAO_LOJA_AVISTA","CARTAO_LOJA_PARCELADO_LOJA","CARTAO_LOJA_PARCELADO_BANCO","CARTAO_LOJA_PAGTO_FATURA_CHEQUE","CARTAO_LOJA_PAGTO_FATURA_DINHEIRO","PRE_AUTORIZACAO","PIX"]

Consulta de Pedido avulso

Na consulta de pedido avulso, é possível realizar de duas maneiras diferentes.

• Buscando um pedido por valor, nsu (Cielo code) e código de autorização.

• Consultando um pedido pelo seu identificador (ID).

• Para isso basta realizar a chamada da seguinte maneira.

Os dados de entrada podem ser qualquer um dos JSONs abaixo:

• JSON de busca por ID:

{
    "orderId": "orderId",
    "clientID": "clientidtest",
    "accessToken": "accesstokentest"
}

• JSON de busca por valor, nsu e código de autorização:

{
    "amount": amount,
    "authCode": "authCode",
    "cieloCode": "cieloCode(nsu)",
    "orderId": "orderId",
    "clientID": "clientidtest",
    "accessToken": "accesstokentest"
}

Para isso basta definir um dos JSONs acima e formata-lo para Base64. A chamada deve ser feita da seguinte forma:

var base64 = getBase64(jsonString)
var checkoutUri = "lio://order?request=$base64&urlCallback=order://response"

Para recuperar os dados, basta acessar a intent na activity de resposta cadastrada em seu manifest e no parâmetro data, acessar a URI da seguinte forma:

val responseIntent = intent
if (Intent.ACTION_VIEW == responseIntent.action) {
   val uri = responseIntent.data
   val response = uri.getQueryParameter("response")
   val data = Base64.decode(response, Base64.DEFAULT)
   val json = String(data)
}

Exemplo de retorno do pedido

order://responseresponse=eyJhY2Nlc3NLZXkiOiJyU0FxTlBHdkZQSkkiLCJhbW91bnQiOjExMTYsImNyZWF0ZWRBdCI6IkFwciA0LCAyMDI0IDEwOjE4OjE4IEFNIiwiaWQiOiJkYTI1NzE2Ny1lODJhLTRjN2MtYjVlMC1mMDc2OWQ4MTg0M2MiLCJpdGVtcyI6W3siYW1vdW50IjoxMTE2LCJkZXNjcmlwdGlvbiI6InByb2R1dG8iLCJkZXRhaWxzIjoicHJvZHV0byIsImlkIjoiM2U4YjNjOGYtNDdlMC00YjNkLWFiMTQtNWYxNzY0ZjczN2FhIiwibmFtZSI6InByb2R1dG8iLCJxdWFudGl0eSI6MiwicmVmZXJlbmNlIjoicHJvZHV0byIsInNrdSI6IjY4NzU5IiwidW5pdE9mTWVhc3VyZSI6InVuaWRhZGUiLCJ1bml0UHJpY2UiOjU1OH1dLCJsYXN0TW9kaWZpY2F0aW9uRGF0ZSI6IkFwciA0LCAyMDI0IDEwOjE4OjE4IEFNIiwibm90ZXMiOiIiLCJudW1iZXIiOiIiLCJwYWlkQW1vdW50IjowLCJwZW5kaW5nQW1vdW50IjoxMTE2LCJyZWZlcmVuY2UiOiJSZWZlcmVuY2UiLCJyZWxlYXNlRGF0ZSI6IkFwciA0LCAyMDI0IDEwOjE4OjE4IEFNIiwic2VjcmV0QWNjZXNzS2V5IjoiWFpldm9VWUtta1ZyIiwic3RhdHVzIjoiRU5URVJFRCIsInRyYW5zYWN0aW9ucyI6W10sInR5cGUiOiJQQVlNRU5UIn0=&responsecode=0

Depois de decodificar o resultado, será obtido uma lista com o pedido encontrado:

{
    "accessKey": "rSAqNPGvFPJI",
    "amount": 1116,
    "createdAt": "Apr 4, 2024 10:18:18 AM",
    "id": "da257167-e82a-4c7c-b5e0-f0769d81843c",
    "items": [
        {
            "amount": 1116,
            "description": "produto",
            "details": "produto",
            "id": "3e8b3c8f-47e0-4b3d-ab14-5f1764f737aa",
            "name": "produto",
            "quantity": 2,
            "reference": "produto",
            "sku": "68759",
            "unitOfMeasure": "unidade",
            "unitPrice": 558
        }
    ],
    "lastModificationDate": "Apr 4, 2024 10:18:18 AM",
    "notes": "",
    "number": "",
    "paidAmount": 0,
    "pendingAmount": 1116,
    "reference": "Reference",
    "releaseDate": "Apr 4, 2024 10:18:18 AM",
    "secretAccessKey": "XZevoUYKmkVr",
    "status": "ENTERED",
    "transactions": [],
    "type": "PAYMENT"
}

Em transactions, terá uma lista com os pagamentos feitos para o pedido.

Caso não encontre o pedido, o retorno será:

order://response?response=eyJjb2RlIjoxLCJyZWFzb24OiJDQU5DRUxBRE8gUEVMTyBVU1XDgVJJTyJ9&responsecode=2

Depois de decodificar o resultado:

{
    "code": 2,
    "reason": "Order not found",
}

Informações do terminal

É possível obter algumas informações do terminal tais como, nível de bateria, modelo do dispositivo, Merchant e também o número lógico. Para isso basta realizar a chamada da seguinte maneira:

var base64 = getBase64(jsonString)
var checkoutUri = "lio://terminalinfo?urlCallback=order://response"

Para recuperar os dados, basta acessar a intent na activity de resposta cadastrada em seu manifest e no parâmetro data, acessar a URI da seguinte forma:

val responseIntent = intent
if (Intent.ACTION_VIEW == responseIntent.action) {
   val uri = responseIntent.data
   val response = uri.getQueryParameter("response")
   val data = Base64.decode(response, Base64.DEFAULT)
   val json = String(data)
}

Exemplos de retorno

order://response?response=eyJiYXR0ZXJ5TGV2ZWwiOjAuOTksImRldmljZU1vZGVsIjoiTElPX1YzIiwibG9naWNOdW1iZXIiOiI2MjAwMDE0MC00IiwibWVyY2hhbnRDb2RlIjoiMDAxMDAwMDI0NDQ3MDAwMSJ9&responsecode=0

Depois de decodificar o resultado:

{
    "batteryLevel": 0.99,
    "deviceModel": "LIO_V3",
    "logicNumber": "12345678-9",
    "merchantCode": "0000000000000000"
}

Consulta de Estabelecimentos

Para consultar a lista de ECs disponíveis no terminal, siga o modelo abaixo:

data class EstablishmentsRequest(val clientID: String, val accessToken: String)

private fun listEstablishments() {
val request = EstablishmentsRequest("clientId", "accessToken")
val json: String = Gson().toJson(request).toString()
Log.d(TAG, "checkout JSON STRING = $json")
val base64 = getBase64(json)

val checkoutUri = "lio://establishments?request=$base64&urlCallback=$scheme://$establishmentsHost"
val i = Intent(Intent.ACTION_VIEW, Uri.parse(checkoutUri))
i.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP)
try {
startActivity(i)
} catch (e: Exception) {
Log.e(TAG, "ERROR", e)
logView.addText("ERROR=$e ${e.message}")
}
}

A resposta será entregue na activity que tiver como parâmetro o intent filter com os dados passado pelo integrador na urlCallback. O formato da resposta será uma lista de estabelecimentos com os valores nome e código. O código que deverá ser passado no momento do pagamento.

Exemplo de retorno

Retorno de sucesso

uriappsample://establishments_response?response=W3siY29kZSI6IjAwMTAwMDAyNDQ0NzAwMDEiLCJuYW1lIjoiTE9KQSBPTiJ9XQ==&responsecode=0

Após realizar a decodificaçao será obtido um objeto JSON:

{
"code":"0000000000000000",
"name":"EC NAME"
}

Retorno de erro

Caso ocorra algum erro durante o processo de consulta, será retornado um Base64 com o código e motivo do erro:

uriappsample://establishments_response?response=eyJjb2RlIjoyLCJyZWFzb24iOiJFcnJvIGFvIGJ1c2NhciBvcyBlc3RhYmVsZWNpbWVudG9zOiBFcnJvciB0byBnZXQgZXN0YWJsaXNobWVudHMifQ==

{
"code":1,
"reason":"Erro ao buscar os estabelecimentos: motivo do erro"
}

Cancelamento

Para realizar o cancelamento é preciso criar um JSON seguindo o formato definido abaixo e converte-lo para Base64:

{
  "id": "id da ordem",
  "clientID": "seu client ID",
  "accessToken": "seu access token",
  "cieloCode": "123",
  "authCode": "123",
  "value": 1000
}

A chamada de cancelamento deve ser feita da seguinte forma. Como explicado anteriormente, é preciso definir o contrato de resposta, aqui será utilizado essa configuração no parâmetro urlCallback.

var base64 = getBase64(jsonString)
var checkoutUri ="lio://payment-reversal?request=$base64&urlCallback=order://response"

Para recuperar os dados basta acessar a intent na activity de resposta cadastrada em sem Manifest e no parâmetro data, acessar a uri, da seguinte forma:

val responseIntent = intent
if (Intent.ACTION_VIEW == responseIntent.action) {
   val uri = responseIntent.data
   val response = uri.getQueryParameter("response")
   val data = Base64.decode(response, Base64.DEFAULT)
   val json = String(data)
}

Exemplos de retorno

order://response?response=eyJjcmVhdGVkQXQiOiJGZWIgOSwgMjAyNCAyOjI5OjE2IFBNIiwiaWQiOiJmN2E4ZjIyNi0yOTQ5LTQwMGItOTc3OC05MTNiMGQxNjkzODkiLCJpdGVtcyI6W3siZGVzY3JpcHRpb24iOiIiLCJkZXRhaWxzIjoiIiwiaWQiOiI0MmQwNTg2Yi1mOWViLTQwNjYtYmQxZi1jNTQyMTg2MzJmMmUiLCJuYW1lIjoicHJvZHV0byIsInF1YW50aXR5Ijo1LCJyZWZlcmVuY2UiOiIiLCJza3UiOiI0OTQ3MyIsInVuaXRPZk1lYXN1cmUiOiJ1bmlkYWRlIiwidW5pdFByaWNlIjo3MjR9XSwibm90ZXMiOiIiLCJudW1iZXIiOiIiLCJwYWlkQW1vdW50IjowLCJwYXltZW50cyI6W3siYWNjZXNzS2V5IjoiclNBcU5QR3ZGUEpJIiwiYW1vdW50IjozNjIwLCJhcHBsaWNhdGlvbk5hbWUiOiJjb20uYWRzLmxpby51cmlhcHBjbGllbnQiLCJhdXRoQ29kZSI6IjE0Mjk0MSIsImJyYW5kIjoiIiwiY2llbG9Db2RlIjoiOTEwNzkyIiwiZGVzY3JpcHRpb24iOiIiLCJkaXNjb3VudGVkQW1vdW50IjowLCJleHRlcm5hbElkIjoiNDFmYzNlZDItYjc4MS00Y2M0LWEyM2EtYWExYTdiN2JjNWQwIiwiaWQiOiIyZTc3YTI3OC0wY2M1LTQ3ODQtYTljNy01Y2Y3M2I5OWRiZjYiLCJpbnN0YWxsbWVudHMiOjAsIm1hc2siOiIqKioqKioqKioqKiowMDAwIiwibWVyY2hhbnRDb2RlIjoiMDAxMDAwMDI0NDQ3MDAwMSIsInBheW1lbnRGaWVsZHMiOnsiaXNEb3VibGVGb250UHJpbnRBbGxvd2VkIjoidHJ1ZSIsImJpbiI6IjAiLCJoYXNQYXNzd29yZCI6ImZhbHNlIiwicHJpbWFyeVByb2R1Y3RDb2RlIjoiNCIsImlzRXh0ZXJuYWxDYWxsIjoidHJ1ZSIsInByaW1hcnlQcm9kdWN0TmFtZSI6IkNSRURJVE8iLCJyZWNlaXB0UHJpbnRQZXJtaXNzaW9uIjoiMSIsImlzT25seUludGVncmF0aW9uQ2FuY2VsYWJsZSI6ImZhbHNlIiwidXBGcm9udEFtb3VudCI6IjAiLCJjcmVkaXRBZG1pblRheCI6IjAiLCJleHRlcm5hbENhbGxNZXJjaGFudENvZGUiOiIwMDEwMDAwMjQ0NDcwMDAxIiwiZmlyc3RRdW90YURhdGUiOiIwIiwiaXNGaW5hbmNpYWxQcm9kdWN0IjoidHJ1ZSIsImhhc1ByaW50ZWRDbGllbnRSZWNlaXB0IjoiZmFsc2UiLCJoYXNTaWduYXR1cmUiOiJmYWxzZSIsImFwcGxpY2F0aW9uTmFtZSI6ImNvbS5hZHMubGlvLnVyaWFwcGNsaWVudCIsImhhc1dhcnJhbnR5IjoiZmFsc2UiLCJpbnRlcmVzdEFtb3VudCI6IjAiLCJjaGFuZ2VBbW91bnQiOiIwIiwic2VydmljZVRheCI6IjAiLCJjaXR5U3RhdGUiOiJCYXJ1ZXJpIC0gU1AiLCJoYXNTZW50UmVmZXJlbmNlIjoiZmFsc2UiLCJ2NDBDb2RlIjoiNCIsInNlY29uZGFyeVByb2R1Y3ROYW1lIjoiQSBWSVNUQSIsInBheW1lbnRUcmFuc2FjdGlvbklkIjoiNDFmYzNlZDItYjc4MS00Y2M0LWEyM2EtYWExYTdiN2JjNWQwIiwiYXZhaWFibGVCYWxhbmNlIjoiMCIsInBhbiI6IioqKioqKioqKioqKjAwMDAiLCJvcmlnaW5hbFRyYW5zYWN0aW9uSWQiOiIwIiwib3JpZ2luYWxUcmFuc2FjdGlvbkRhdGUiOiIwOS8wMi8yNCIsInNlY29uZGFyeVByb2R1Y3RDb2RlIjoiMjA0IiwiZG9jdW1lbnRUeXBlIjoiSiIsImhhc1NlbnRNZXJjaGFudENvZGUiOiJmYWxzZSIsInN0YXR1c0NvZGUiOiIxIiwibWVyY2hhbnRBZGRyZXNzIjoiQWxhbWVkYSBHcmFqYXUsIDIxOSIsIm1lcmNoYW50Q29kZSI6IjAwMTAwMDAyNDQ0NzAwMDEiLCJwYXltZW50VHlwZUNvZGUiOiIxIiwiaGFzQ29ubmVjdGl2aXR5IjoidHJ1ZSIsInByb2R1Y3ROYW1lIjoiQ1JFRElUTyBBIFZJU1RBIC0gSSIsIm1lcmNoYW50TmFtZSI6IkxPSkEgT04iLCJlbnRyYW5jZU1vZGUiOiI2NjEwMTAxMDcwODAiLCJjYXJkQ2FwdHVyZVR5cGUiOiI2IiwiZmlyc3RRdW90YUFtb3VudCI6IjAiLCJ0b3RhbGl6ZXJDb2RlIjoiMCIsInJlcXVlc3REYXRlIjoiMTcwNzQ5OTc2MDI5OSIsImFwcGxpY2F0aW9uSWQiOiJjaWVsby5sYXVuY2hlciIsImJvYXJkaW5nVGF4IjoiMCIsIm51bWJlck9mUXVvdGFzIjoiMCIsImRvY3VtZW50IjoiMDAwMDAwMDAwMDAwMDAifSwicHJpbWFyeUNvZGUiOiI0IiwicmVxdWVzdERhdGUiOiIxNzA3NDk5NzYwMjk5Iiwic2Vjb25kYXJ5Q29kZSI6IjIwNCIsInRlcm1pbmFsIjoiNjIwMDAxMTIifSx7ImFjY2Vzc0tleSI6IiIsImFtb3VudCI6MzYyMCwiYXBwbGljYXRpb25OYW1lIjoiY29tLmFkcy5saW8udXJpYXBwY2xpZW50IiwiYXV0aENvZGUiOiIxNDMwMDUiLCJicmFuZCI6IiIsImNpZWxvQ29kZSI6IjkxMDc5NCIsImRlc2NyaXB0aW9uIjoiIiwiZGlzY291bnRlZEFtb3VudCI6MCwiZXh0ZXJuYWxJZCI6IjczNTFkZWI1LTlkYTgtNGQ4ZC1iN2E5LWRlYWQyZjY3M2RkMSIsImlkIjoiODkwNjliNzEtMTE5ZS00MjFjLTgyODUtYmNjODNlZWU0ZWViIiwiaW5zdGFsbG1lbnRzIjowLCJtYXNrIjoiKioqKioqKioqKioqMjgxMCIsIm1lcmNoYW50Q29kZSI6IjAwMTAwMDAyNDQ0NzAwMDEiLCJwYXltZW50RmllbGRzIjp7ImlzRG91YmxlRm9udFByaW50QWxsb3dlZCI6InRydWUiLCJiaW4iOiIwIiwiaGFzUGFzc3dvcmQiOiJmYWxzZSIsInByaW1hcnlQcm9kdWN0Q29kZSI6IjQiLCJpc0V4dGVybmFsQ2FsbCI6InRydWUiLCJwcmltYXJ5UHJvZHVjdE5hbWUiOiJDUkVESVRPIiwicmVjZWlwdFByaW50UGVybWlzc2lvbiI6IjEiLCJpc09ubHlJbnRlZ3JhdGlvbkNhbmNlbGFibGUiOiJmYWxzZSIsInVwRnJvbnRBbW91bnQiOiIwIiwiY3JlZGl0QWRtaW5UYXgiOiIwIiwiZXh0ZXJuYWxDYWxsTWVyY2hhbnRDb2RlIjoiMDAxMDAwMDI0NDQ3MDAwMSIsImZpcnN0UXVvdGFEYXRlIjoiMCIsImlzRmluYW5jaWFsUHJvZHVjdCI6InRydWUiLCJoYXNQcmludGVkQ2xpZW50UmVjZWlwdCI6ImZhbHNlIiwiaGFzU2lnbmF0dXJlIjoiZmFsc2UiLCJhcHBsaWNhdGlvbk5hbWUiOiJjb20uYWRzLmxpby51cmlhcHBjbGllbnQiLCJoYXNXYXJyYW50eSI6ImZhbHNlIiwiaW50ZXJlc3RBbW91bnQiOiIwIiwiY2hhbmdlQW1vdW50IjoiMCIsInNlcnZpY2VUYXgiOiIwIiwiY2l0eVN0YXRlIjoiQmFydWVyaSAtIFNQIiwiaGFzU2VudFJlZmVyZW5jZSI6ImZhbHNlIiwidjQwQ29kZSI6IjI4Iiwic2Vjb25kYXJ5UHJvZHVjdE5hbWUiOiJBIFZJU1RBIiwicGF5bWVudFRyYW5zYWN0aW9uSWQiOiI0MWZjM2VkMi1iNzgxLTRjYzQtYTIzYS1hYTFhN2I3YmM1ZDAiLCJhdmFpYWJsZUJhbGFuY2UiOiIwIiwicGFuIjoiKioqKioqKioqKioqMjgxMCIsIm9yaWdpbmFsVHJhbnNhY3Rpb25JZCI6IjkxMDc5MiIsIm9yaWdpbmFsVHJhbnNhY3Rpb25EYXRlIjoiMDkvMDIvMjQiLCJzZWNvbmRhcnlQcm9kdWN0Q29kZSI6IjIwNCIsImRvY3VtZW50VHlwZSI6IkoiLCJoYXNTZW50TWVyY2hhbnRDb2RlIjoiZmFsc2UiLCJzdGF0dXNDb2RlIjoiMiIsIm1lcmNoYW50QWRkcmVzcyI6IkFsYW1lZGEgR3JhamF1LCAyMTkiLCJtZXJjaGFudENvZGUiOiIwMDEwMDAwMjQ0NDcwMDAxIiwicGF5bWVudFR5cGVDb2RlIjoiMSIsImhhc0Nvbm5lY3Rpdml0eSI6InRydWUiLCJwcm9kdWN0TmFtZSI6IkNSRURJVE8gQSBWSVNUQSAtIEkiLCJtZXJjaGFudE5hbWUiOiJMT0pBIE9OIiwiZW50cmFuY2VNb2RlIjoiNjYxMDEwMTA3MDgwIiwiY2FyZENhcHR1cmVUeXBlIjoiNiIsImZpcnN0UXVvdGFBbW91bnQiOiIwIiwidG90YWxpemVyQ29kZSI6IjAiLCJyZXF1ZXN0RGF0ZSI6IjE3MDc0OTk3ODA1NTMiLCJhcHBsaWNhdGlvbklkIjoiY29tLmFkcy5saW8udXJpYXBwY2xpZW50IiwiYm9hcmRpbmdUYXgiOiIwIiwibnVtYmVyT2ZRdW90YXMiOiIwIiwiZG9jdW1lbnQiOiIwMDAwMDAwMDAwMDAwMCJ9LCJwcmltYXJ5Q29kZSI6IjQiLCJyZXF1ZXN0RGF0ZSI6IjE3MDc0OTk3ODA1NTMiLCJzZWNvbmRhcnlDb2RlIjoiMjA0IiwidGVybWluYWwiOiI2MjAwMDExMiJ9XSwicGVuZGluZ0Ftb3VudCI6MzYyMCwicHJpY2UiOjM2MjAsInJlZmVyZW5jZSI6IlJlZmVyZW5jZSIsInN0YXR1cyI6IkVOVEVSRUQiLCJ0eXBlIjoiUEFZTUVOVCIsInVwZGF0ZWRBdCI6IkZlYiA5LCAyMDI0IDI6Mjk6NDEgUE0ifQ==&responsecode=0

O campo statusCode=1 indica uma transação de pagamento e statusCode=2 Cancelamento. Você pode utilizar esse campo para identificar a transação de cancelamento no JSON recebido.

Cashless

A Cielo LIO oferece a solução de pagamento cashless via integração. No momento, suportamos os cartões Mifare 1k. Para utilizar o serviço no aplicativo de integração, comece adicionando no arquivo de manifesto a seguinte permissão:

<uses-permission android:name="cielo.lio.permission.CASHLESS"/>

Mifare

Os cartões Mifare armazenam dados em uma pequena antena integrada, permitindo que eles se comuniquem com os leitores quando estão em proximidade. Referente a capacidade de armazenamento, hoje damos suporte aos cartões Mifare 1k. Sua memória está organizada em blocos e setores, onde cada bloco possui uma capacidade de armazenamento de 16 bytes de dados, cada setor é composto por 4 blocos, totalizando 64 bytes de dados.

Nossa integração híbrida não depende do SDK Lio, basta o integrador criar uma intent, passá-la como parâmetro no método startService disponível via context da aplicação.

  Intent(action)
    .setPackage("cielo.lio.cashless")
    .putExtra("cbType", 'B')
    .putExtra("cbPackage", packageName)
    .putExtra("cbAction", cbAction)
    .let(::startService)

Descrição dos parâmetros utilizados na operação anterior:

Por fim chamamos o método startService para iniciarmos o serviço mifare na Lio.

Parâmetros de leitura e escrita via intent

Operações suportadas pelo Mifare

Como vimos no exemplo anterior, para realizar operações com cartão Mifare basta o integrador criar uma intent(seguindo nossa especificação) e utilizá-la como parâmetro do método startService, disponível na classe context.

• Detect
• Authenticate
• Read
• Write
• Increment
• Decrement
• Deactivate
• Backup
• Restore

Detect

A operação tem a responsabilidade de ativar a antena e aguardar a aproximação de um cartão. Em caso de sucesso na operação, a intent de retorno conterá o parâmetro result, que é uma String com o valor R00, e o parâmetro data, que é um ByteArray contendo o identificador do cartão. Se a operação resultar em erro, o parâmetro result retornará uma String com um valor diferente de R00, e o identificador do cartão não será retornado no parâmetro data.

Exemplo de chamada detect:

  Intent("cielo.lio.cashless.mifare.DETECT")
    .setPackage("cielo.lio.cashless")
    .putExtra("cbType", 'B')
    .putExtra("cbPackage", packageName)
    .putExtra("cbAction", cbAction)
    .let(::startService)

O parâmetro cbType é customizável. Não necessariamente o integrador precisa tratar a resposta via broadcast, ficando a seu critério as opções abaixo:

B -> Broadcast
S -> Service
A -> Activity

Authenticate

Operação responsável por autenticar-se no setor, para que possa operar no mesmo. É importante estar contido na intent as informações de setor, chave e tipo de chave (sector, key, keyType).

Exemplo de chamada authenticate:

  Intent("cielo.lio.cashless.mifare.AUTHENTICATE")
    .setPackage("cielo.lio.cashless")
    .putExtra("cbType", 'B')
    .putExtra("cbPackage", packageName)
    .putExtra("cbAction", cbAction)
    .putExtra("sector", "1".toByte())
    .putExtra("key", MifareClassic.KEY_DEFAULT)
    .putExtra("keyType", 'A')
    .let(::startService)

Read

Operação responsável por realizar a leitura nos blocos e setores. É importante que a intent que iremos passar como parâmetro tenham as informações de setor e bloco (sector, block).

Exemplo de chamada read:

  Intent("cielo.lio.cashless.mifare.READ")
    .setPackage("cielo.lio.cashless")
    .putExtra("cbType", 'B')
    .putExtra("cbPackage", packageName)
    .putExtra("cbAction", cbAction)
    .putExtra("sector", "1".toByte())
    .putExtra("block", "0".toByte())
    .let(::startService)

Write

Esta operação nos permite escrever em um setor e bloco específico. É importante adicionar na intent as informações de setor, do bloco e data (sector, block e data).

Exemplo de chamada write:

  Intent("cielo.lio.cashless.mifare.WRITE")
    .setPackage("cielo.lio.cashless")
    .putExtra("cbType", 'B')
    .putExtra("cbPackage", packageName)
    .putExtra("cbAction", cbAction)
    .putExtra("sector", "1".toByte())
    .putExtra("block", "0".toByte())
    .putExtra("data", "100".toByteArray())
    .let(::startService)

Increment

Operação responsável pelo incremento de valor em um bloco específico. É importante conter na intent as informações de setor, do bloco e valor (sector, block e value).

Exemplo de chamada increment:

  Intent("cielo.lio.cashless.mifare.INCREMENT")
    .setPackage("cielo.lio.cashless")
    .putExtra("cbType", 'B')
    .putExtra("cbPackage", packageName)
    .putExtra("cbAction", cbAction)
    .putExtra("sector", "1".toByte())
    .putExtra("block", "0".toByte())
    .putExtra("value", "5".toByte())
    .let(::startService)

Decrement

Operação responsável pelo decremento de valor em um bloco específico. É importante conter na intent as informações de setor, do bloco e valor (sector, block e value). Exemplo de chamada decrement:

  Intent("cielo.lio.cashless.mifare.DECREMENT")
    .setPackage("cielo.lio.cashless")
    .putExtra("cbType", 'B')
    .putExtra("cbPackage", packageName)
    .putExtra("cbAction", cbAction)
    .putExtra("sector", "1".toByte())
    .putExtra("block", "0".toByte())
    .putExtra("value", "5".toByte())
    .let(::startService)

Deactivate

Operação de encerramento do serviço, use-o quando estiver terminado. Exemplo de chamada deactivate:

Intent("cielo.lio.cashless.mifare.DEACTIVATE")
 .setPackage("cielo.lio.cashless")
 .putExtra("cbType", 'B')
 .putExtra("cbPackage", packageName)
 .putExtra("cbAction", cbAction)
 .let(::startService)

Backup e Restore

Operações de transferência dos dados de um bloco para outro, também conhecida em algumas documentações do Mifare como transfer. É importante a intent conter informações de setor, bloco e bloco de destino. (sector, block e destinationBlock).

Exemplo de chamada:

  Intent("cielo.lio.cashless.mifare.BACKUP")
    .setPackage("cielo.lio.cashless")
    .putExtra("cbType", 'B')
    .putExtra("cbPackage", packageName)
    .putExtra("cbAction", cbAction)
  .putExtra("block", "1".toByte())
  .putExtra("destinationBlock", "2".toByte())
    .let(::startService)

  Intent("cielo.lio.cashless.mifare.RESTORE")
    .setPackage("cielo.lio.cashless")
    .putExtra("cbType", 'B')
    .putExtra("cbPackage", packageName)
    .putExtra("cbAction", cbAction)
  .putExtra("block", "1".toByte())
  .putExtra("destinationBlock", "2".toByte())
    .let(::startService)

Retorno das operações para o aplicativo do cliente.

Os componentes para tratar os retornos para as operações que acabamos de descrever podem ser variados (broadcast, service, intent), o que todos têm em comum é que passamos uma intent como parâmetro, nesta teremos os seguintes atributos:

Abaixo disponibilizando uma classe de exemplo que consume a API do Mifare, a implementação está em Kotlin e o modo de consumo escolhido foi o broadcast.

Exemplo de classe para tratamento do retorno utilizando broadcast

Abaixo disponiblizamos um exemplo de solução que trata o retorno das operações mifare utilizando broadcast

Clique aqui para ver exemplo de solução.

Impressão

Para realizar a impressão, basta montar uma URL com o seguinte formato:

lio://print?request=$base64&urlCallback=order://response

Exemplos de impressão:

Texto

Para otimizar a performance ao usar o Printer Manager para imprimir textos com múltiplas linhas, é aconselhável evitar a invocação do método de impressão para cada linha individualmente.

Em vez disso, recomenda-se a formatação do texto completo, incluindo todas as linhas, e a realização de uma única chamada a operação PRINT_TEXT.

Isso reduz o número de chamadas ao método de impressão, melhorando a eficiência do processo.

{
  "operation": "PRINT_TEXT",
  "styles": [{}],
  "value": ["TEXTO PARA IMPRIMIR NA PRIMEIRA LINHA\nTEXTO PARA IMPRIMIR NA SEGUNDA LINHA\nTEXTO PARA IMPRIMIR NA TERCEIRA LINHA\n\n"]
}

Neste exemplo, o texto completo é formatado como uma única string, com cada linha separada por um caractere de nova linha (“\n”).

Imagem

{
  "operation": "PRINT_IMAGE",
  "styles": [{}],
  "value": ["/storage/emulated/0/saved_images/Image-5005.jpg"]
}

Para permitir o salvamento de arquivos na DX8000, é necessário incluir o atributo android:requestLegacyExternalStorage=”true” na tag do arquivo de manifesto do Android.

Múltiplas Colunas

{
  "operation": "PRINT_MULTI_COLUMN_TEXT",
  "styles": [
    {
      "key_attributes_align": 1,
      "key_attributes_textsize": 30,
      "key_attributes_typeface": 0
    },
    {
      "key_attributes_align": 0,
      "key_attributes_textsize": 20,
      "key_attributes_typeface": 1
    },
    {
      "key_attributes_align": 2,
      "key_attributes_textsize": 15,
      "key_attributes_typeface": 2
    }
  ],
  "value": [
    "Texto alinhado à esquerda.\n\n\n",
    "Texto centralizado\n\n\n",
    "Texto alinhado à direita\n\n\n"
  ]
}

Mapa de Estilos de Impressão

Você pode formatar a sua impressão criando mapas de estilos utilizando os parâmetros disponíveis:

Exemplo de mapas de estilos:

HashMap<String, Integer> alignLeft =  new HashMap<>();
alignLeft.put("key_attributes_align", 1);
alignLeft.put("key_attributes_typeface", 0);
alignLeft.put("key_attributes_textsize", 20);

HashMap<String, Integer> alignCenter =  new HashMap<>();
alignCenter.put("key_attributes_align", PrinterAttributes.VAL_ALIGN_CENTER);
alignCenter.put("key_attributes_typeface", 1);
alignCenter.put("key_attributes_textsize", 20);

HashMap<String, Integer> alignRight =  new HashMap<>();
alignRight.put("key_attributes_align", PrinterAttributes.VAL_ALIGN_RIGHT);
alignRight.put("key_attributes_typeface", 2);
alignRight.put("key_attributes_textsize", 20);

HashMap<String, Integer> withFormFeed =  new HashMap<>();
withFormFeed.put("form_feed", 1);

HashMap<String, Integer> withoutFormFeed =  new HashMap<>();
withoutFormFeed.put("form_feed", 0);

Em plataformas que não sejam a LIO, ao realizar impressões de imagem, pode ocorrer de parte da imagem permanecer dentro da impressora após a impressão.

Para evitar esse problema, é possível utilizar a opção form_feed nos styles. Se o parâmetro não for informado, o valor padrão será 0, ou seja, não haverá espaço em branco adicional após a impressão da imagem. Caso seja necessário garantir que a imagem fique totalmente fora da impressora, basta definir o valor como 1. Exemplos na seçao de Mapa de estilos.

Serviço em Primeiro Plano com Deep Link

Para utilizar um serviço em primeiro plano para realizar tarefas críticas em segundo plano e, em seguida, iniciar uma comunicação via deep link com outro aplicativo, siga estes passos:

1. Criar um Serviço em Primeiro Plano: Implemente um serviço que seja executado em primeiro plano com uma notificação persistente.

2. Iniciar o Serviço em Primeiro Plano: Inicie o serviço antes de lançar o deep link.

3. Lançar o Deep Link: Use um Intent para iniciar o outro aplicativo através do seu deep link.

Exemplo de Implementação do Serviço em Primeiro Plano

import android.app.Notification
import android.app.NotificationChannel
import android.app.NotificationManager
import android.app.Service
import android.content.Intent
import android.os.Build
import android.os.IBinder
import androidx.core.app.NotificationCompat

class MyForegroundService : Service() {
  companion object {
    const val CHANNEL_ID = "ForegroundServiceChannel"
}

override fun onCreate() {
   super.onCreate()
   createNotificationChannel()
   val notification: Notification = NotificationCompat.Builder(this, CHANNEL_ID)
     .setContentTitle("Foreground Service")
     .setContentText("Performing critical tasks in the background")
     .setSmallIcon(android.R.drawable.ic_dialog_info)
      .build()
   startForeground(1, notification)
}

override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
    // Perform critical background tasks here
   return START_NOT_STICKY
}

override fun onDestroy() {
  super.onDestroy()
  stopForeground(true)
}

override fun onBind(intent: Intent?): IBinder? = null

private fun createNotificationChannel() {
  if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
      val serviceChannel = NotificationChannel(
        CHANNEL_ID,
        "Foreground Service Channel",
        NotificationManager.IMPORTANCE_DEFAULT
      )
      val manager = getSystemService(NotificationManager::class.java)
      manager?.createNotificationChannel(serviceChannel)
      }
  }
}

Iniciar o Serviço em Primeiro Plano e Lançar o Deep Link

import android.content.Context
import android.content.Intent
import android.net.Uri

fun startForegroundServiceAndLaunchDeepLink(context: Context, deepLink: String) {
  // Start the foreground service
val serviceIntent = Intent(context, MyForegroundService::class.java)
context.startService(serviceIntent)

// Launch the other app using its deep link
try {
    val intent = Intent(Intent.ACTION_VIEW, Uri.parse(deepLink))
    intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
    context.startActivity(intent)
} catch (e: Exception) {
    e.printStackTrace()
    // Handle the case where the deep link or app is not available
  }
}

Observações

• Substitua Foreground Service e Performing critical tasks in the background por textos apropriados para o seu aplicativo.

• Certifique-se de que o serviço em primeiro plano seja encerrado quando não for mais necessário, para evitar o uso desnecessário de recursos.

• Adicione o serviço ao seu AndroidManifest.xml :

<service
  android:name=".MyForegroundService"
  android:exported="false"
  android:foregroundServiceType="dataSync" />

INTEGRAÇÃO REMOTA

A integração remota da Cielo Smart tem como objetivo permitir que o lojista continue utilizando sua própria solução de frente de caixa (como sistemas de Automação Comercial ou PDV) e a conecte ao módulo de pedidos e pagamentos da Cielo Smart por meio de uma API desenvolvida com o padrão RESTful.

Dessa forma, toda a gestão do estabelecimento permanece sob responsabilidade da Automação Comercial. No momento do pagamento, a solução da Cielo Smart é acionada para realizar a transação de forma integrada e segura.

Siga o passo-a-passo abaixo para completar a integração remota com sucesso:

Fluxo de integração do pedido

Abaixo, estão descritas as etapas necessárias para que um pedido seja criado, transmitido e processado até seu recebimento na Cielo Smart.

1. Montagem do pedido: O cliente ou sistema inicia a criação do pedido com todos os itens e informações necessárias.

2. Envio do pedido: O pedido é finalizado e transmitido para o sistema central via API.

3. Processamento na nuvem: A API recebe o pedido e o envia para a nuvem, onde ele é armazenado e preparado para distribuição.

4. Recebimento na Cielo Smart: O dispositivo acessa a nuvem, recupera o pedido e o exibe para processamento ou finalização.

A API Order Manager da Cielo oferece os seguintes recursos:

• Utiliza semântica REST, permitindo acesso via chamadas HTTP padrão.
• Retorna códigos de status HTTP para indicar sucesso ou erro nas requisições.
• Todas as requisições e respostas são estruturadas no formato JSON, garantindo simplicidade e compatibilidade.

Exemplo de código

Você pode acessar o exemplo de código da integração entre a Automação Comercial e a API Order Manager da Cielo diretamente no GitHub. Esse exemplo demonstra como conectar sistemas de automação de vendas com a plataforma da Cielo, permitindo o gerenciamento de pedidos de forma eficiente e integrada.

Gerenciando credenciais

Para integrar sua aplicação com os serviços da Cielo, é necessário obter credenciais de autenticação, como o Client-ID, Merchant-ID e o Access Token. Essas credenciais são essenciais para garantir a segurança e a identificação da sua aplicação durante a comunicação com as APIs da Cielo.

Todo o processo de cadastro é feito pelo Portal de Desenvolvedores da Cielo. Siga os passos abaixo:

1. Acesse o Portal de desenvolvedores e clique aqui para ir diretamente para a página de cadastro de aplicativo.

2. Preencha os campos obrigatórios, incluindo: Ícone do aplicativo, Nome, Descrição.

3. Selecione a API desejada entre as opções disponíveis.

4. Clique em Registrar para concluir o processo.

Consultando credenciais de autenticação

Agora que você registrou suas credenciais de autenticações, você pode consultá-las clicando em Perfil > Client-IDs Cadastrados.

Você será redirecionado para uma tela que exibirá o Client ID e Merchant ID. Para ver o Access Tokens, clique em detalhes.

API Docs

Aqui, você encontra todas as informações sobre os Endpoints, Entidades e Recursos disponíveis na API.

Você poderá consultar os dados de entrada, exemplos de requisição e os dados de saída. Assim como entender o fluxo básico da utilização da API Order Manager da Cielo.

Endpoints: Produção e Sandbox

Para realizar testes com a API da Cielo Smart, você pode utilizar o ambiente de sandbox, que não exige o número do estabelecimento nem a posse de um terminal; basta criar uma conta no portal da Cielo e gerar seu Client-ID para obter os tokens de acesso.

Já o ambiente de produção é transacional e integrado ao sistema da Cielo, sendo utilizado para operações reais que não podem ser desfeitas. Para acessá-lo, é necessário preencher um formulário com seus dados pessoais e o número do estabelecimento, além de possuir uma Cielo Smart ativa.

Todas as chamadas devem ser executadas utilizando as respectivas credenciais dos ambientes de sandbox e produção.

Já fez os testes em Sandbox e deseja solicitar os tokens? Acesse esse link e selecione a opção Token Integração Remota.

Todas as chamadas devem ser executadas utilizando as respectivas credenciais dos ambientes de sandbox e produção.

HTTP Headers

Todas as chamadas da API Integração Remota Order Manager necessitam que as informações abaixo estejam presentes no Header na requisição:

• Client-Id: Identificador único de acesso à API. É gerado automaticamente no momento da criação do Client ID no painel do desenvolvedor.
• Access-Token: Token que define as permissões de acesso associadas ao Client-Id. Também é gerado durante a criação do Client ID no painel do desenvolvedor.
• Merchant-Id: Identificador do estabelecimento comercial no servidor da Cielo Order Manager. É gerado junto com o cadastro do Client ID.

Aprenda como registrar e consultar credenciais de autenticação.

Códigos HTTP

Os códigos do padrão HTTP, retornados como resposta à requisição feita para a API, informam se as informações enviadas à API estão de fato obtendo sucesso ao atingir nossos endpoints.

Status de pedido

Durante o ciclo de vida de um pedido, ele pode assumir os seguintes status:

Entidades

As entidades representam os principais objetos de dados utilizados na comunicação com a API da Integração Remota da Cielo Smart. Elas definem a estrutura das informações que são enviadas e recebidas durante as operações de pedidos e pagamentos.

Entre as principais entidades estão:

• Order: Representa um pedido ou ordem de pagamento. Contém dados como valor total, itens incluídos, identificadores e status da operação.
• Transaction: Refere-se a uma transação financeira, como uma venda, cancelamento ou estorno. Está diretamente ligada a uma ordem e registra os detalhes da movimentação.
• Merchant: Identifica o estabelecimento comercial que está realizando a operação. É essencial para autenticação e roteamento correto das requisições.
• Client: Representa o aplicativo ou sistema que está realizando a integração com a API, vinculado ao Client ID e Access Token.
• Device: Refere-se ao terminal físico (Cielo Smart) que executa as operações, podendo incluir informações como modelo, status e conectividade.

Em seguida, você aprende os atributos específicos de cada entidade que descrevem seu comportamento e finalidade dentro do fluxo de integração.

Order

A Order é uma representação de um pedido para a venda de um ou mais produtos e/ou serviços. É fundamental que exista uma Order para que um pagamento seja realizado na Cielo LIO.

Order Item

O Order Item é uma representação dos itens presentes em uma Order. É obrigatória a existência de, no mínimo, um Item para uma Order.

Transaction

A Transaction é uma representação com todos os pagamentos que foram realizados em uma Order. O objetivo é utilizá-la para consultar os pagamentos (transactions) que foram efetuados em uma Order.

Card

O Card é uma representação do cartão que foi utilizado para realizar o pagamento/transação.

Payment Product

O Payment Product é uma representação da forma de pagamento utilizada para realizar um pagamento. Ex.: Crédito, Débito, etc.

Recursos

POST - Criar um pedido

Esse recurso realiza a criação de um pedido no servidor do Order Manager.

Endpoint:

POST /orders

Dados de entrada:

Exemplo de requisição:

{
    "number": "0992f1d5cee540d9a9648f4d6a9e4aa6",
    "reference": "PEDIDO #1234",
    "status": "DRAFT",
    "items": [{
            "sku": "ede8f84a8b8645cb8e576a593c25c6ed",
            "name": "produto 1",
            "unit_price": 500,
            "quantity": 2,
            "unit_of_measure": "EACH"
        },
        {
            "sku": "c2f5fb9a5542406e8b7917892329cda8",
            "name": "produto 2",
            "unit_price": 1500,
            "quantity": 3,
            "unit_of_measure": "EACH"
        },
        {
            "sku": "b2j4bn6j93461385r5n90453407hjk0",
            "name": "produto 3",
            "unit_price": 550,
            "quantity": 3,
            "unit_of_measure": "EACH"
        },
        {
            "sku": "55329cda842406e8cv2f5gdf96985152d",
            "name": "produto 4",
            "unit_price": 2005,
            "unit_of_measure": "EACH"
        }
    ],
    "notes": "Mesa 1",
    "price": 9155
}

Dados de saída:

Exemplo de resposta:

{
    "id": "2e1d7b07-dcee-4a09-8d09-3bb02d94169d"
}

POST - Criar um pedido novo parâmetro PaymentCode Cielo Smart

Nos terminais DX8000, ao criar um pedido, é possível enviar a forma de pagamento previamente definida para ele. Assim, na interface da LIO, o pedido será exibido com a forma de pagamento já selecionada, facilitando o processo e reduzindo erros.

A forma de pagamento é envida no campo “payment_code”, abaixo detalharemos a lista completa dos tipos de pagamento

Endpoint:

POST /orders

Exemplo de requisição:

{
    "number": "0992f1d5cee540d9a9648f4d6a9e4aa6",
    "reference": "PEDIDO #1234",
    “payment_code”: "DEBITO_AVISTA",
    "status": "DRAFT",
    "items": [{
            "sku": "ede8f84a8b8645cb8e576a593c25c6ed",
            "name": "produto 1",
            "unit_price": 500,
            "quantity": 2,
            "unit_of_measure": "EACH"
        },
        {
            "sku": "c2f5fb9a5542406e8b7917892329cda8",
            "name": "produto 2",
            "unit_price": 1500,
            "quantity": 3,
            "unit_of_measure": "EACH"
        },
        {
            "sku": "b2j4bn6j93461385r5n90453407hjk0",
            "name": "produto 3",
            "unit_price": 550,
            "quantity": 3,
            "unit_of_measure": "EACH"
        },
        {
            "sku": "55329cda842406e8cv2f5gdf96985152d",
            "name": "produto 4",
            "unit_price": 2005,
            "unit_of_measure": "EACH"
        }
    ],
    "notes": "Mesa 1",
    "price": 9155
}

Dados de saída:

Exemplo de resposta:

{
    "id": "2e1d7b07-dcee-4a09-8d09-3bb02d94169d"
}

Lista de paymentCode

Disponibilizamos também a lista do campo “paymentCode”:

GET - Consultar pedido

Esse recurso é utilizado para obter informações sobre um pedido específico. O id do pedido é utilizado para realizar a chamada.

Endpoint:

GET /orders/{id}

Dados de entrada:

Exemplo de requisição:

GET

Dados de saída:

Exemplo de resposta:

{
    {
    "id": "b4d8a7dc-4250-48a3-bf18-d560d4508368",
    "number": "0992f1d5-cee5-40d9-a964-8f4d6a9e4aa6",
    "reference": "LOJA SUCO #1",
    "status": "ENTERED",
    "notes": "Mesa 6",
    "price": 5250,
    "created_at": "2016-09-06T19:09:49Z",
    "updated_at": "2016-09-06T19:09:49Z",
    "order_type": "PAYMENT",
    "merchant": "0010920335960001",
    "source_id": "4QeQD63ZeKsz",
    "items": [{
            "id": "0687f00a-0aea-48f7-85d0-64bc31977734",
            "sku": "0000001",
            "name": "Suco Detox",
            "unit_price": 800,
            "quantity": 1,
            "unit_of_measure": "EACH"
        },
        {
            "id": "cf561196-4e4c-436b-816b-80190e9a705f",
            "sku": "0000010",
            "name": "Suco de Uva",
            "unit_price": 450,
            "quantity": 5,
            "unit_of_measure": "EACH"
        },
        {
            "id": "16b4b10b-9967-477b-91a2-ecc02e6ff40c",
            "sku": "0000011",
            "name": "Suco de Tomate",
            "unit_price": 500,
            "quantity": 2,
            "unit_of_measure": "EACH"
        },
        {
            "id": "8500c747-1740-47cf-908a-3ab0f8b44193",
            "sku": "0000100",
            "name": "Suco de Abacaxi",
            "unit_price": 400,
            "quantity": 3,
            "unit_of_measure": "EACH"
        }
    ],
    "transactions": []
    }
}

GET - Consultar todos os Pedidos

Esse recurso é utilizado para obter a lista e as informações de todos os pedidos cadastrados no Order Manager.

Endpoint:

GET /orders/

Dados de entrada:

Exemplo de requisição:

GET

Dados de saída:

Exemplo de resposta:

{
    "id": "b4d8a7dc-4250-48a3-bf18-d560d4508368",
    "number": "0992f1d5-cee5-40d9-a964-8f4d6a9e4aa6",
    "reference": "LOJA SUCO #1",
    "status": "ENTERED",
    "notes": "Mesa 6",
    "price": 5250,
    "created_at": "2016-09-06T19:09:49Z",
    "updated_at": "2016-09-06T19:09:49Z",
    "order_type": "PAYMENT",
    "merchant": "0010920335960001",
    "source_id": "4QeQD63ZeKsz",
    "items": [{
            "id": "0687f00a-0aea-48f7-85d0-64bc31977734",
            "sku": "0000001",
            "name": "Suco Detox",
            "unit_price": 800,
            "quantity": 1,
            "unit_of_measure": "EACH"
        },
        {
            "id": "cf561196-4e4c-436b-816b-80190e9a705f",
            "sku": "0000010",

            "name": "Suco de Uva",
            "unit_price": 450,
            "quantity": 5,
            "unit_of_measure": "EACH"
        },
        {
            "id": "16b4b10b-9967-477b-91a2-ecc02e6ff40c",
            "sku": "0000011",
            "name": "Suco de Tomate",
            "unit_price": 500,
            "quantity": 2,
            "unit_of_measure": "EACH"
        },
        {
            "id": "8500c747-1740-47cf-908a-3ab0f8b44193",
            "sku": "0000100",
            "name": "Suco de Abacaxi",
            "unit_price": 400,
            "quantity": 3,
            "unit_of_measure": "EACH"
        }
    ],
    "transactions": []
}

Na consulta de pedidos, é possível informar os parâmetro acima citados, para identificar as ordens criadas conforme mostrado no exemplo abaixo:

https://api.cielo.com.br/order-management/v1/orders/?reference=EXEMPLO_DE_REFERENCE

PUT- Alterar status de um pedido

Esse recurso realiza a alteração do status de um pedido criado. O id do pedido é utilizado para realizar a chamada.

As possíveis alterações de status são:

• PLACE (Liberar um pedido para pagamento, exibir pedido na Cielo LIO)
• PAY (Alterar um pedido para pago)
• CLOSE (Fechar um pedido)

Endpoint:

PUT /orders/{id}?operation={operation}

Dados de entrada:

Exemplo de requisição:

PUT

Dados de saída:

Exemplo de resposta:

N/A

O retorno 200 dessa operação representa sucesso na requisição.

DELETE - Excluir um pedido

Esse recurso é utilizado para excluir um pedido do servidor do Order Manager. O id do pedido é utilizado para realizar a chamada.

Somente os pedidos com status DRAFT podem ser excluídos.

Endpoint:

DELETE /orders/{id}

Dados de entrada:

Exemplo de requisição:

DELETE

Dados de saída:

Exemplo de resposta:

N/A

O retorno 200 dessa operação representa sucesso na requisição.

POST - Adicionar Item/Itens em um Pedido

Esse recurso é utilizado para adicionar um ou mais itens em um pedido já criado. O id do pedido é utilizado para realizar a chamada.

Somente os pedidos com status DRAFT podem ter adição de itens.

Endpoint:

POST /orders/{id}/items

Dados de entrada:

Exemplo de requisição:

{
    "sku": "ede8f84a8b8645cb8e576a593c25c6ed",
    "name": "produto 1"
    "unit_price": 500,
    "quantity": 2,
    "unit_of_measure": "EACH"
}

Dados de saída:

Exemplo de resposta:

N/A

O retorno 200 dessa operação representa sucesso na requisição.

GET - Consultar os itens de um pedido

Esse recurso é utilizado para consultar os itens presentes em um pedido. O id do pedido é utilizado para realizar a chamada.

Endpoint:

GET /orders/{id}/items

Dados de entrada:

Exemplo de requisição:

GET

Dados de saída:

Exemplo de resposta:

[{
        "id": 1,
        "sku": "ede8f84a8b8645cb8e576a593c25c6ed",
        "name": "produto 1"
        "unit_price": 500,
        "quantity": 2,
        "unit_of_measure": "EACH"
    },
    {
        "id": 2,
        "sku": "c2f5fb9a5542406e8b7917892329cda8",
        "name": "produto 1"
        "unit_price": 1500,
        "quantity": 3,
        "unit_of_measure": "EACH"
    }
]

PUT - Alterar um item em um pedido

Esse recurso permite alterar informações de um item de um pedido. O id do pedido e o id_item são utilizados para realizar a chamada.

Somente os pedidos com status DRAFT podem ter itens alterados.

Endpoint:

PUT /orders/{id}/items/{id_item}

Dados de entrada:

Exemplo de requisição:

PUT /items/8484df74-eca6-4850-8e4c-35653af0bd31

{
    "sku": "ede8f84a8b8645cb8e576a593c25c6ed",
    "unit_price": 500,
    "quantity": 2,
    "unit_of_measure": "EACH"
}

Dados de saída:

O retorno 200 dessa operação representa sucesso na requisição.

DELETE - Excluir Item de um pedido

Esse recurso é utilizado para excluir um item presente em um pedido. O id do pedido e o id_item são utilizados para realizar a chamada.

Somente os pedidos com status DRAFT podem ter itens alterados.

Endpoint:

DELETE /orders/{id}/items/{id_item}

Dados de entrada:

Exemplo de requisição:

DELETE

Dados de saída:

O retorno 200 dessa operação representa sucesso na requisição.

POST - Adicionar uma Transação

Recurso utilizado somente para Ambiente de Sandbox

Esse recurso permite que o desenvolvedor simule as transações financeiras, adicionando-as manualmente, sendo possível entender o funcionamento em uma Order.

Endpoint:

POST /orders/{id}/transactions

Dados de entrada:

Exemplo de requisição:

POST

{
  "external_id": "0b37f0d8-017a-4b11-91b9-ec1bb3e8fed3",
  "status": "CONFIRMED",
  "terminal_number": "12345678",
  "authorization_code": "008619",
  "number": "672836",
  "amount": 2000,
  "transaction_type": "PAYMENT",
  "paymentFields": {
    "primaryProductName": "CREDITO",
    "secondaryProductName": "A VISTA",
    "numberOfQuotas": 0
  },
  "card": {
  "brand": "VISA",
  "mask": "******5487"
  }
}

Dados de saída:

{
id: "00219dd0-1c13-46da-91e5-1c313f0d2e83"
}

Em ambiente de Sandbox, onde não há necessidade de ter uma Cielo LIO, e consequentemente não é necessário possuir o número do estabelecimento, faz total sentido fazer essa chamada deste recurso.

Já em ambiente de Produção quem irá criar as transactions é a própria Cielo LIO conforme os pagamentos forem efetuados.

GET - Consultar as transações de um pedido

Esse recurso é utilizado para obter as informações de todas as transações realizadas em um pedido. O id do pedido é utilizado para realizar a chamada. Em ambiente de produção, uma vez que um pagamento for realizado na Cielo LIO a transactions será adicionada automaticamente no pedido e então, será possível obter as informações do pagamento realizado a partir da chamada deste recurso.

Endpoint:

GET /orders/{id}/transactions

Dados de entrada:

Exemplo de requisição:

GET

Dados de saída:

Exemplo de resposta:

[
{
  "id": "442bbdbe-41c8-4e22-83ee-e1a849ed3cb5",
  "external_id": "0b37f0d8-017a-4b11-91b9-ec1bb3e8fed3",
  "status": "CONFIRMED",
  "terminal_number": "77102648",
  "authorization_code": "008619",
  "number": "672836",
  "amount": 2000,
  "transaction_type": "PAYMENT",
  "payment_fields": {
  "primary_product_name": "CREDITO",
  "secondary_product_name": "A VISTA",
    "number_of_quotas": 0
  },
  "card": {
    "brand": "VISA",
    "mask": "************3542"
  }
}
]

Cancelar Pedidos

O cancelamento de pedidos é realizado apenas através da Cielo LIO. Selecione a função Cancelamento de Vendas e digite o CNPJ da empresa (o mesmo que pode ser visualizado através do comprovante de pagamento). O sistema irá solicitar a senha do supervisor. Siga todos os passos indicados nas telas seguintes para o cancelamento da venda. É importante salientar que um cancelamento só pode ser realizado em ser valor integral.

GET - Consultar as transações canceladas de um pedido

Esse recurso é utilizado para obter as informações de todas as transações canceladas em um pedido. O id do pedido é utilizado para realizar a chamada. Em ambiente de produção, uma vez que o cancelamento for realizado na Cielo LIO a transactions será adicionada automaticamente no pedido juntamente com a transaction do pagamento original.

Endpoint:

GET /orders/{id}/transactions

Dados de entrada:

Exemplo de requisição:

GET

Dados de saída:

Exemplo de resposta:

[
  {
    "id": "46019c39-989e-46e9-aa7d-d8e9414396b4",
    "external_id": "95185.99407021694",
    "status": "CONFIRMED",
    "terminal_number": "77102648",
    "authorization_code": "008619",
    "number": "672837",
    "amount": 2000,
    "transaction_type": "CANCELLATION",
    "payment_fields": {
    "primary_product_name": "CREDITO",
    "secondary_product_name": "A VISTA",
    "number_of_quotas": 0
  },
    "card": {
      "brand": "VISA",
      "mask": "************3542"
    }
  },
  {
    "id": "442bbdbe-41c8-4e22-83ee-e1a849ed3cb5",
    "external_id": "0b37f0d8-017a-4b11-91b9-ec1bb3e8fed3",
    "status": "CONFIRMED",
    "terminal_number": "77102648",
    "authorization_code": "008619",
    "number": "672836",
    "amount": 2000,
    "transaction_type": "PAYMENT",
    "payment_fields": {
    "primary_product_name": "CREDITO",
    "secondary_product_name": "A VISTA",
    "number_of_quotas": 0
   },
    "card": {
    "brand": "VISA",
    "mask": "************3542"
    }
  }
]

Fluxo Básico Utilização API Order manager

Abaixo você encontra um fluxo básico para enviar um pedido para a Cielo LIO utilizando a Integração Remota:

Notificações de Mudanças na Order

Para o cadastro da URL onde enviaremos as notificações Entre em contato conosco atráves do nosso time de Suporte a Desenvolvimento informando o seu endpoint

O maior motivo da disponibilização da API RESTful do Order Manager é permitir que aplicações parceiras se integrem à plataforma da Cielo na cloud. Porém, uma vez que as aplicações parceiras submetem pedidos, estes devem ser pagos localmente na própria Cielo LIO. Sendo assim, as aplicações parceiras precisam de uma forma de receber notificações de mudanças do status e das transações realizadas na Order.

Para tal, é necessário que o parceiro disponibilize um Backend RESTful, que irá receber as notificações seguindo o formato abaixo. Uma vez recebidas as informações, o Backend tem a liberdade de ser utilizado da forma mais adequada ao modelo de negócio.

Atenção: Os campos podem sofrer alterações sem aviso prévio, recomendamos que o PARSE do json seja dinâmico para aceitar novos valores em campos que ja enviamos hoje. Exemplo: O campo brand, caso surja novas bandeiras o seu backend precisa estar pronto para essa alteração.

POST - Notificação de Mudança de Status

A cada modificação de status em um pedido, o servidor do Order Manager envia, via comando, as informações para o Backend do parceiro.

Atenção: O backend do parceiro deve possuir o status anterior

Requisição do Order Manager

POST

Exemplo de informação enviada pelo Order Manager

{
	"id":"943f2276-5e2b-44bb-a68a-fd9b6418afa4",
	"items":[
		{
			"id":4389df04-ef19-4217-a969-22cb6e86d8cf",
			""sku"":"1",
			""name"":""TESTE CALLBACK"",
			""uuid"":"438232f04-ef19-4217-a969-22cb6e86d8cf",
			""details"":null,
			""order_id"":943f2276-5e2b-44bb-a68a-fd9b6418afa4",
			"quantity":1,
			"sku_type":null,
			"reference":null,
			"created_at":"2023-01-04T14:20:28Z",
			"unit_price":2392,
			"updated_at":"2023-01-04T14:20:24Z",
			"description":"TESTE CALLBACK",
			"unit_of_measure":"EACH"
		}
	],
	"notes":"TESTE",
	"price":2898,
	"number":"1078069",
	"status":"CLOSED",
	"reference":"REFERENCIA DO PEDIDO",
	"created_at":"2023-04-04T14:33:28Z",
	"updated_at":"2023-04-04T16:19:37Z",
	"transactions":[
		{
			"id":"d7d5cab9-f5b0-4a14-8593-9793a0aae193",
			"card":{
				"mask":"************3026",
				"brand":"MASTERCARD"
			},
			"uuid":"d7d5cab9-f5b0-4a14-8593-9793a0aae193",
			"amount":2392,
			"number":"044976",
			"status":"CONFIRMED",
			"created_at":"2023-04-04T14:34:24Z",
			"updated_at":"2023-04-04T16:19:37Z",
			"description":"",
			"external_id":"7d7d5cab9-f5b0-4a14-8593-9793a0aae193",
			"payment_fields":{
				"pan":"************3332",
				"v40Code":8,
				"typeName":"VENDA A DEBITO",
				"cityState":"SAO PAULO SP",
				"serviceTax":0,
				"statusCode":1,
				"boardingTax":0,
				"hasPassword":false,
				"hasWarranty":false,
				"productName":"DEBITO A VISTA",
				"requestDate":1680618831267,
				"changeAmount":0,
				"documentType":"J",
				"entranceMode":"691010107080",
				"hasSignature":false,
				"merchantCode":"0010225646149400",
				"merchantName":"NOME DO ESTABELECIMENTO",
				"applicationId":"cielo.launcher",
				"totalizerCode":92,
				"upFrontAmount":0,
				"creditAdminTax":0,
				"firstQuotaDate":0,
				"interestAmount":0,
				"isExternalCall":true,
				"numberOfQuotas":0,
				"applicationName":"cielo.launcher.ORDER",
				"avaiableBalance":0,
				"cardCaptureType":3,
				"finalCryptogram":"21FDEF2548665F36",
				"hasConnectivity":true,
				"merchantAddress":"QNM 17 CJH LT28",
				"paymentTypeCode":1,
				"firstQuotaAmount":0,
				"hasSentReference":false,
				"isFinancialProduct":true,
				"primaryProductCode":2000,
				"primaryProductName":"DEBITO",
				"hasSentMerchantCode":false,
				"cardLabelApplication":"Debito Nubank",
				"paymentTransactionId":"d7d5cab9-f5b0-4a14-8593-9793a0aae193",
				"secondaryProductCode":1,
				"secondaryProductName":"A VISTA",
				"originalTransactionId":"0",
				"receiptPrintPermission":1,
				"hasPrintedClientReceipt":false,
				"isDoubleFontPrintAllowed":false,
				"isOnlyIntegrationCancelable":false
			},
			"terminal_number":"238232",
			"transaction_type":"PAYMENT",
			"authorization_code":"123562"
		}
	]
}

POST - Notificação de Transação Realizada

A cada transação/pagamento realizada em um pedido, o servidor do Order Manager envia, via comando, as informações para o Backend do parceiro.

Requisição do Order Manager

POST

Exemplo de informação enviada pelo Order Manager

{
  "id": "f0f0f0f0-f0f0-f0f0-f0f0-f0f0f0f0f0f0",
  "order_id": "f0f0f0f0-f0f0-f0f0-f0f0-f0f0f0f0f0f0",
  "trasaction": {
    "id": "f0f0f0f0-f0f0-f0f0-f0f0-f0f0f0f0f0f0",
    "external_id": "f0f0f0f0-f0f0-f0f0-f0f0-f0f0f0f0f0f0",
    "description": "",
    "status": "CONFIRMED",
    "terminal_number": "###324625",
    "authorization_code": "0#1#133",
    "number": "##50##",
    "amount": "1",
    "transaction_type": "PAYMENT",
    "payment_fields": {
      "primary_product_name": "CREDITO",
      "secondary_product_name": "A VISTA",
      "number_of_quotas": "0"
    },
    "card": {
      "brand": "MASTERCARD",
      "mask": "************0566"
    }
  }
}

Notificações dos pedidos

Política de retentativa

• O envio da notificação para um pedido será retentada a cada 15 minutos, durante um período total de 7 horas.
• Em caso de falha em todas as retentativas neste período, as notificações deste mesmo pedido serão bloqueadas.
• Haverá tentativa de notificação para um pedido, mesmo que as notificações de outro pedido tenham sido bloqueadas.

Bloqueio de notificações para o EC

• O EC deixará de receber notificações caso o percentual de pedidos bloqueados seja igual ou superior a 80% nas últimas 24 horas.

Desbloqueio de notificações para o EC

• Entre em contato conosco para solicitar o desbloqueio, informando o número do EC e o endereço do serviço, caso haja alteração.

PIX

O que é o Pix

O Pix é o meio de pagamento criado pelo Banco Central em que os recursos são transferidos entre contas e poucos segundos, a qualquer hora ou dia. O Pix é um novo jeito de vender de forma instantânea, segura e simples pelas soluções da Cielo.

Como habilitar o pagamento PIX?

Para que seja possível efetivar um pagamento utilizando a forma de pagamento PIX, é necessário que o estabelecimento tenha esse tipo de pagamento habilitado.

Para realizar essa ação, siga as instruções abaixo.

Após essa habilitação via Site Cielo o estabelecimento estará apto a trabalhar com a modalidade PIX.

Habilitando pagamento PIX

Para que seja possivel efetivar um pagamento utilizando a forma de pagamento PIX, é necessário que o estabelecimento tenha esse tipo de pagamento habilitado.

1 Entrar no site Cielo com seu login e senha

2 Clicar em “Meu cadastro”

P3 Clicar em “Autorizações”

P4 Clicar em “PIX

5 Marcar a caixa de aceite , e clicar em “Enviar

Após essa habilitação via Site Cielo o estabelecimento estará apto a trabalhar com a modalidade PIX.

PERGUNTAS FREQUENTES (FAQ)

Terminais Cielo Smart

Como solicito uma Cielo Smart para testes?

Clique aqui para aprender como solicitar uma Cielo Smart para testes e publicação de aplicativos.

Como faço para integrar com a Cielo Smart?

A Cielo oferece um Portal exclusivo para desenvolvedores, criado para facilitar a integração de soluções com a Cielo Smart.

Nesse portal, você pode:

• Acessar a documentação completa das APIs disponíveis;
• Utilizar SDKs que agilizam o processo de integração;
• Criar sua conta para obter as chaves de acesso (tokens);
• Realizar testes e desenvolver sua aplicação utilizando emuladores ou ambientes sandbox.

Quais são as formas de comunicação da Cielo Smart?

A Cielo Smart conta com entrada para SIM Card, permitindo conexão via rede móvel 4G, com fallback automático para 3G, 2G e GPRS, conforme a disponibilidade da rede. Além disso, o terminal também oferece conectividade via Wi-Fi, garantindo flexibilidade na comunicação.

Se eu trocar o terminal Cielo Smart, o catálogo cadastrado migra automaticamente para a nova máquina recebida?

Não migra. Para que o catálogo fique na nuvem, é preciso de um aplicativo que tenha essa funcionalidade.

Minha Cielo Smart não está baixando um aplicativo. O que fazer?

Verifique se o terminal está com mais de 50% de bateria e confirme se está conectado à internet via 4G ou Wi-Fi. Se todos esses requisitos estiverem atendidos e o problema persistir, entre em contato com o suporte técnico.

Cielo Store, aplicativos públicos e privados

Fiz o meu cadastro no Dev Console. E agora?

Agora você deve escolher em que tipo de loja você deseja disponibilizar seu app. Clique aqui para entender as diferenças entre as lojas públicas e privadas.

Quais são os navegadores recomendados para upload de aplicativo na Cielo Store?

Recomendamos utilizar o Google Chrome ou Mozilla Firefox preferencialmente para realizar o upload de aplicativos na Cielo Store.

Como disponibilizo o meu aplicativo em loja privada e pública?

Após a aprovação na etapa de certificação, realizada pelo time especialista da Cielo, você será notificado e deverá promover o aplicativo para o ambiente de produção.

A publicação do aplicativo pode ser realizada em dois modelos: loja pública, onde o app fica disponível para todos os clientes Cielo; ou loja privada, que limita o acesso a um grupo específico de clientes, conforme definido pelo desenvolvedor do aplicativo.

Para saber como realizar cada tipo de publicação, consulte os guias abaixo:

• Como publicar seu aplicativo em loja pública
• Como publicar seu aplicativo em loja privada

É necessário estar cadastrado na Cielo para receber pagamentos pelos aplicativos?

Sim. Para receber pagamentos, o desenvolvedor precisa ter uma conta ativa no site da Cielo. Isso ocorre porque os repasses são feitos por meio de agenda financeira, e é necessário possuir um Estabelecimento Comercial (EC) cadastrado.

Para se cadastrar:

1. Acesse o site da Cielo.

2. No canto superior direito, clique em Acessar minha conta.

3. Selecione a opção Cadastre-se.

4. Clique em Criar cadastro e preencha os dados solicitados.

Após o cadastro, você poderá vincular seu aplicativo ao EC e receber os valores das transações realizadas.

Existe algum custo para publicar meu aplicativo na Cielo Store?

Não. A integração e publicação de aplicativos na Cielo Store são totalmente gratuitas.

Quais são as etapas para publicar meu aplicativo?

Durante o processo de publicação de um aplicativo, ele passará pelos seguintes status no Dev Console: assinatura, desenvolvimento, certificação e piloto/produção. Clique aqui para saber mais.

O que é a Cielo Store

A Cielo Store é a loja de aplicativos disponível nos dispositivos Cielo Smart. Assim como você acessa a Play Store ou App Store para baixar aplicativos no seu celular, os estabelecimentos comerciais utilizam a Cielo Store para instalar soluções que atendem às suas necessidades operacionais.

Na Cielo Store, estão disponíveis mais de 50 aplicativos voltados para o varejo, permitindo que o lojista escolha e instale ferramentas para gestão de vendas, controle de estoque, administração de equipe, integração de sistemas, entre outras funcionalidades, tudo diretamente na maquininha, com apenas um clique.

Como altero o nome do meu aplicativo?

A alteração do nome de um aplicativo já cadastrado não é permitida. Caso seja necessário modificar o nome, será preciso criar um novo aplicativo com um package name diferente e seguir o processo padrão de envio e certificação na Cielo Store.

Posso editar as informações do meu aplicativo já publicado?

Sim. É possível atualizar as informações do aplicativo diretamente pelo Dev Console.

Para saber como realizar cada tipo de publicação, consulte os guias abaixo:

• Como realizar alterações em seu aplicativo em loja pública.
• Como realizar alterações em seu aplicativo em loja privada.

Como baixo aplicativos?

Para saber como realizar cada tipo de publicação, consulte os guias abaixo:

• Como fazer download de aplicativos em loja pública
• Como fazer download de aplicativos em loja privada

Como faço para consultar minha comissão referente a aplicativos de loja pública?

Entre no site da Cielo com suas credenciais. Acesse o menu Recebíveis > Detalhado > Selecionar uma ou duas datas. Serão exibidos os valores pagos e a data com a descrição Repasse ao desenvolvedor sobre a compra de aplicativo no Cielo Store. Cada linha exibida é referente a uma assinatura ativa.

Como cancelo a assinatura de um aplicativo?

1. Clique na opção Apps.

2. Selecione Cielo Store.

3. Escolha o aplicativo.

4. Clique em Desinstalar.

5. Preencha com usuário e senha criados no site Cielo.

Integrações

Integração local

A integração local permite que seu aplicativo embarcado na Cielo Smart utilize os recursos nativos do dispositivo, como pagamento, impressão e cancelamento. O app instalado na Smart se comunica com o módulo de pedidos e pagamentos por meio do Cielo Smart Order Manager SDK.

Quais são as linguagens suportadas?

Você pode desenvolver seu aplicativo utilizando Java ou Kotlin, integrando diretamente com o SDK.

Existe um aplicativo de exemplo?

Sim. Disponibilizamos um aplicativo de exemplo no GitHub para que os desenvolvedores possam entender como funcionam as chamadas do SDK.

É necessário incluir todos os itens do pedido na ordem?

Sim. O Cielo Smart trabalha com o conceito de Order (Pedido). O fluxo básico é:

1. Criar uma ordem com status draft

2. Adicionar os itens à ordem

3. Preparar a ordem para pagamento (place order)

4. Executar o checkout

Se o seu app trabalha com diversos produtos, é recomendável criar itens separados para facilitar os relatórios do lojista no Cielo Smart.

Preciso de um terminal Cielo Smart para testar?

Não. A Cielo oferece um emulador que simula o ambiente do Smart em qualquer dispositivo Android. Com ele, você pode testar os métodos do SDK e fazer o debug da sua aplicação sem precisar do hardware físico. Clique aqui para aprender mais sobre o emulador.

Preciso me cadastrar para realizar os testes?

Sim. É necessário se cadastrar no portal de desenvolvedores da Cielo para obter os tokens de acesso e testar sua aplicação.

Integração remota

Na Integração remota você utiliza o seu PDV (Sistema Desktop ou Web) para gerar os pedidos e enviar para a Cielo LIO efetuar o recebimento.

Preciso me cadastrar para realizar testes?

Sim. É necessário se cadastrar no portal de desenvolvedores da Cielo para obter os tokens de acesso e testar sua aplicação.

Pix

Como habilito o pagamento Pix?

Para que seja possível efetivar um pagamento utilizando a forma de pagamento Pix, é necessário que o estabelecimento tenha esse tipo de pagamento habilitado.

Siga as instruções através desse link. Após essa habilitação via Site Cielo o estabelecimento estará apto a trabalhar com a modalidade Pix.