Importante

Novo Cielo Smart

Chegou a Cielo Smart, a solução que é a evolução da LIO On e que traz mais eficiência e praticidade para o desenvolvimento dos aplicativos!

Com a Cielo Smart você aproveita:

1. Compatibilidade ampliada – use seu app em novos terminais sem desenvolvimento adicional
2. Mais robustez e velocidade – melhor tempo de aprovação nos pagamentos
3. Smart First – todas as melhorias e novas funcionalidades serão implementadas somente na Cielo Smart

Adapte seus apps com a integração via Deeplink e aproveite novas funcionalidades sem a necessidade de atualizar bibliotecas externas e simplifique suas implementações. Caso já utilize a integração via Deeplink, segue abaixo como se adaptar para o novo Cielo Smart:

Integração via Deeplink

• Incluir uma nova tag no arquivo AndroidManifest.xml para que o App possa ser distribuído corretamente para os terminais no processo de publicação

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

• Garantir a compatibilidade com o Android 10 (permissões, notificações, criação de intents, etc)

Beneficios da Integração via Deeplink

Recomendamos nossa integração via deeplink, por oferecer vários benefícios como:

1. Independência de Atualizações: Não é necessário aguardar atualizações do SDK do fabricante para corrigir bugs ou adicionar novas funcionalidades.
2. Menor Tamanho do Aplicativo: Evita adicionar bibliotecas externas, reduzindo o tamanho do aplicativo.
3. Facilidade de Implementação: Integrações via deeplink geralmente são mais simples e rápidas de implementar.
4. Flexibilidade: Permite maior flexibilidade para personalizar a integração conforme as necessidades específicas do aplicativo.
5. Compatibilidade: Reduz problemas de compatibilidade com diferentes versões de SDKs e dispositivos.
6. Compatibilidade de bibliotecas terceiras: Caso o projeto de integração utilize uma biblioteca de terceiro e o SDK também, dependendo das diferentes versões, podemos ter problema de compatibilidade.
7. Manutenção Simplificada: Facilita a manutenção do código, pois não depende de atualizações e mudanças no SDK do fabricante.
8. Desempenho: Pode melhorar o desempenho do aplicativo, evitando a sobrecarga de um SDK adicional.
9. Segurança: Reduz a superfície de ataque, pois não incorpora código de terceiros diretamente no aplicativo.

Para saber mais, acesse AQUI a documentação de Integração via Deeplink

Pix na LIO ON

Viemos informar que uma nova versão do SDK está disponível no Portal do desenvolvedor. Para acessá-la, basta efetuar o login e realizar o download da versão mais recente.

Essa atualização foi projetada para aprimorar a experiência do cliente, incorporando o PIX, melhorias na contagem de linhas impressas nos comprovantes, o que resulta na oferta de bobinas gratuitas aos clientes. Estamos comprometidos em aprimorar constantemente a experiência do usuário final.

Para garantir a compatibilidade com a nova versão do SDK e oferecer uma melhor experiência aos usuários finais, solicitamos que você faça a atualização. Este processo é simples e pode ser realizado através do nosso Portal do Desenvolvedor.

Acesse o Portal do Desenvolvedor para iniciar a atualização dos seus aplicativos.

Agradecemos antecipadamente pela sua colaboração na atualização dos seus aplicativos. Esta iniciativa reflete nosso compromisso contínuo em fornecer soluções inovadoras e de alta qualidade para nossos usuários.

Para saber mais clique na ABA PIX.

Documentação Cielo LIO

Nessa documentação você tem acesso a todas as informações sobre a plataforma Cielo LIO e boas práticas para o desenvolvimento e modelos de integração disponíveis para complementar o negócio de seu cliente.

O objetivo dessa documentação é facilitar o processo de desenvolvimento fornecendo os materiais necessários para realizar a integração com a Cielo LIO e todos os conceitos sobre a Cielo Store, a loja de aplicativos da Cielo disponível na Cielo LIO

Visão Geral da Plataforma

Cielo LIO

É uma plataforma aberta que fornece controle e gestão de negócios indo além de um sistema de pagamentos tradicional. 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.

L300 - Positivo

DX8000 - Ingenico

Caracteristicas dos terminais

A LIO ON possui algumas funcionalidades exclusivas como por exemplo:

Impressora térmica: o cliente poderá ter a 1ª e 2ª via impressa após o pagamento realizado. Além disso, as aplicações parceiras poderão utilizar os métodos disponíveis da impressora para imprimir dados importantes ou necessários para o negócio do cliente.

Especificação da Bobina: Papel Azul 48 gramas, Comprimento: 12 metros, Diâmetro máximo: 30 milímetros, Largura: 57 milímetros.

NFC: tecnologia presente permitindo o pagamento utilizando cartões com tecnologia contactless.

Arquitetura

Sobre

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 Documentação da Integração Remota
• Chamadas via intenet, de forma que aplicativos de parceiros possam se integrar com as funcionalidades de pagamento da Cielo LIO. Acesse Documentação da Integração via Deeplink

Modelos de integração com a plataforma Cielo LIO

Integração Remota | Cielo LIO Order Manager

Conjunto de APIs que permitem que o cliente continue utilizando sua solução de PDV / Automação Comercial com todas as funcionalidades. No momento de realizar o pagamento, ocorre a integração com o gerenciador de pedidos (Order Manager) da Cielo LIO, de forma rápida, simples e segura. Ir para integração remota

Integração via Deeplink

A Cielo oferece integração via intents para comunicação por meio de deep links, permitindo que aplicativos Android se integrem a recursos como pagamento, impressão e cancelamento Ir para integração via Deeplink

Serviços periféricos

A Cielo LIO também se integra com os seguintes periféricos de hardware:

Impressoras Bluetooth

É possível conectar a Cielo com impressoras bluetooth para realizar a impressão de recibos e outras informações importantes.

Já existem parceiros que estão utilizando impressoras Bluetooth das marcas Zebra, Datex, Leopardo integradas com a Cielo LIO

Todos os protocolos de comunicação e pareamento ficam sob responsabilidade do aplicativo do parceiro.

Leitores de RFID

Já existem parceiros que estão utilizando leitores RFID em suas soluções.

Todos os protocolos de comunicação e pareamento ficam sob responsabilidade do aplicativo do parceiro.

Especificações técnicas do hardware da Cielo LIO

A plataforma Cielo LIO teve seu sistema operacional próprio baseado em Android para os terminais LIO V2 e V3. Para os novos terminais utilizamos o Android Security OS. Confira abaixo a tabela com as especificações técnicas da Cielo LIO:

Versão	LIO V2	LIO V3	DX8000
Sistema operacional	Android OS Cielo 6.0 (Marshmallow)	Android 7.1 (Nougat)	Android 10 Security OS
Memória	2GB RAM	1GB RAM	1GB RAM
Armazenamento	16 GB	8 GB	8 GB
Dual Chip	-	-	Sim
Frequência	2.4 GHz	2.4GHz + 5.0 GHz	2.4GHz + 5.0 GHz
Tipo do SIM Card	micro SIM (3FF)	1 SIM card (2FF) + ESIM	2 SIM card (2FF) + ESIM
Frequência GSM Mhz	Quad-Band 850/900/1800/1900	Quad-Band	Quad-Band
Tamanho em polegadas	5.5”	5”	5.5”
Tipo de tela	AMOLED	AMOLED	AMOLED
Resolução da tela	720 x 1280	720 x 1280	720 x 1280
Densidade de pixels	267 ppi	267 ppi	1080p
Câmera	8 Mega Pixels	5 Mega Pixels	5 Mega Pixels
Resolução da câmera	4160 x 3120 pixels	4160 x 3120 pixels	4160 x 3120 pixels
Flash	Flash LED	Flash LED	Flash LED
USB	USB 2.0 Micro-B (Micro-USB) Somente Energia	USB Tipo C	USB Tipo C
Bluetooth	Versão 4.0 com A2DP/LE	Versão 4.2	Versão 4.2
WiFi	802.11 b/g/n (2.4GHz)	802.11a/b/g/n(2.4GH+5.0GHz)	802.11a/b/g/n(2.4GH+5.0GHz)
GPS	A-GPS	GPS + A-GPS, Glonass	GPS + A-GPS, Glonass
Sensores	Acelerômetro, Proximidade e Luminosidade	Acelerômetro, Prox. e Lumin	Acelerômetro, Prox. e Lumin
Saída de áudio	Audio Jack 3.5mm	Audio Jack 3.5mm	-
Peso	507 g	417 g	450 g
Altura	46mm	70mm	198mm
Largura	81mm	82mm	83mm
Comprimento	228mm	205mm	62.5mm

Rotação de tela na Cielo LIO

Na LIO é possível controlar a orientação da tela. Por padrão, a orientação da tela exibida é livre e definida de acordo com o acelerômetro do equipamento.

Caso o desenvolvedor deseje controlar e usar de forma personalizada a orientação de tela da Cielo LIO, este deverá utilizar de acordo com a documentação do Android.

Acesse o item: android:screenOrientation para obter maiores informações.:

Atenção: Documentação Oficial do Android

Dados Móveis na Cielo LIO

A Cielo LIO já vem configurada com um SIM Card. A operadora do SIM Card é definida de acordo com o endereço de cadastro do estabelecimento comercial.

A Cielo envia o SIM Card da melhor operadora de acordo com o endereço de cadastro da LIO solicitada.

Esse SIM Card permite a conexão com a tecnologia 3G/4G da Cielo LIO e possui um pacote de dados ilimitado.

Dicas para desenvolvedores

O guia abaixo fornece as informações necessárias para ajudar os desenvolvedores a integrar ou desenvolver seus aplicativos na plataforma Cielo LIO da melhor maneira possível, de modo a oferecer uma experiência excelente para os estabelecimentos comerciais.

Recomenda-se a leitura detalhada na documentação da Cielo LIO presente no Portal de Desenvolvedores. Essa documentação reúne informações importantes para questões de simplicidade moderada.

Melhores práticas com a plataforma Cielo LIO

Segurança de dados e Privacidade

• Proteja os dados confidenciais de clientes e funcionários. Não exponha publicamente nomes, endereços ou números de telefone.
• Nunca exponha tokens de autenticação ou senhas de qualquer tipo.
• O parceiro deve fornecer os seus dados de suporte para que os estabelecimentos comerciais (lojistas) entrem em contato no caso de problemas e/ou dúvidas.

Rate Limiting

• As solicitações da Automação Comercial ou PDV devem ser escalonadas o máximo possível para evitar rajadas de alto volume de tráfego.
• “Cache” seus próprios dados quando você precisar armazenar valores especializados ou revisar rapidamente conjuntos de dados muito grandes.
• Não crie multi-thread com chamadas POST, pois esse comportamento pode criar atrasos sistêmicos devido a deadlocks.
• Minimize o uso de dados. Os estabelecimentos comerciais (lojistas) podem estar utilizando conexão com dados móveis limitados.

Código de Qualidade

Seu aplicativo deve estar em conformidade com as práticas de programação Java e Android convencionais de acordo com as diretrizes para desenvolvedores do Android.

• Princípios de Design Orientado a Objetos (S.O.L.I.D.).
• Diretrizes de estilo Java.
• Entenda a diferença entre compileSdkVersion, targetSdkVersion, e minSdkVersion.
• Aproveite os botões nativos do Android, como os botões “Voltar” e “Início”.
• Otimize as operações visando o baixo consumo da bateria.
• O aplicativo deve atender às necessidades dos estabelecimentos comerciais (lojistas) da Cielo.
• Seu aplicativo deve ter uma boa experiência de ponta a ponta, garantindo a comunicação correta entre todos os fluxos, principalmente os retornos de pagamento da Cielo LIO.

Recursos de imagem

• Os ícones devem estar em conformidade com o dimensionamento padrão do Android
• Seguir o Guideline do Android

Utilização e Usabilidade

• Recomendamos aos desenvolvedores que integrem algum tipo de utilitário de relatório de falhas em seus produtos Android. Isso ajudará você a manter a consciência operacional do seu produto. Sugerimos a utilização do Crashlytics
• Os desenvolvedores podem coletar métricas sobre o uso do seu aplicativo. Isso irá ajudá-los a construir melhores produtos e aumentar a conscientização a respeito de quaisquer questões impactantes.
• Garantir que o aplicativo funcione de forma otimizada, evitando que ocorram crash e demora na resposta por processamento da aplicação. Seu aplicativo será usado em condições de trabalho de ritmo rápido e dinâmico, portanto esforce-se para obter fluxos de trabalho claros, fáceis de usar e robustos, com o mínimo de passos possível.
• O design deve enfatizar clareza e acessibilidade – alto contraste, fontes legíveis, texto grande e entradas.
• Deixar claro os termos de aceite da aplicação e prover o suporte necessário ao usuário no que tange o serviço disponibilizado.
• Se você estiver adaptando um aplicativo desenvolvido para outra plataforma, verifique se ele só inclui recursos e botões relevantes para o usuário da Cielo LIO.
• Se o seu aplicativo incluir um componente voltado para o cliente, seu projeto refletirá sobre o negócio usando seu aplicativo. Essas interfaces devem ser agradáveis e profissionais.
• Recomenda-se a utilização do Material Design para desenvolvimento das aplicações para a Cielo LIO. Esta recomendação tem como objetivo facilitar o uso de boas práticas de design para o desenvolvimento de aplicações móveis.
• Seu aplicativo será usado em condições de trabalho de ritmo rápido e dinâmico. Esforce-se para obter fluxos de trabalho claros, fáceis de usar e robustos, com o mínimo de passos possível.

Desenvolva seu aplicativo para Cielo LIO

Introdução

Com a Cielo LIO é possível que empresas e parceiros tenham seu aplicativo rodando na plataforma da Cielo. Esses aplicativos podem ou não estar integrados com o pagamento, tudo vai depender da finalidade da empresa ou parceiro.

Abaixo, você encontra todas as informações necessárias para desenvolver um aplicativo para a Cielo LIO.

Ambiente de Desenvolvimento

A Cielo recomenda que seja utilizada a IDE do Android Studio (versão 2.2.2 ou superior), visando garantir o funcionamento do aplicativo na plataforma Cielo LIO.

Para mais detalhes sobre a instalação e configuração do Android Studio, clique aqui

Para a criação de um novo projeto no Android Studio, clique aqui

Linguagem de Programação

A Cielo LIO aceita aplicativos desenvolvidos em Java ou Kotlin, como linguagens oficiais. As demais linguagens são permitidas, porém é de responsabilidade do desenvolvedor.

Recomendamos que essas linguagens sejam utilizadas para garantir o funcionamento e facilidade de integração com a Cielo LIO.

Cielo OS

O sistema operacional da plataforma Cielo LIO foi personalizado e, com isso, surgiu o Cielo OS, que é baseado em Android.

Versão target da aplicação

Recomenda-se que o desenvolvedor utilize as versões de sdk mínima 24 e target 29, para garantir compatibilidade com os modelos e versões do Android da LIO. Se o target estiver menor do que a versão 29, não estará apto para ser distribuído para os nossos terminais.

Para que o seu aplicativo funcione corretamente em todos os terminais, deve-se garantir que o aplicativo esteja de acordo com as definições de uso do Android 10 (Ex: permissões, notificações, uso de serviço em foreground).

Bloqueando pagamento fora do Aplicativo

Você poderá configurar seu App na Cielo LIO como um aplicativo padrão, ou seja, você pode deixar o pagamento disponível apenas para o seu aplicativo, bloqueando pagamentos via interface da Cielo LIO. Para isso você deve abrir um ticket no portal do desenvolvedor informando o package name do aplicativo e solicitando que o mesmo seja definido como frente de caixa.

Após a aprovado/certificado, o App estará disponível para ser selecionado com App Padrão de venda e com isso você consegue deixar o pagamento disponível apenas pelo seu aplicativo

Intent para receber o valor da venda

A Intent informada ao submeter o App, deve ser a tela inicial de venda do seu App.

O parâmetro de valor citado no item anterior, serve para receber o valor da venda, caso o usuário inicie uma transação usando o App padrão da Cielo, ao invés de usar o App Padrão selecionado.

Esse valor é passado no formato de centavos, sem separação dos decimais. Por exemplo, o valor 152,25 é passado como 15225, ficando por conta do App fazer o tratamento e formatação.

Essa Intent será chamada em dois momentos:

• Quando o seu app estiver marcado como padrão, e o snap do Pinpad for conectado.

• Quando o seu app estiver marcado como padrão, e uma transação for iniciada usando o App Cielo Vender (App padrão vendas da Cielo). Neste cenário o valor digitado no App Cielo Vender será passado como Intent Extra para o seu App.

Caso possua algúma dúvida na configuração desse recurso, você pode abrir um ticket em nosso suporte: Clique aqui

Recursos Indisponíveis

Ao personalizar o Android da Cielo LIO, foram removidos alguns recursos para garantir o desempenho e a segurança da plataforma.

Seguem abaixo os recursos removidos da Cielo LIO:

Google Play Services: Todos os serviços, APIs e apps do Google foram removidos do sistema operacional. Consequentemente, não será possível utilizar as bibliotecas que dependem desses recursos do Google.

Componente Webview: Este recurso visual foi removido com o objetivo de garantir a segurança na plataforma e evitar que, a partir dos aplicativos instalados na Cielo LIO, seja possível acessar links e conteúdos externos.

Atenção: A Cielo não permite que o aplicativo do cliente/parceiro seja desenvolvido utilizando o recurso WebView. Esse recurso visual deixa a plataforma da Cielo LIO vulnerável. Caso a aplicação esteja utilizando o WebView, esta não atenderá aos parâmetros de certificação e não será disponibilizada na Cielo Store.

Sugestões de substitutos

Push-Notifications

Recurso exclusivo do Google Services, portanto não está presente na Cielo LIO.

Alternativa: JobScheduler

Descrição: É uma API para agendar vários tipos de trabalhos contra a estrutura que será executada no próprio processo da sua aplicação. Permitindo a cada ciclo de tempo que o aplicativo realize uma busca em nossos serviços de Backend.

O JobScheduler é o mais indicado devido a performance em relação ao uso de bateria, fora as muitas outras opções que ele disponibiliza (Ex: Job rodar somente quando o smartphone estiver carregando).

Referência: Clique aqui

Serviços de Localização (GPS)

Recurso exclusivo do Google Services, portanto não está presente na Cielo LIO.

Alternativa: Location Manager

Descrição: Essa classe fornece acesso aos serviços de localização do sistema. Esses serviços permitem que os aplicativos obtenham atualizações periódicas da localização geográfica do dispositivo ou que iniciem uma Intenção especificada pela aplicação quando o dispositivo entra na proximidade de uma determinada localização geográfica.

Referência: Clique aqui

Serviços de Mapas

Recurso exclusivo do Google Services, portanto não está presente na Cielo LIO.

Alternativa: MapBox

Descrição: Uma plataforma de mapeamento de código aberto para mapas personalizados. Nossas APIs e SDKs são os blocos de construção para integrar a localização em qualquer aplicativo móvel ou web.

Referência: Clique aqui

APKs Removidas do Cielo OS

Abaixo, segue uma tabela com todas as APKs que foram removidas do Cielo OS e que, consequentemente, não estão disponíveis para a Cielo LIO:

Cielo Store Dev Console

Sobre a plataforma

A plataforma conhecida como Dev Console, é o ambiente exclusivo para o desenvolvedor realizar o upload e gestão dos aplicativos desenvolvidos para as maquininhas Cielo.

No Dev Console você consegue visualizar todos os seus aplicativos publicados sejam eles aplicativos privados ou públicos, realizar a gestão e distribuição dos aplicativos.

Todo aplicativo passa pela certificação de um time especializado antes de ser disponibilizado na Cielo Store (loja pública) ou distribuído para os estabelecimentos comerciais associados (loja privada).

Clique aqui para fazer seu cadastro no Dev Console.

Após cadastrar sua conta e fazer o login, exibirá um tutorial com os primeiros passos para integração do seu aplicativo. Esse tutorial irá te ajudar ao longo da sua jornada e está disponível para consulta a qualquer momento através do ícone (ajuda).

Solicitação de máquina e credenciamento

Para solicitar uma LIO, acesse o Portal de Desenvolvedores > Suporte > Cielo LIO > Envie sua pergunta > Solicitação LIO DEV / Credenciamento EC Cielo. Nessa mesma solicitação, será realizado o credenciamento EC Cielo. Esse credenciamento é necessário para: a solicitação da LIO; a publicação e distribuição do aplicativo em produção; e o recebimento de pagamentos referente aos aplicativos publicados em loja pública.

Loja Pública

Os aplicativos públicos ficam disponíveis na Cielo Store para download. Todos os clientes que utilizam a Cielo Store podem instalar o aplicativo.

Upload de novos aplicativos públicos

Para realizar o upload de um novo aplicativo público, siga os passos abaixo:

• Acesse a plataforma Dev Console;
• No topo superior direito, clique em “+ Aplicativo”;
• Para fazer o upload em loja pública, clique no botão “Subir na Cielo Store”, onde apresenta uma descrição sobre a loja:

• Após a seleção, será exibido o modal: “Organize estas informações”, clique em “Continuar” e realize o upload do arquivo do aplicativo com o formato .apk com o tamanho de até 200MB. ATENÇÃO: Após o upload do arquivo não é possível trocar de loja pública para privada.

Preenchendo os formulários

Para o aplicativo seguir para etapa de Certificação, é necessário o preenchimento dos formulários. Assim que realizar o upload do arquivo do aplicativo, você será direcionado para o primeiro formulário. Caso não queira iniciar o preenchimento neste momento, basta clicar na seta “Voltar”.

Quando quiser retomar o preenchimento dos formulários, acesse a home Meus aplicativos, na aba Apps públicos, clique em “Ver detalhes” do aplicativo, e entre na aba Dados do App.

No formulário Sobre o aplicativo estão as informações que irá compor a vitrine do seu aplicativo na Cielo Store.

No formulário Modelo de Cobrança, você escolhe a modalidade de cobrança do seu aplicativo, o nome do plano e a descrição, são 3 tipos de modalidade:

• Gratuito: não é cobrado nenhum valor.
• Fixo: valor cobrado uma única vez, sendo gratuito por um mês na primeira compra.
• Mensal: valor cobrado mensalmente, sendo gratuito por um mês na primeira compra.

No formulário Suporte, você informa os canais de comunicação que o cliente pode entrar em contato, e o termo de uso do seu aplicativo que deve ser disponibilizado.

No formulário Certificação, você informa os dados para o time especializado da Cielo realizar os testes do aplicativo, garantindo que o app esteja de acordo com as regras e critérios estabelecidos pela Cielo. Após o aplicativo ser aprovado e promovido para produção, o app ficará disponível na Cielo Store.

Nova versão de aplicativos públicos

Caso realize alguma alteração ou atualização no aplicativo público, você deverá fazer o upload de uma nova versão do aplicativo e utilizar a mesma assinatura da versão anterior. Para isso, acesse a home Meus aplicativos, na aba Apps públicos, clique em “Ver detalhes” do aplicativo e depois no botão “+ Nova versão” para fazer o upload de uma nova versão. É obrigatório:

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

Critérios de certificação de aplicativos da loja pública

O objetivo da certificação de aplicativos é garantir que todos os aplicativos presentes nas maquininhas Cielo sejam públicos ou privados, estejam de acordo com as regras e critérios estabelecidos pela Cielo.

Critérios para aprovação da certificação de aplicativo público:

• Realizar testes em desenvolvimento antes de nos encaminhar a versão. Veja como baixar o Emulador.
• O cadastro do aplicativo deve ser de fácil acesso para o cliente.
• Não pode ter um sistema ERP conectado.
• Preencher os termos de uso corretamente, mostrando as normas do serviço que está sendo oferecido.
• Preencher corretamente todos os formulários: Sobre o aplicativo, Modelo de Cobrança, Suporte e Certificação.
• O vídeo que irá compor a vitrine do seu aplicativo na Cielo Store, deve ser com a URL do YouTube, e de visibilidade “Público” ou “Não listado”, não é permitido vídeo privado.
• A versão que será certificada deve maior do que a versão anterior. Exemplo: versão anterior 1.0 e a versão atual 1.1.
• Caso o aplicativo tenha webview, não ficar disponível a URL para a troca de URL dentro do aplicativo. A URL não deverá aparecer.
• Garantir que o fluxo de pagamento funcione corretamente.
• Gerar valores para teste até R$ 0,05 centavos.
• IMPORTANTE: Qualquer valor transacionado maior do que R$ 0,05 devem ser cancelados para que não haja efetivação da transação.
• 100% das transações dever ser via Cielo.
• Deve ficar disponível para todos Clientes da Cielo Store.
• Imagem, ícones e screenshot devem estar formato correto e elegível
• Manter seu app sempre nas versões mais atuais do SDK. Confira as versões atuais através do Portal do Dev na área logada.

O que o app não pode ter?

• Não conter palavras Cielo ou Lio.
• Não conter palavrão.
• Não exibir de imagens inapropriadas.
• Não exibir imagens ou nomes de concorrentes.
• Não conter sistema ERP conectado.
• Não conter acesso restrito e personalizado para um cliente.
• Não usar o logo da Cielo.

ATENÇÃO: Qualquer informação necessária que esteja faltando, resultará na reprovação automática do aplicativo. O SLA de certificação são de 48h úteis.

Após o aplicativo ser certificado. Quais são os próximos passos?

• O desenvolvedor deverá promover seu aplicativo para produção, acesse a home Meus aplicativos, na aba Apps públicos, clique em “Ver detalhes” do aplicativo, depois dentro da aba Versões clique no botão “Enviar para produção”.
• Após enviado para produção, o aplicativo será disponibilizado na vitrine da Cielo Store para os clientes realizarem a compra (download) do aplicativo.

IMPORTANTE: Somente aplicativos de loja pública são disponibilizados na Cielo Store.

Compra de Aplicativo Públicos na Cielo LIO

Todos os aplicativos públicos certificados e promovidos para produção pelo desenvolvedor, ficam disponíveis no marketplace Cielo Store dentro das maquininhas Cielo.

Os estabelecimentos comerciais (lojistas) que desejam adquirir o aplicativo, precisam clicar no botão “Instalar” ou “Comprar” para baixar aplicativo escolhido na Cielo Store, em seguida, é necessário digitar as credenciais utilizadas no site Cielo para autenticação e débito do valor do aplicativo. Após a conclusão da compra, o app estará disponível para ser utilizado nas maquininhas Cielo.

A desinstalação do app deverá ser realizada também através da Cielo Store, e após a desinstalação será realizado o cancelamento da cobrança, caso o aplicativo seja pago e tiver ultrapassado o mês de gratuidade.

IMPORTANTE: Todos os aplicativos são gratuitos por um mês na primeira compra.

Download de aplicativo públicos nas maquininhas Cielo

Para realizar o download de aplicativos públicos na Cielo LIO, clique na aba Apps, entre no app Cielo Store e escolha o aplicativo que deseja, clique no botão “Instalar” ou “Comprar” para baixar aplicativo escolhido.

Para consultar os pagamentos referente aos aplicativos publicados em loja pública (Cielo Store), crie uma conta no site Cielo. Para fazer o cadastro, clique em “Acessar minha conta”, depois em “Primeiro acesso” e informe os dados requisitados.

Importante: É necessário realizar o credenciamento EC Cielo antes de criar o cadastro no site Cielo. Veja o passo a passo na seção Solicitação de máquina e credenciamento deste manual.

Loja Privada

Os aplicativos privados são indicados para desenvolvedores que querem permitir a distribuição de soluções personalizadas para um cliente específico e de acesso restrito. Pode ter um sistema ERP (Sistema de Gestão Empresarial) conectado.

Se você optou pela loja privada, é necessário criar uma loja para o envio do app. Para isso, acesse a plataforma Dev Console, clique em Lojas privadas, depois no botão + Criar loja privada, digite o nome da loja e clique em Concluir.

Sem loja criada:

Com loja criada:

Com a loja privada criada, você poderá publicar seu aplicativo no Dev Console selecionando sua loja, esta ação é essencial para realizar a distribuição de aplicativos privados.

Upload de novos Aplicativos Privados

Para realizar o upload de um novo aplicativo privado, siga os passos a seguir:

• Acesse a plataforma Dev Console;
• No topo superior direito, clique em “+ Aplicativo”;
• Para fazer o upload em loja privada, clique no botão “Subir na Loja Privada”, onde apresenta uma descrição sobre a loja:

• Após a seleção, será exibido um modal: “Organize estas informações”, clique em “Continuar” e selecione a loja privada, também é possível criar a loja privada no Clique aqui abaixo do select. Basta digitar o nome da loja e clicar em Concluir.

• Depois realize o upload do arquivo do aplicativo com o formato .apk com o tamanho de até 200MB. ATENÇÃO: Após o upload do arquivo não é possível trocar de loja privada para pública.

Preenchendo os formulários

Assim como na loja pública, para o aplicativo privado seguir para etapa de Certificação, é necessário o preenchimento dos formulários. Ao realizar o upload do arquivo do aplicativo, você será direcionado para o primeiro formulário. Caso não queira iniciar o preenchimento neste momento, basta clicar na seta “Voltar”.

Quando quiser retomar o preenchimento dos formulários, acesse a home Meus aplicativos, na aba Apps privados, clique em “Ver detalhes” do aplicativo, e entre na aba Dados do App.

No formulário Sobre o aplicativo estão as informações que serão exibidas no Portal do Desenvolvedor.

No formulário Suporte, você informa os canais de comunicação que o cliente pode entrar em contato, e dá o aceite referente a negociação dos valores. IMPORTANTE: O recebimento dos valores do aplicativo privado é negociado entre parceiro e cliente.

No formulário Certificação, você informa os dados para o time especializado da Cielo realizar os testes do aplicativo, garantindo que o app esteja de acordo com as regras e critérios estabelecidos pela Cielo. Após o aplicativo ser aprovado e promovido para produção, o app ficará disponível para todos os clientes associados à loja privada selecionada.

Nova versão de 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. Para isso, acesse a home Meus aplicativos, na aba Apps privados, clique em “Ver detalhes” do aplicativo e depois clique no botão “+ Nova versão” para fazer o upload de uma nova versão. É obrigatório:

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

Lembre-se, após o vínculo do aplicativo, não é possível alterar a loja.

IMPORTANTE: Somente aplicativos de loja pública são disponibilizados na Cielo Store. Aplicativos privados são distribuídos pelo desenvolvedor aos estabelecimentos específicos.

Critérios de certificação de aplicativos da loja privada

O objetivo da certificação de aplicativos é garantir que todos os aplicativos presentes nas maquininhas Cielo sejam públicos ou privados, estejam de acordo com as regras e critérios estabelecidos pela Cielo.

Critérios para aprovação da certificação de aplicativo privado:

• Realizar testes em desenvolvimento antes de nos encaminhar a versão para atualização. Veja como baixar o Emulador

• A solução pode ser customizada para cliente específico.
• Acesso restrito e personalizado a um cliente.
• Pode ter um sistema ERP conectado.
• Preencher corretamente todos os formulários: Sobre o aplicativo, Suporte e Certificação.
• Caso o app tenha login, preencher os dados de acesso no formulário Certificação.
• A versão a ser certificada deve ser maior do que a versão anterior. Exemplo: versão anterior 1.0 e a versão atual 1.1.
• Caso o app tenha webview, não ficar disponível a URL para a troca de URL dentro do app. A URL não deverá aparecer.
• Caso o app rode em um servidor local, enviar um vídeo mostrando o fluxo do app. Os vídeos deverão ser atualizados conforme o envio de uma nova versão para certificação. Após gravar o vídeo do app, mostrar a versão e data do vídeo. Todo vídeo deve ser com a URL do YouTube, e de visibilidade “Público” ou “Não listado”, não é permitido vídeo privado.
• Garantir que o fluxo de pagamento funcione corretamente.
• Gerar valores para teste até R$ 0,05 centavos.
• IMPORTANTE: Qualquer valor transacionado maior do que R$ 0,05 devem ser cancelados para que não haja efetivação da transação.
• 100% das transações dever ser via Cielo.
• Manter seu app sempre nas versões mais atuais do SDK. Confira as versões atuais através do Portal do Dev na área logada.
• Garantir que o aplicativo seja seguro para todos os públicos.

O que o app não pode ter?

• Não conter palavras Cielo ou Lio.
• Não conter palavrão.
• Não exibir de imagens inapropriadas.
• Não exibir imagens ou nomes de concorrentes.
• Não usar o logo da Cielo.

ATENÇÃO: Qualquer informação necessária que esteja faltando, resultará na reprovação automática do aplicativo. O SLA de certificação são de 48h úteis.

Distribuição de Aplicativos na loja privada

Caso opte por desenvolver aplicativos privados e distribuir apenas para clientes específicos, você deve associar o EC do cliente a sua loja privada através do Dev Console. Somente o desenvolvedor que realizou a publicação do aplicativo poderá gerenciar a distribuição dos aplicativos da loja aos ECs do cliente.

Para associar o EC a uma loja:

Acesse no menu Lojas Privadas, clique em Todas as lojas, selecione a loja que deseja associar os ECs, em seguida clique no botão “+ Associar ECs”, e digite todos os ECs que serão associados àquela loja, depois clique no botão “Concluir” para finalizar.

Download de Aplicativo da loja privada na LIO

Existe uma rotina automática que ocorre a cada 1 hora no terminal e verifica todos os apps que precisam ser disponibilizados ou atualizados em cada terminal. Caso o download não seja imediato, observar e orientar o cliente das seguintes situações:

1.A Cielo LIO deverá estar com a bateria acima de 50% e conectada a internet seja WI-FI ou 3G para realizar o download. 2.Com os critérios acima, siga o passo a passo para forçar a atualização:

• Clique na aba “Ajuda” > “Minha LIO”, depois em “Buscar atualizações”.

Status de um aplicativo

Todos os aplicativos publicados no Dev Console possuem os seguintes status:

1 - Assinatura

Após realizar o upload de um novo aplicativo ou nova versão, o aplicativo 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.

2 - Desenvolvimento

Após ser assinado, o aplicativo fica automaticamente com o status “Em desenvolvimento”. Nesse estágio o desenvolvedor consegue realizar testes do seu aplicativo nas maquininhas Cielo, e caso precise fazer alguma correção, basta publicar uma nova versão do aplicativo pelo Dev Console e atualizar na maquininha.

Se não tiver LIO durante o desenvolvimento, solicite uma LIO para Desenvolvedores, veja o passo a passo na seção Solicitação de máquina e credenciamento deste manual.

Para testar um aplicativo nas maquininhas Cielo, acesse no Dev Console a home Meus aplicativos, clique em “Ver detalhes” do aplicativo, depois em “Testar app”, escolha o tipo de maquininha que o QR Code será gerado.

Neste momento, basta abrir o aplicativo Test Your App na maquininha e escanear o QR Code. Após a leitura do QR Code, o download do app será realizado.

IMPORTANTE: Para a instalação de um app nas maquininhas Cielo, o terminal deverá estar com a bateria acima de 50% ou conectado no cabo de energia, e com internet WI-FI ou 3G.

3 - Certificação

Concluído os testes, você pode enviar o aplicativo para certificação. Nessa etapa o time especializado da Cielo entra em ação para validar o funcionamento do aplicativo de acordo com a seção Critérios de certificação de aplicativos da loja pública e Critérios de certificação de aplicativos da loja privada deste manual.

Após o envio para certificação, o aplicativo fica automaticamente com o status “Aguardando certificação”. A certificação pode levar 48h úteis. Fique atento, você será avisado por e-mail quando a certificação for concluída.

4 - Produção

Assim que o aplicativo for aprovado na certificação, o desenvolvedor poderá promover para produção. Para isso, é necessário clicar no botão “Enviar para produção”, se for:

• Aplicativo público: fica disponível para download na Cielo Store. A instalação é manual, será realizada pelo cliente.
• Aplicativo privado: fica disponível para os clientes associados à loja privada. Sua instalação pode ser manual ou automática. A manual será realizada pelo cliente, por meio da maquininha no menu Ajuda > Minha LIO > Buscar atualizações. O app estará disponível somente na maquininha atualizada. Já a instalação automática, será realizada sem ação do cliente. O aplicativo será disponibilizado automaticamente para todos os ECs associados.

Mensagens de Erro Dev Console

Segue os possíveis erros que o desenvolvedor pode encontrar durante a utilização do Dev Console:

Caso você desenvolvedor não encontre o erro nesta tabela, abra um ticket para a equipe de suporte reportando o problema encontrado e lembre-se de listar as evidências do erro como prints de tela e mensagens de erro recebidas.

Ambiente Sandbox – Emulador

Oferecemos um aplicativo para facilitar a validação da sua integração com a LIO On

Esta solução elimina a necessidade de um hardware físico da LIO On em modo debug, que não é fornecido pela Cielo por razões de segurança.

O aplicativo processa as solicitações e simula as respostas para o software de integração, permitindo que os desenvolvedores realizem testes integrados e depurem suas aplicações durante o desenvolvimento, sem a necessidade de possuir uma Cielo LIO On.

É necessário a instalação do nosso aplicativo que simula a Cielo LIO em um dispositivo Android ou AVD, especificamente na API de nível 25, Android 7.1, que é a mesma versão do Android utilizada nos terminais LIO ON.

Como faço para validar minha solução a partir do aplicativo que simula a LIO?

Primeiro baixe e instale o aplicativo, download aqui no link

Caso tenha dificuldade com a instalação:

1. Acesse as configurações do seu aparelho e vá até o menu “Segurança”;
2. Localize o item “Fontes desconhecidas”, na seção “Administração do dispositivo”
3. Toque na chave ao lado e confirme sua escolha para passar a permitir a instalação de arquivos APK baixados por fontes alternativas.

Depois de instalado, inicie o aplicativo, será aberta a tela de boas-vindas, nesta tela temos uma mensagem e um botão para limpar os dados (esta opção limpa os pedidos criados pelo integrador). Se achar necessário, pode minimizar o aplicativo, esta ação não muda sua experiência.

O próximo passo é instalar o aplicativo de integração, para fins didático sutilizamos nosso aplicativo Sample, disponibilizado no github da Cielo. Na imagem abaixo temos o seguinte cenário: Pedido criado, item adicionado, pedidoliberado para pagamento (os passos descritos utilizam da integração com emulador).

Ao clicar no botão pagar, o emulador vem para foreground e exibe os dados do pagamento, dando sequência, temos uma tela com as opções de resposta para o integrador, imagens abaixo:

Sucesso: Retorna os dados do pagamento simulando uma operação realizada com sucesso na Lio On.

Cancelado: Aborta a operação de pagamento.

Erro: Retorna um erro genérico de falha na operação de pagamento.

Ao selecionar uma das opções de resposta, retornamos o resultado para o sistema integrado e movemos nossa aplicação para o background. Além da operação de pagamento, oferecemos suporte a uma variedade de funcionalidades, incluindo o cancelamento de um pedido, a consulta de produtos disponíveis para pagamento (como Crédito, Débito, Pix, entre outros) e a consulta de pedidos criados, seja de forma individual ou em lista.

LIO para Desenvolvedores

Os desenvolvedores que desejam obter uma Cielo LIO, deverão seguir os passos abaixo:

• Criar uma conta no Portal dos Desenvolvedores;
• Fazer a solicitação do equipamento dentro da aba Suporte > Cielo LIO > Envie sua pergunta > Solicitação de LIO Dev / Credenciamento EC Cielo;
• Aguardar o recebimento da Cielo LIO;
• Em posse do equipamento, o desenvolvedor deve abrir uma nova solicitação no portal dos desenvolvedores para requisitar a habilitação de sua LIO de Dev.

Com a LIO irá conseguir fazer testes e mexer em seu app em tempo real. A LIO de DEV é isenta de cobrança de aluguel.

Obs: Todos os aplicativos publicados pelo desenvolvedor no Dev Console que estejam com status diferente de bloqueado poderão ser baixados em sua LIO de Dev.

Clique Aqui para solicitar sua LIO.

Integração via Deeplink

A Cielo oferece integração via intents para comunicação por meio de deep links, permitindo que aplicativos Android se integrem a recursos como pagamento, impressão e cancelamento

Credenciais

Você pode solicitar as credenciais (client-id/access-token) diretamente via PORTAL DE DESENVOLVEDORES.

Pagamento

É necessário definir um contrato de resposta com a LIO para que a mesma possa responder após o fluxo de pagamento/cancelamento/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 “response” e “order” podem ser substituídos pelo que fizer sentido no seu aplicativo. Lembrando que na hora de fazer a chamada de pagamento, você deve informar os mesmos nomes para receber o callback da LIO. Para realizar o pedido de pagamento é preciso criar um json seguindo o formato definido abaixo e converte-lo para BASE64:

{
  "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"
}

Lista de paymentCode

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

Como explicado anteriormente, é preciso definir o contrato de resposta (host e scheme), aqui será utilizado 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 de pagamento basta acessar a intent na activity de resposta 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)
}

Lembrando que o parâmetro “response” é o mesmo que foi configurado como resposta na chamada de pagamento.

Com o pagamento finalizado a LIO retornará para a uri configurada inicialmente um JSON 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"
}

Atenção: O campo statusCode=0(apenas pagamentos pix) ou 1 indica uma transação de pagamento e statusCode=2 Cancelamento

Exemplos de retorno

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 usuario ou 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 Lio 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”
}

ATENÇÃO: Á princípio será limitado a no máximo 5 pedidos devido ao tamanho das informações.

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 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 da Listagem de Pedidos

Exemplo de 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

ResponseCode = 0 significa sucesso e após realizar a decodificação será obtido um objeto JSON:

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

O results estará uma lista com os pedidos.

Exemplo de Retorno de falha:

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"
            }
        ]
    }
]

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. Ou pode consultar 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 e 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 das informações do terminal

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

Depois de decodificar o resultado:

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

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 cancelamento

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

Atenção: 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, suportamos no momento os cartões Mifare 1k. Para utilizar o serviço no aplicativo de integração podemos começar 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.

Descrição dos parâmetros utilizados nas operações de leitura e escrita passados via intent

Operações suportadas pelo serviço 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)

Obs: Lembrando que o parâmetro cbType é customizável, não necessariamente o integrador precisa tratar a resposta via broadcast, fica 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

Segue abaixo, alguns 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"]
}

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"
  ]
}

Code Sample

Disponiblizamos 2 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

Integração Remota

Apresentação

O objetivo da Integração Remota da Cielo LIO é permitir que o lojista continue utilizando sua solução de frente de caixa (Automação Comercial ou PDV) e a integre com o módulo de pedidos e pagamentos da Cielo LIO através de uma API construída no padrão RESTful.

Dessa forma, toda a gestão do estabelecimento comercial fica sob responsabilidade da Automação Comercial e, no momento de realizar o pagamento, a Cielo LIO é utilizada.

A API Order Manager da Cielo LIO possui as seguintes características:

• Recursos REST, de forma que seja possível acessar por meio de semântica HTTP padrão.
• Códigos de status HTTP para comunicar o sucesso/erro nas chamadas.
• Todas as requisições e respostas encontram-se no formato JSON.
• As seções abaixo possuem todas as informações necessárias para realizar a integração de forma rápida e segura.

Code Sample

O código do exemplo da Automação Comercial integrada com a API Order Manager da Cielo LIO encontra-se disponível no GitHub.

Fluxo para Integração

API Docs

Nessa documentação, o desenvolvedor 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 LIO.

Endpoints

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

Sandbox

O ambiente de sandbox é destinado à realização de testes com parceiros da Cielo. Esse ambiente usa simuladores de integração. Assim, as operações não são executadas em ambiente produtivo.

Para utilizar o ambiente de sandbox, não é necessário que você forneça o número do estabelecimento. Você poderá iniciar os testes sem a necessidade de ter uma Cielo LIO. Para obter os tokens de sandbox, crie uma conta no portal e crie o Client-Id.

Utilize o endereço de sandbox abaixo para realizar os testes:

https://api.cielo.com.br/sandbox-lio/order-management/v1

Produção

O ambiente de produção é o ambiente transacional integrado ao ambiente da Cielo. As operações realizadas nesse ambiente não podem ser desfeitas.

Para utilizar o ambiente de produção, é necessário que você entre em contato através do formulário. Juntamente com os dados pessoais, forneça o número do estabelecimento. Para utilizar o ambiente de produção, é necessário que você possua uma Cielo LIO.

Utilize o endereço de produção abaixo para realizar as requisições:

https://api.cielo.com.br/order-management/v1

Já fez os testes em sandbox e deseja solicitar os tokens?

Clique em Solicitar Tokens

É necessário estar logado!

HTTP Headers

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

Client-Id: Identificação de acesso. Sua geração ocorre no momento da criação pelo painel do desenvolvedor. Seu valor pode ser visualizado na coluna “Client ID”, dentro do menu “Desenvolvedor” -> “Client ID Cadastrados”.

Access-Token:Identificação do token de acesso, que armazena as regras de acesso permitidas ao Client ID. Sua geração ocorre no momento da criação do Client ID pelo painel do desenvolvedor. Seu valor pode ser visualizado clicando em “detalhes” na coluna “Access Tokens”, dentro do menu “Desenvolvedor” -> “Client ID Cadastrados”.

Merchant-Id: Token que identifica o estabelecimento comercial dentro do servidor Order Manager da Cielo LIO. Sua geração ocorre durante o processo de cadastro do Client ID. Seu valor pode ser visualizado na coluna “Merchant ID”, dentro do menu “Desenvolvedor” -> “Client ID Cadastrados”.

HTTP Status Code

Status de pedido

Abaixo é apresentada uma máquina de estados, com os possíveis estados que um pedido pode assumir desde o momento de sua criação até o seu término:

Entidades

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"
}

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/

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/?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/

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//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//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//items/

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//items/

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//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//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//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 Cielo LIO

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.

PASSO 1: Entrar no site Cielo com seu login e senha

PASSO 2: Clicar em “Meu cadastro”

PASSO 3: Clicar em “Autorizações”

PASSO 4: Clicar em “PIX

PASSO 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.

FAQ

Integrações

Integração Local

Essa é a integração de APP embarcado na LIO, utilizando os seus recursos: Pagamento, impressão e cancelamento. O seu Aplicativo instalado na LIO, se integra com o módulo de pedidos e pagamentos da Cielo LIO através do Cielo LIO Order Manager SDK.

É possível desenvolver utilizando Java e Kotlin e se integrar a nossa SDK e também utilizando linguagens hibridas com Deep Link, segue abaixo as respectivas documentações:

Documentação Integração Local Nativa.

Existe algum aplicativo de exemplo disponível?

Disponibilizamos no GitHub um aplicativo Sample de forma que o desenvolvedor consiga ver como funciona as chamadas para utilização do SDK. 

Download do aplicativo Sample.

É necessário colocar todos os itens do pedido na order?

A Cielo LIO funciona com o conceito de Pedido (Order). Assim, o procedimento deve ser sempre o exemplificado no SDK:

• Criar uma ordem com status draft;
• Adicionar itens à ordem;
• Preparar a ordem para pagamento (place order);
• Executar o checkout.

Se você tem uma variedade de produtos, é interessante criar itens separados para status de relatório na Cielo LIO do lojista.

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.   Documentação Integração Remota.

Preciso me cadastrar para realizar testes?

Sim, é fundamental o cadastro no portal para que você possa obter os tokens de acesso e testar as suas aplicações.

Integração Híbrida

O processo de integração híbrida é um pouco diferente da integração com o SDK (Integração Local). Para parceiros que não estão integrando com a linguagem nativa Java ou Kotlin a integração hibrida via deep link é uma opção.

Documentação Integração Hibrida.

O que eu preciso para colocar a integração em produção?

Se você já realizou todos os testes em Sandbox e deseja enviar pedidos para a Cielo LIO, entre em contato  conosco por meio de um ticket, preenchendo os dados necessários para receber os tokens de produção.

Acesse o link.

Também é necessário incluir a tag abaixo no arquivo AndroidManifest.xml do seu aplicativo para que seu aplicativo hibrido esteja disponível para todos os terminais:

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

Preciso de uma máquina Cielo LIO para realizar os testes de integração local?

Não é necessário ter uma máquina Cielo LIO para realizar os testes.

A Cielo disponibiliza um aplicativo que simula o ambiente da Cielo LIO em qualquer dispositivo Android, permitindo que o desenvolvedor realize os testes nos métodos do SDK e faça o debug da sua aplicação durante o desenvolvimento e a integração com o Cielo LIO Order Manager SDK, sem a necessidade de possuir um hardware da Cielo LIO.

Download do Emulador: aqui no link

Preciso me cadastrar para realizar testes?

Sim, é fundamental o cadastro no portal para que você possa obter os tokens de acesso e testar as suas aplicações.

PIX

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.

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.

Duvidas Gerais Cielo LIO

Como posso adquirir um equipamento LIO para desenvolvimento ?

Os desenvolvedores que desejam obter uma Cielo LIO, deverão seguir os passos abaixo:

• Criar uma conta no Portal dos Desenvolvedores e fazer a solicitação do equipamento através da abertura do ticket;
• Aguardar o recebimento da Cielo LIO;
• Em posse do equipamento, o desenvolvedor deve abrir uma nova solicitação no portal dos desenvolvedores para requisitar a habilitação de sua LIO de Dev.
• Todos os aplicativos publicados pelo desenvolvedor no Dev Console que estejam com status diferente de bloqueado poderão ser baixados em sua LIO de Dev.

Clique Aqui para solicitar sua LIO.

Se meu aplicativo já funciona na Cielo LIO v2, ele vai funcionar também na Cielo LIO On?

Sim, se você já tem um aplicativo rodando na Cielo LIO V2, ele também funcionará na Cielo LIO On.

Como faço para integrar com a Cielo LIO?

Construimos um portal dedicado aos desenvolvedores para facilitar a integração da sua solução com a Lio -> http://desenvolvedores.cielo.com.br Nesse portal você pode:

• Acessar documentação completa das APIs;
• Utilizar os SDK´s para tornar a integração mais ágil;
• Criar suas contas para receber as chaves (tokens) de acesso;
• Realizar os testes e desenvolvimentos para se integrarem com a Cielo: usando emulador ou sandbox.

Posso utilizar impressoras para conectar na Cielo LIO?

Sim. Impressoras com conexão via Bluetooth podem ser usadas pelo aplicativo do parceiro que está rodando na Cielo LIO para realizar a impressão de algum comprovante ou recibo necessário para a operação do negócio do parceiro/cliente.

Já existem parceiros que estão utilizando impressoras Bluetooth das marcas Zebra, Datex, Leopardo e outras para se integrar com a Cielo LIO! Todos os protocolos de comunicação e pareamento ficam sob responsabilidade do aplicativo do parceiro.

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

A Cielo LIO possui entrada para um SIM Card que permite realizar a comunicação via rede móvel 4G. Com fall-back para 3G e 2G e GPRS respectivamente. Além disso, ela possui como tecnologia de comunicação o Wi-Fi.

Quais são as conexões disponíveis na Cielo LIO?

As entradas USB da Cielo LIO são utilizadas única e exclusivamente para realizar o carregamento na bateria do aparelho. O Bluetooth da Cielo LIO pode ser utilizado para realizar a comunicação e a troca de informações com dispositivos externos.

Caso necessite trocar a máquina LIO, o catálogo cadastrado migra automaticamente para a nova máquina recebida?

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

Como faço para atualizar/baixar aplicativos na LIO?

A Cielo Lio precisa estar conectada a internet 4G ou WI-FI

Com sua LIO em mãos siga as orientações abaixo:

• Clique na aba “Ajuda”;
• Clique na opção “Minha LIO”;
• Clique na opção “Buscar Atualizações”.

Como faço para criar uma conta no site da Cielo?

Basta acessar o site Cielo http://www.cielo.com.br.

• No canto superior direito, clique em “Acessar minha conta”;
• Clique em “Cadastre-se”;
• Clique em “Criar cadastro” Informe os dados requisitados.

Minha LIO não está baixando um app

Verificar se sua LIO está com bateria acima de 50% e com 4G ou WI-FI. Se estiver com todos os requisitos citados acima e mesmo assim o app não baixou abra um chamado no portal dos desenvolvedores.

Dev Console - Cielo Store (Loja Publica) X Loja Privada

Fiz meu cadastro! O que devo fazer agora?

O desenvolvedor deverá escolher o tipo de Loja que deseja disponibilizar seu app.

Aplicativo de Loja Pública

Os aplicativos públicos são indicados para aqueles desenvolvedores e parceiros que desejam disponibilizar e escalar sua aplicação e permitir o download na Cielo LIO distribuídos nos estabelecimentos comerciais no Brasil via Vitrine da Cielo Store.

Aplicativo Privado na Loja Privada

Os aplicativos privados são indicados para desenvolvedores que querem permitir a distribuição de soluções personalizadas para um cliente específico. É necessário solicitar a criação da Loja Privada para então ser possível fazer o upload de um aplicativo de Loja Privada no Dev Console. A partir da Loja Privada criada, o desenvolvedor poderá publicar seu aplicativo no Dev Console selecionando sua loja, esta ação é essencial para realizar a distribuição de aplicativos privados. Clique aqui para solicitar a criação da Loja Privada.

Quais são os Browsers/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 faço para me cadastrar na Cielo?

É necessário a abertura de solicitação no Portal de Desenvolvedores > Suporte > Cielo Lio > Envie sua pergunta > Solicitação LIO DEV / Credenciamento EC Cielo.

Como posso liberar o meu aplicativo desenvolvido aos clientes Loja Privada?

Após o aplicativo passar pela etapa de certificação e ser aprovado pelo time especialista interno da Cielo, o próprio desenvolvedor será notificado e deverá promover o app para produção sendo assim todos os EC’s que tiverem associados a loja privada irão receber o aplicativo. Clique Aqui para solicitar a criação da Loja Privada e tirar suas dúvidas de como fazer a associação de um EC a uma loja privada.

Como posso liberar o meu aplicativo desenvolvido aos clientes Loja Publica?

Após o aplicativo passar pela etapa de certificação e ser aprovado pelo time especialista interno da Cielo, o próprio desenvolvedor será notificado e deverá promover o app para produção, sendo assim o mesmo ficará disponível na Loja Cielo Store para seus clientes.

Preciso ser cadastrado na Cielo para receber o pagamento dos aplicativos?

Sim, é necessário ter uma conta no site Cielo o pagamento é realizado em agenda financeira, precisa se cadastrar para ter um estabelecimento comercial (EC). Basta acessar o site Cielo http://www.cielo.com.br.

• No canto superior direito, clique em “Acessar minha conta;
• Clique em “Cadastre-se”;
• Clique em “Criar cadastro” Informe os dados requisitados.

O que eu preciso para colocar meu aplicativo em produção?

Se seu aplicativo já foi certificado, você deve promovê-lo em Produção no Dev Console. Dev Console > Selecionar App > Selecionar Versão Certificada > Clicar em “Enviar para Produção”.

Como recebo o pagamento dos aplicativos?

O pagamento será feito em agenda financeira. É necessário ter uma conta no site Cielo. Caso não tenha, acesse o site Cielo http://www.cielo.com.br.

• No canto superior direito, clique em “Acessar minha conta”;
• Clique em “Cadastre-se”;
• Clique em “Criar cadastro” Informe os dados requisitados.

Tenho algum custo para colocar meu aplicativo na Cielo Store?

Não! A integração com a Cielo LIO é gratuita.

O que é a Cielo Store (Loja Publica)?

Toda vez que você precisa acessar o app do Banco ou daquela loja preferida ou de entrega de comida, você acessa a loja de aplicativos (Play Store ou App Store) do seu celular e realiza o download desse app, certo?

O mesmo acontece com a Cielo LIO. Através da Cielo STORE, os estabelecimentos comerciais podem escolher entre os mais de 50 apps disponíveis o aplicativo que melhor atende suas necessidades, seja unificar sistemas, realizar gestão de vendas, time e estoque etc. em um único clique.

Quais as etapas existentes para publicar meu aplicativo?

1 - Etapa de desenvolvimento

Após passar pelo upload de um novo aplicativo ou nova versão, o aplicativo fica automaticamente com o status “Em Desenvolvimento”. Nesse estágio o desenvolvedor consegue realizar testes do seu aplicativo em uma Cielo LIO e caso precise fazer alguma correção, basta publicar uma nova versão do aplicativo pelo Dev Console e então atualizar na Cielo LIO.

2 - Etapa de Certificação

Uma vez concluído os testes, o desenvolvedor envia o aplicativo para Certificação. Nessa etapa o time de Certificação da Cielo entra em ação e irá validar o fluxo de funcionamento do aplicativo de acordo com a sessão Critérios de Certificação de Aplicativos deste documento.

3 - Etapa de Produção

Assim que o aplicativo for aprovado na certificação, o desenvolvedor poderá promover para produção.

Como faço para mudar o nome do meu aplicativo?

Não é possível alterar o nome de um aplicativo. Caso seja necessário, é preciso criar um novo aplicativo com package name diferente e seguir o processo normal de upload de aplicativo na Cielo Store.

É possível editar as informações do meu aplicativo já publicado na Cielo Store?

Sim, é possível. Basta alterar as informações dentro do formulário no Dev Console, submeter uma nova versão e encaminhá-la para Certificação. Após o APP ser certificado e aprovado, é necessário promover o APP para produção e sendo assim o APP fica atualizado e disponível na Cielo Store.

Como faço para baixar aplicativos na Cielo LIO?

Com sua LIO em mãos siga as orientações abaixo:

• Clique na aba “Ajuda”;
• Clique na opção “Minha LIO”;
• Clique na opção “Buscar Atualizações”.

Vale lembrar que sua LIO precisa está dentro dos requisitos bateria acima de 50% e com 4G ou WI-FI estável. A partir desse momento todos os aplicativos disponibilizados para essa LIO serão baixados e instalados na e ficarão visíveis na aba Apps.

Qual a diferença entre Loja Pública e Loja Privada?

Na Loja Pública, o aplicativo ficará disponível na Cielo Store para todos os clientes que possuem LIO. O cliente deverá escolher o aplicativo que deseja contratar e fazer o download. O modelo de Loja Privada a distribuição do aplicativo é feita pelo desenvolvedor. O aplicativo é instalado somente para o EC que está cadastrado em uma loja especifica. O aplicativo que está na Loja Privada não estará disponível na Loja Pública.

O que é a Loja Privada?

É uma solução desenvolvida para quem precisa de um sistema de gestão integrado personalizado. Integrando com a LIO ON você pode ter acesso a todas as informações em um lugar só, consegue fazer um gerenciamento de vendas, controle de estoque, fluxo de caixa, emissão de nota fiscal e muito mais. Para saber quais apps temos entre em contato conosco!

Como faço para cancelar a assinatura do aplicativo?

• Clique na opção Apps;
• Selecione Cielo Store;
• Escolha o aplicativo;
• Clique em desinstalar;
• Preencha com usuário e senha criados no site Cielo.

Como um aplicativo da loja pública é cobrado?

Os aplicativos são cobrados mensalmente diretamente na agenda financeira do EC que contratou o aplicativo.

Como faço para consultar minha comissão referente a aplicativos de Loja Publica?

Entre no Site Cielo com suas credenciais > 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.