Вы находитесь на странице: 1из 52

ESPECIFICAO TCNICA

CIELO MOBILE CHAMADA EXTERNA


Fevereiro de 2016

Fevereiro, 2015

VERSO DO DOCUMENTO ............................................................. 7


INTRODUO .................................................................................. 7
OBJETIVO......................................................................................... 7
CENRIO ......................................................................................... 7
FUNCIONAMENTO ........................................................................... 7
INTEGRAO ................................................................................... 8
MENSAGENS .................................................................................... 9
PAGAMENTO ................................................................................... 9
URL ..........................................................................................................9
Parmetros .................................................................................................9
Detalhamento parmetro MENSAGEM ....................................................10
Mtodo de envio .......................................................................................12
Diagrama de sequncia pagamento com sucesso ................................13
Fluxo de exceo 1 transao aprovada j realizada ............................13
Diagrama de sequncia Re-tentativa de pagto. aprovado .....................13
Fluxo de exceo 2 Transao negada .................................................14
Fluxo de exceo 3 Cielo Mobile bloqueado ou em estado de
Terminal Inoperante .................................................................................14

RESPOSTA DO PAGAMENTO ....................................................... 14


2

URL ........................................................................................................15
Parmetros ...............................................................................................15
Detalhamento parmetro MENSAGEM ....................................................16
Exemplo HTML Comprovante ..................................................................18
Mtodo de recebimento ............................................................................21

CANCELAMENTO .......................................................................... 21
URL ........................................................................................................22
Parmetros ...............................................................................................22
Detalhamento parmetro MENSAGEM ....................................................23
Mtodo de envio .......................................................................................23
Diagrama de sequncia Cancelamento com sucesso ...........................24
Fluxo de exceo Cancelamento j realizado .......................................25

RESPOSTA DO CANCELAMENTO ................................................ 25


URL ........................................................................................................25
Parmetros ...............................................................................................25
Detalhamento parmetro MENSAGEM ....................................................26
Mtodo de recebimento ............................................................................28

HISTRICO ..................................................................................... 28
URL ........................................................................................................28
Parmetros ...............................................................................................28

RETORNO HISTRICO .................................................................. 28


URL ........................................................................................................29
Parmetros ...............................................................................................29
Detalhamento parmetro MENSAGEM ....................................................29
3

Mtodo de recebimento ............................................................................29

CONSULTAR TRANSAO ........................................................... 30


URL ........................................................................................................30
Parmetros ...............................................................................................30
Detalhamento parmetro MENSAGEM ....................................................30
Mtodo de envio .......................................................................................30

RESPOSTA DA CONSULTA .......................................................... 31


URL ........................................................................................................31
Parmetros ...............................................................................................31
Detalhamento parmetro MENSAGEM ....................................................32
Mtodo de recebimento ............................................................................34

EXPORTAO DE HISTRICO ..................................................... 34


URL ........................................................................................................34
Parmetros ...............................................................................................34
Detalhamento parmetro MENSAGEM ....................................................35
Mtodo de envio .......................................................................................35

RESPOSTA DA EXPORTAO DO HISTRICO .......................... 35


URL ........................................................................................................36
Parmetros ...............................................................................................36
Detalhamento parmetro MENSAGEM ....................................................37
Mtodo de recebimento ............................................................................38

CONSULTAR PRODUTOS ............................................................. 38


URL ........................................................................................................38
Parmetros ...............................................................................................38
4

Detalhamento parmetro MENSAGEM ....................................................39


Mtodo de envio .......................................................................................39

RESPOSTA DA CONSULTA DE PRODUTOS ............................... 39


URL ........................................................................................................40
Parmetros ...............................................................................................40
Detalhamento parmetro MENSAGEM ....................................................42
Mtodo de recebimento ............................................................................43

EXEMPLO DE IMPLEMENTAO DE CLIENTE iOS .................... 43


Envio (Pagamento) ...................................................................................43
Recebimento (Pagamento) .......................................................................44
Validao ..................................................................................................45
Plist Cadastro URL Callback ....................................................................45

EXEMPLO DE IMPLEMENTAO DE CLIENTE ANDROID.......... 45


Envio (Pagamento) ...................................................................................45
Recebimento (Pagamento) .......................................................................46
Validao ..................................................................................................46
Dados de Retorno ActivityResult ..............................................................47
Android Manifest .......................................................................................47

DADOS DE RETORNO ................................................................... 48


Fluxo .........................................................................................................48
Tipo de captura.........................................................................................48
Cdigos de Resposta ...............................................................................49
Retorno da Aplicao ...............................................................................49

ORIENTAES FINAIS .................................................................. 51

VERSO DO DOCUMENTO

Essa a verso 1.19 do manual de integrao, de fevereiro de 2016.

INTRODUO

Para iniciar o desenvolvimento de integrao ao Cielo Mobile, favor enviar e-mail para
integracaocielomobile@cielo.com.br para receber os dados necessrios para
desbloqueio do aplicativo e configurao ao ambiente de certificao.
Importante destacar que os dados enviados funcionaro apenas no ambiente de teste
at a concluso do desenvolvimento.
O ambiente de certificao disponibilizado para voc efetuar os testes de integrao
entre o seu aplicativo e o Cielo Mobile. O seu estabelecimento comercial em produo
pode no possuir todos os servios financeiros disponveis no ambiente de certificao.
Em casos de dvidas durante o perodo de Integrao ao Cielo Mobile, favor direcionlas ao e-mail integracaocielomobile@cielo.com.br, com o seguinte contedo:
- Nmero Lgico de teste.
- Nmero do Estabelecimento.
- Dvida ou Evidncia de erro encontrado, caso houver.

Objetivo

Permitir que aplicaes de terceiros realizem um pagamento utilizando o aplicativo Cielo


mobile.

Cenrio

Ao final de uma venda utilizando um aplicativo mvel, o vendedor seleciona a opo de


pagamento com Cielo Mobile. A aplicao mvel de venda abre o aplicativo Cielo Mobile com
o valor da venda j informado.

Funcionamento
7

O aplicativo Cielo Mobile iniciado aps a escolha do tipo de venda (crdito, dbito,
credirio ou refeio) e segue o fluxo normal com exceo de alguns parmetros, como por
exemplo, o valor que j estar preenchido. Finalizando o processo, o Cielo Mobile retornar
ao aplicativo original, informando o resultado da transao.

Integrao

Haver mudana de contexto e a aplicao que ir para foreground ser a do Cielo


mobile. Para as interfaces de Consulta e Exportao o retorno feito para a
aplicao cliente sem a interao do usurio com o Cielo Mobile;
Transaes realizadas no modelo de chamada externa sero identificadas como tal
no histrico;
A comunicao com o Cielo Mobile feita em duas pernas: pagamento e resposta do
pagamento;
A comunicao com o Cielo Mobile assncrona, a aplicao de venda faz uma
chamada ao Cielo Mobile e informa uma URL de retorno;
Se a aplicao de venda no receber uma resposta deve repetir a transao com os
mesmos dados informados anteriormente. A aplicao Cielo Mobile verificar se o
pagamento j foi realizado e no repetir a transao retornando aplicao de
venda os dados do resultado do pagamento j realizado (apenas para transaes
autorizadas);
Outra opo a aplicao de venda realizar uma consulta para verificar o status da
venda. Se for aprovada, o Cielo Mobile retornar os dados da venda. Caso contrrio,
informar que a venda no foi encontrada;
A cada transao (pagamento ou cancelamento) a aplicao de venda deve enviar
um novo identificador de transao (idTransacao).

Importante para integraes com iOS: Por solicitao da Apple, as integraes em dispositivo com iOS 9.0 ou
superior precisam de uma configurao especial no urlscheme. Para essa verso de OS, necessrio que o
nome da aplicao cliente esteja cadastrada no Cielo Mobile, assim como o nome "cielomobile" esteja na
aplicao cliente. Essa configurao mandatria para o funcionamento.

Dessa forma, necessrio efetuar o procedimento conforme relatado abaixo:


1 - Cadastrar o nome "cielomobile" no cdigo da aplicao cliente
<key>LSApplicationQueriesSchemes</key>
<array>
<string> "nome do cdigo da aplicao" </string>
</array>

2 - Solicitar um cdigo aplicao j cadastrado no Cielo Mobile e que ser utilizado na aplicao que ir
realizar integrao com o Cielo Mobile.

Mensagens

Os parmetros identificados na coluna forma de envio como GET devem ser


enviados junto URL e codificados para serem usados como tal (URL Encode);
Os parmetros identificados na coluna forma de envio como EXTRA devem ser
enviados no formato JSON, conforme exemplificado abaixo, como um EXTRA da
Intent, cuja chave (KEY) deve ser a string definida como nome do parmetro.

PAGAMENTO

Mensagem utilizada para iniciar uma transao de pagamento no aplicativo Cielo


Mobile. O aplicativo iniciado da mesma forma que ocorre no Cielo Mobile quando a opo
Quero Vender selecionada na tela principal.

URL

cielomobile://pagar

Parmetros

Parmetro

Descrio

Exemplo

urlCallback

Endereo de
callback para a

urlCallback=nomeDoSeuApp://retornopagam

MENSAGEM

aplicao de
venda.

ento

Objeto JSON

OBS.: nas integraes com iOS o nomeDoSeuApp


deve ser o mesmo cadastrado no Cielo Mobile
previamente

"codProdutoSecundario ":"204 ",


"referencia ":"ref ",
"nomeAplicacao ":"App ",
"tipoTransacao ":1,
"bloquearDigitada ":"true ",
"inibirBotaoEnviarComprovanteVenda
":"true ",
"totalTransacoes ":0,
"totalPaginas ":0,
"codProdutoMatriz ":"3 ",
"parcelas":2,
"email ":"m@n.com ",
"gerarToken ":"true ",
"estVenda ":"0010000244470001 ",
"tipoProdutoAdministrativo ":"false ",
"dataTransacao ":"151119145117 ",
"pagina ":0,
"idTransacao ":"1 ",
"valor ":"100 "
}

Detalhamento parmetro MENSAGEM

Parmetro

Descrio

Exemplo

idTransacao

Id da transao na aplicao
de venda. Deve ser nico
por transao.

100

10

tipoTransacao

Tipo da transao

valor

Valor da transao sem o


separador da casa decimal.

200 para o valor 2,00.

dataTransacao

Data da transao

151119145117

estVenda

Cdigo do estabelecimento

0010000244470001

(EC+LOJA)
nomeAplicacao

Nome da aplicao que est


integrando com o Cielo
Mobile

Aplicao de Venda

referencia

Referncia do pagamento
que est sendo enviado

Venda 100

tipoProdutoAdministr
ativo

Se deve exibir somente os


produtos do tipo
administrativo.

False

email

E-mail do portador do carto


que receber o comprovante
da transao.

cliente@email.com.br

codProdutoMatriz

Cdigo do Produto Matriz.

codProdutoSecundario

Cdigo do Produto
Secundrio

204

parcelas

Nmeros de Parcelas

Obs: A validao do nmero


de parcelas de acordo com
a combinao dos
parmetros
codProdutoMatriz,
codProdutoSecundario e
estVenda. Sendo assim, para
o funcionamento do mesmo
preciso enviar uma
combinao vlida dos
parmetros
codProdutoMatriz,
codProdutoSecundario e
estVenda.

11

inibirBotaoEnviarCom

True

provanteVenda

Permite ou no envio de
comprovante pelo Aplicativo
Cielo Mobile.

gerarToken

Gerar token do carto

False

tipoProdutoAdministra

Se o produto
administrativo ou financeiro.

administrativo/financeiro

bloquearDigitada

Bloqueio de transaes
digitadas

False

pagina

Pgina que as transaes


foram exportadas.

Total de pginas de
transaes.

10

tivo

totalPaginas

Mtodo de envio
cielomobile://pagar?urlCallback=nomeDoSeuApp://retornopagamento

OBS.: nas integraes com iOS o nomeDoSeuApp deve ser o mesmo cadastrado no Cielo
Mobile previamente

Parmetro

Mtodo

urlCallback

GET

mensagem

GET

Exemplo:

cielomobile://pagar?urlCallback=appcliente://retornopagamento&mensagem=%7B
%22dataTransacao%22:%22141208104222%22,%22valor%22:%221200%22,%2
2idTransacao%22:%22123412%22,%22referencia%22:%22refer%C3%AAncia%22
,%22tipoTransacao%22:1,%22nomeAplicacao%22:%22aplicado%20cliente%22,%
22estVenda%22:%22000000000000000004%22%7D

12

Diagrama de sequncia Pagamento com Sucesso

Fluxo de exceo 1 Transao aprovada j realizada

Se a aplicao de venda no receber uma resposta, ela pode repetir a transao utilizando o
mesmo ID. O Cielo Mobile verificar se a transao j foi realizada e caso j tenha sido, no
repetir a mesma e retornar os dados da transao para a aplicao de venda. Deste
modo o aplicativo pode realizar a chamada de pagamento ao Cielo Mobile mltiplas vezes
sem duplicar a transao.

Diagrama de seqncia - Re-tentativa de pagamento aprovado

13

Fluxo de exceo 2 Transao negada

Se o pagamento for negado ou se a aplicao de venda no receber uma resposta, ela pode
repetir a transao utilizando o mesmo ID. Nesse caso, o Cielo Mobile no guardar as
informaes dessa transao e por isso iniciar um novo fluxo de pagamento.

Fluxo de Exceo 3 - Cielo Mobile Bloqueado ou em estado de Terminal


Inoperante

Quando o aplicativo est bloqueado ou em estado de teminal inoperante, o Cielo Mobile


retorna aplicao de venda informando o erro na mensagem de Resposta do Pagamento.

RESPOSTA DO PAGAMENTO

14

Quando um pagamento finalizado, o Cielo Mobile retorna o fluxo para a aplicao de


venda com o resultado do pagamento. O endereo de retorno ser o informado no
parmetro urlCallback da mensagem de pagamento, e ele dever ser capaz de receber os
parmetros abaixo.

URL

A URL definida na aplicao do parceiro:

nomeDoSeuApp://retornopagamento

OBS.: nas integraes com iOS o nomeDoSeuApp deve ser o mesmo cadastrado no Cielo
Mobile previamente

Parmetros

Parmetro

Descrio

Exemplo

mensagem

Objeto JSON

{
"captura":"ONL-X,
codAutorizacao":"133222",
"codProdutoMatriz":"4",
"codProdutoSecundario":"204",
"codResposta":"000",
"comprovanteCliente": "<!DOCTYPE html
PUBLIC \"-//W3C//DTD XHTML 1.0
Transitional//EN...</html>",
"comprovanteVendedor": "<!DOCTYPE
html PUBLIC \"-//W3C//DTD XHTML 1.0
Transitional//EN...</html>",
"dataRequisicao":"141114133218",
"dataServidor":"141114133218",
"estAcquirer":"0000000000000003",
"estVenda":"0010000244470001",

15

"fluxo":"4",
idAplicacao":"com.appParceiro",
"idTransacao":"1",
"modoCaptura":"141010204080",
nomeAplicacao":"App Parceiro",
"nsu":"419343",
"pan":"455182-9478",
referencia":"Venda 123",
"retornoAplicacao":"R00",
tipoTransacao":1,
"valor":"200",
"versaoAppFinanceira":"1.3.2",
email:cliente@email.com.br,
nomeBandeira:VISA,
nomeProdutoMatriz:CREDITO,
nomeProdutoSecundario:A VISTA
}

Detalhamento parmetro mensagem

Parmetro

Descrio

Exemplo

pan

6 primeiros-4 ltimos dgitos do


carto ou 4 ltimos dgitos do
carto

498453-1214
ou
************121
4

captura

Tipo de captura ("ONL-?" ou "OFF?")

ONL-C

codAutorizacao

Cdigo de Autorizao

100324

codProdutoMatriz

Cdigo produto matriz

codProdutoSecundari
o

Cdigo produto secundrio

204

16

codResposta

Cdigo de resposta

000

comprovanteCliente

HTML do comprovante de
pagamanto do cliente

ver exemplo HTML


comprovante

comprovanteVendedo
r

HTML do comprovante de
pagamanto do vendedor

ver exemplo HTML


comprovante

dataRequisicao

Data/hora da requisio

140502100145
(yyMMddHHmmss)

dataServidor

Data/hora servidor

140502100145
(yyMMddHHmmss)

estAcquirer

Estab. do Acquirer

000000000000000
3

estVenda

Cdigo do estabelecimento

(EC+LOJA)

001000024447000
1

fluxo

Fluxo do POS

04

idAplicacao

Id da aplicao que enviou a


transao para o Cielo Mobile

com.appParceiro

idTransacao

Id da transao

100

modoCaptura

Modo captura

141010204080

nomeAplicacao

Nome da aplicao que enviou a


transao para o Cielo Mobile

App Parceiro

Nsu

Nmero do documento

469603

codAid

Cdigo do Aid utilizado na


transao

A0000000031010

parcelas

Nmero de parcelas

referencia

Referncia da transao

Venda 123

retornoAplicacao

Cdigo de Retorno da Aplicao

R00

tipoTransacao

Tipo da transao. Cancelamento


ou Pagamento.

1 - Pagamento

valor

Valor final da transao

200 para o valor


2,00.

versaoAppFinanceira

Verso da aplicao financeira do


Cielo Mobile

1.3.2

Email

E-mail para qual foi enviado o


comprovante da transao.

cliente@email.com.
br

2 - Cancelamento

17

nomeBandeira

Bandeira do carto utilizado

VISA

nomeProdutoMatriz

Nome do produto matriz

CREDITO

nomeProdutoSecunda
rio

Nome do produto secundrio

A VISTA

Exemplo HTML Comprovante

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"


"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<style type="text/css">
body {margin: 0; padding: 0; min-width: 100%!important;}
img {height: auto;}
.content {width: 100%; max-width: 600px;}
.fix {display: block;}
</style>
</head>
<body>
<table width="100%" bgcolor="#ffffff" border="0" cellpadding="0"
cellspacing="0">
<tr>
<td>
<table class="content" align="center" cellpadding="0"
cellspacing="0" border="0">
<tr>
<td>
<table align="center" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="center"

18

style="font-family: Courier New, Courier, monospace; font-size: 6px; padding-top: 15px;


padding-right: 10px; padding-bottom: 15px; padding-left: 10px; line-height: 10px; backgroundcolor: #ebfaff;">
<center>
<img class="fix"
src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAARQAAABdCAYAAABkUJlpAA
AABHNCSVQICAgIfAhkiAAAEOZJREFUeJztnX9oVtcZxz/1DYFAIBAIBBwBISAEAhkZAcEREB
yODMEhdDgcgmBxCA6hIBQswoajo8NiKTgcGQ6LxWKxOASLw2FRFMWiKIrFElFaIikpkUgkkv
3x5OV9E98f957nOffc8773Cw/d2tx7frz3fM95fh4o0Aw9wD7gPHAbWALmgJvAaWBbuK4VKJAv
vBW6AzlGCSGSQ0Bvk7+9D/wJ+Mp3pwoAsAkYdHjuPvC1cV8KFGiKbuACchpJIwdDdLYNcYr
0v80S8EmIzrYTOkJ3IIfoRMhko8OzR4Au4H3THhUoEAnWhO5ADnEUNzIp4xCFXaVAm6IglJU
YAfYYvOcD5KRToEBboSCUlXgPMcZqMQjsNHhPgQJRoSCUCrqArYbv22H4rgIFokBBKBWM
YaumbMDmtFOgQDQoCKUCl7iGRugC+o3fWaBArlEQSgU+jKiFYbZAW6EglApeenjnDx7eWaB
AblEQSgX3jd/3I35IqkCB3KIglAq+AV4Yvu+a4bsKFIgCBaFU8Ar4zPB9/zR8V4ECUaAglJV4HyE
WLb4BvjB4T4ECUaEglJV4hj6x7xXwR4O+FCgQHQpCeRN/Raf6vENhPynQpghZvqAfCSYbAo
apxGz0IhGmz6v+9tby/78LfJtB336/3N6+FM+8BP4AfO6lRzboBtYDo8jc9yz/+35gLXJCK7u6y//7
FvAQW4N1geQYAtYty3DVvx9Fvrlq7+R95De7i73XMncYRBboWWAGtwI5S8vPngMOIJPtE1uA
ewn6dDaDvrigH9gOHAce4z7nS8Cd5fdsQ4gpJFq5wNIGJEn1AlJq1PX3mkPKlr6LkE9LoB+pYv
YA3cfcSB4gNUjWehzHOFI86TxSS7ZcT/YgsnPkCV1IYuJ5/M35AkLq2wmTr9RqhDIM/Bl4ir/f7Cl
wmPx9r4mwAb8fdC2Zp3KEb0f0AR8Cs2Q779+TrO6uJVqFUCaAy2T7ey0Bl5BNMvfYSJgJWgI
m/Q8vl+gHjiGEGmLeyzKH7IBZkHrshLIFUSFD/l5LwFVgs+exOmEdYkcIOTktoycmRAnYj07P9i
Ez+C8uFSuhDOFW/Ny3nAMGPI47FfLwUV/1Psp8YZjKHUF5lUv409djI5QSYmhdSNDHUDJP4
FsbehFmCz0RS7jviOsdnwuJfeT7w6yWOcRwa42YCGUdcMWxvyHkImKPyxRjwJSy41YyjXg20
qIfWER02b2Ed4U2QzdwhvDz7SJHsfUGxUIo4+hCJELJU3Q3P6TCBOENgNVyxHEcB1e9Zxb5
4PIYT9ILXCf8XGvkFHakEgOh7CKek2QtWcDP6XIFdiK7eujBlmURNz29RONAr8vA2+SjJuwAfu
N4spQz2FSxi4FQPnHsY55kEZtrZWpiTw4GuFrOOY5lc8L3f48EHIWqDbuW/KiWVnIeNxW1GjE
QSgkJfgw93xay13hu2Eq+TiZl2eI4nrS2iEXELb7BsT0X9JCPWAUfcgkdqcRAKCCnsUuOfc2TL
GJ4G+YY+bKZlOURbipJHzrd9hx+w/yhdT7ERnJaMT+xEAq0zsawAGzSTkYfcuwPPZhacsBxTK
uNsS4yh/vpKAmOGfQxBnnXcX5iIhQQlflRwj7mWaZpov43K19wstkLjPAc+A6pdFaNYeQ0sDqK
7yXwL8e2djs+V41uxBbwDvalHreRrmyCK14hae6rU+BB5n0I/2H0R4AbwP88txMaPwC/RgIwNT
EeL5BSEqt/sxHEOeE7fqQPIfNfAa/TPmyxk9eT2eWOvU0ywupB3NVHEZY8kXYwy9hkPI5FbK8
vXYff5L6bSCJf0oC+ASQS2mei52PSxwDFdkIpI635YBax9+0kGVn0I2vqFH6/o0NpBz6IHx/6FO
Kf11r5XTNbXT/ERjLPysI3GvhYuPNIFrLW7tOPeLx8fKhpN4hYCQVkU2u2tu6hvxu7C1lrPryEC6
S8adP6w55F9GUtkWjQhz/j8hWD/k146NdJ7JO+ehEbj6XXbxE5tidFzIQCQha1+vcA+8TKLmTt
WW8EF5N2wPrDPku2tTLq4QB+yKQsmh2lE1uj3RT+s6/HsA24S0PKsRMKyCKv7ttx/G64vdhX
BEj0zScpeZhU3nMdvQf4jja9qejbXsN+XCW7QLxubNPxk8Y6tAKhgBil59GrN2nwHna/1z2ahG5
sNWpongzyAFJgFL9kUhYXW0oJOz13kuwvaC9hF2Z+PWGboQllDDuPSoiSjNuxU/8brnOLBDS
TABgP2ID/UGiXehI7jdo+7tC2JSaxGcd4grZCE8o9ZEEew3+Qoy8kMQ4nkbon8zGDly+R7fHNB
QOI+9mHt8Ilt+imQbvnCZvI2Iu4Ei3m8GyC9kISyuo8sAXiJZZ6xuG0UrPUgUV05jHT4fpFNxJjob
1eolrupezDeoM2pwhn9B5CTkaW3rMFmo8nJKHUO+UuIHMRW1V5i3X/xum4hL4QzB2y19+tsA
2bqlozKdv9s0Gb4+mHq8Zm/NZGbRYpHIpQumlOnouI+hdLNcBO9I6YGVZ5qCxcxZlVePKIUS
R2w1W3XEzZntYYe8pplG7oQtIWLL2A9aSZCzkUoaRVEU5hF/ToExvR/2YT1S/UHntc65LkFZo
JTopBRRtl8sqiUnkfcpLKspThIo3D8UMRimu7Z8n/rQza+tAr5labXj3ma5SBMIx/QtHGnkwqxpcEI
+hOa1pZseOtQihC0Z4oc3NVRQ1onTJ3yi/qVb4oaexATMiCULR5Rb52vK2Eu6xtCTmdnKSxDS
IEoWhPlJcVbWcFbdhIfwd628e/lc+3KzTz/hC4ZdURRL3YhXi9UiV9GeI58A/gYyTdP29Ik2tUC9Zl
LnzgU3TaxoYO9NboL5XPtyN60B1/vzDqxwDiUdlDuHuhbyAk8hlSoyWv0BDKa+A/Vh3xiC+QG
C1XDHeg25EeAk8Uz7crtKcAbUGiMSRZcjthAuJeIwTyEUIoMUDzm90AfrTqiEc8Qda06yFjUHtC
19

+VrxbDtDG/zkMu8lhEAOEM6Inne1phE0hHLXrBf+8TXunLCuA12S00PFs+0MTTbwM6QUYFL0
IPEj+wnnZYhFrWkEzTqJiVA0a7q/A90VnN8pnm1naELlk875IEIiuwhzzepr4HPg78Sj1jSChlBiMg
to1nRvBzpjXJqdskAFmkI6zXTxcYRIzO5RSYmY1ZpG0PxmP5n1wj80a7pbe0IpCMUNGkNorTn
vRIoTH0Dv3nRFK6g19aA1XLcLoXQ2u0aj6QuUz7crUl9BUIXqOe9FIm73Eea61LJa8xFwLUD7
WeH1srgSS0zrRNPX1x0II7mqPSF081bAS8WzPUjZgP1IcaYQhb9bVa1pBM06CRXj4wKVCUR
LKKEuEY8dmmPlOOnrrlihldWaZvgJ93USU40UjfH5pw5kh3GtNhVLzYe8QbOrZ318Lqs1H9Pec
UcaO0iodAYXaNb08zVIXIMrWi3LOCvE4EZ8DvwF+BnwO9qbTEDnTs176YJqaIz6zzqAbxUvG
EV0eI1NoB2R5/idW4iRtR3VmkbQBHxtII510oX01RUP1/DmRdlpO5DHCvd5xzPkBJAXlHNrfgn8
AskgL8hkJTQbbxdxVDTchM7If38N+jT4vFe5zyvyEI5dqDXJoV0n1leM+oD2Lq1boC9QPY/dpUd
5QRYFlg4r2tDKbeQDjyk+ohohCixZrJM8e0W1d3/PAKU1yHFXkw7fRfMq5QXexFcZt1et1vycQq
1Ji9fogve6yNfVvKvxCvHkuYY0XKMqYFNb33SWfFyIboUsTihdwJyinaQyjRSZzvPumBahasoec
Gy3LAvk34Xci3wvaS/C21v9krVILU/NZJ3wNsTskQWhgL6ubCO5jWQax6rWNEIoQhlwbLdasrz
6RIMe5ESVRM2reQPDpQQPNpMtngaXNbIiFKvL6at/2NPE4VHQIOTNgZcd266WUJngLuhG7u
xuRCyXaj24q8EDSWWaOO94XY2sCKUT+F7RVvW8t5pa0wghCWW3Y9vVMk8cF4BVoxtR+a
Z5czw1vUPd2Fwgfoe4kqFqIStCAd11pLeRDzxEgmBIhCSUHmzWyRRxekfLTpinyDi+p0EWtpUr
8wphjLRdCItq61dkSSgDpLtMK49qzXayTcMISSgARxzbXy03ifdU2YkYYvc3+qM+7DwPj8j2WN
dP5aIirYE4S0IB+CDBe2fIp1pzCOnfNNn93qEJRRuzUS1TZLtOBhCbR2YbwIfYTNQSQk5ZGGp
HefOayCOK92VNKL3UN3rlVa3pAs6wsq9PycaG5kooV7Ar1H3UsQ8h18lmKt/ZDBkRWQ8V/ch
KTuCn4noPQoD1VIZ3Hd+bNaHAyhgHC7VmG+JF8oEdwGNqj/8R/m0Dx+u0nVROo0uCg8abg
Kucws866aX2QSGrDYAdNRrXyjxyZLcw2HYiCzCJcWyXw/tDEEonolMfQa/W9FH52C+jXzxljCN
9bDYHN/FrmLc6RV9HavG62ty0AaG1ZGF5fBbz14OsuUZmjMycKJcbdEIjs8gO45KlPILYG9K4
WhdJv1OHIBRL1FIJ7iAknHZHWotY9ZMQSbVcwp+ati9lX5rJFDI3LgvrsnFfyjIHTCKqUBrC60FO
p5Mk90Zdwei3eqvBfxtA9Hef3poXSB7Rw2V5RqWaWQ8SpjyA1FAdw/149hL4DfDfhH8/jCxAFz
Sa0yywGbjY5G+eIOUcryG/wQtk/keQj3d0+Z/j6ELFvwR+i64ody1sok4wlRIvkEvNPyJ5zZos1slL
ZJ08QdbHMyprZT0S8jG0LJtwO3H5+q1WwDqSM6TMkrwaVawnlC7EhhF6rqtl0tM4rbws9eQMy
VXFVlknVl6whrC0ZoeWaZLtuLESilV8hLV84GGs5zLo9+EU/WmVdXIoxZidUOJN92DM8pjmqlO
MhDJCugC5rOWg8Xh9nwoWSV+t3meyZ5ayInPYBzqxSR7MizSzbMdGKCXgaoo+hpLdxuO+4r
Gv5x360yrrxMWRkRo9+LNoh5DjDcYaG6H4cF/6kDlsjZcj6Mtu1BPXjOBuWmOdzGMXblAXXW
Sju/qWizS+9TAmQllLNoWatDKDn3BvH3ajhglvCdAJnPXQr6xlUjEHiVFCIl9DD9ZVTtK86FBMh
BKDfWsKv5XKrDc5TdpGGSXEaxJ67kPOQSrsxr/rzlIWSF77NhZCmVD0Mys5h/9IzFp5Ra6yiC3
57SCOE2RZ5ghYoX8EeNCkg3mQR6S7ES0GQunGPufKUhZoktruAYfR21SaBQW6YD3iCAj9
mzST6+TgHuZOxHedx9PKIhIDkTasOAZCWUf6cPis5CLh7r0eRefx0t5NUw95XidziFtfW0fIFIOIq
y305JTlAhKK7IIYCKWMPdiUkbSQx/hbkGmxEckqTnNimcZ/Ue915Cte5QT5q7GzAqOEtXCfRX
85dUyEApWyfKGI5QGS1Z2rHW4ZfUj19iRz4yOitx7WI14UX27vRrKAEInrhhsEQ0gadhYf+fRyW
1YFY2IjlDJKSDp+FsFVC4ghdCKTkelRQmJLGs1NiDtzBhDbT736MpZye7mtGGvZrsAEwoiWkz
aFMPwE9jtjrIRSjX7EKHoBO719BjkB7iHui93WI7k31en9PrKX02IcOSVZGXDnEC/bbjJSa0Kk2g
8gEzeGLNy1NN8Z7iPp5N8iFzKXU7l9IebyBbVQQqIehxFvV1kl7Ka+8fQhcpn6feAb5CL1PFzwb
olu5ES3D/gb8GnY7qxAH7JOhpD1MYT8fvVsPOUSFHeRtXIDKdeR6XWz/wds0Cemo7ZH2AA
AAABJRU5ErkJggg==" width="105" height="38"
alt="Cielo" />
</center>
<pre>
CREDITO A VISTA - I
424242-4242
VIA - CLIENTE / POS=69000004
20

CNPJ: 00.000.000/0000-00
MENSAGEM TBL F0
<b>POSTO ABC

</b>

Barueri - SP
0000000000000003 DOC=030008 AUT=135714
<b>14/01/11

04:04

ONL-X</b>

VENDA A CREDITO
<b>VALOR:

3,33</b>

MENSAGEM TBL D0
</pre>
</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
</tr>
</table>
</body>
</html>

Mtodo de recebimento

Parmetro

Mtodo

mensagem

GET

CANCELAMENTO

21

No aplicativo Cielo Mobile, acesse a tela de cancelamento que solicita a digitao do CPF ou
CNPJ do estabelecimento. O cancelamento uma nova transao no aplicativo do parceiro.
A relao com o pagamento feita no aplicativo Cielo Mobile, e por isso o cancelamento
deve ter um novo identificador de transao.

URL

cielomobile://cancelar

Parmetros

Parmetro

Descrio

Exemplo

urlCallback

Endereo de callback
para a aplicao de
venda.

cielomobile://cancelar?urlCallback=nome
DoSeuApp://retornocancelamento

Objeto JSON

mensagem

OBS.: nas integraes com iOS o


nomeDoSeuApp deve ser o mesmo
cadastrado no Cielo Mobile previamente

"dataTransacao":"141208120609",
"codProdutoMatriz":"4",
"idTransacao":"321",
"tipoTransacao":2,
"valor":"200",
"nsu":"12634",
"codProdutoSecundario":"304",
"referencia":"referncia",
"dataServidor":"141208121212",
"nomeAplicacao":"cliente",
"estVenda":"0010000244470001",
email:cliente@email.com.br
}

22

Detalhamento parmetro mensagem

Parmetro

Descrio

Exemplo

idTransacao

Identificador da transao

codProdutoMatriz

Cdigo produto matriz

codProdutoSecunda
rio

Cdigo produto secundrio

204

dataServidor

Data/hora servidor

141114133218
(yyMMddHHmmss)

estVenda

Cdigo do estabelecimento

0010000244470001

(EC+LOJA)
valor

Valor da transao

200 para o valor 2,00.

nomeAplicacao

Nome da aplicao que enviou a


transao para o Cielo Mobile

Aplicao de Venda

nsu

NSU

469603

referencia

Referncia da transao

Venda 123

email

E-mail do portador do carto que


receber o comprovante de
cancelamento da transao.

cliente@email.com.br

Mtodo de envio

Parmetro

Mtodo

urlCallback

GET

mensagem

GET

Exemplo:

cielomobile://cancelar?urlCallback=appcliente://retornocancelamento&mensagem=
%7B%22dataTransacao%22:%22141208104506%22,%22codProdutoMatriz%22:%
224%22,%22idTransacao%22:%22123423%22,%22tipoTransacao%22:2,%22valo
r%22:%222100%22,%22nsu%22:%2212345%22,%22codProdutoSecundario%22:
23

%22321%22,%22referencia%22:%22refer%C3%AAncia%22,%22dataServidor%2
2:%22141208101010%22,%22nomeAplicacao%22:%22app%22,%22estVenda%2
2:%22000000000000003%22%7D

Diagrama de sequncia Cancelamento com sucesso

Fluxo de exceo Cancelamento j realizado

Se a aplicao de venda no receber uma resposta, ela pode repetir a transao utilizando o
mesmo ID. O Cielo Mobile verificar se a transao j foi realizada e caso j tenha sido, no
repetir a mesma e retornar os dados da transao de cancelamento para a aplicao de
24

venda. Deste modo o aplicativo pode realizar a chamada de cancelamento ao Cielo Mobile
mltiplas vezes sem duplicar a transao.

REPOSTA DO CANCELAMENTO

Quando um cancelamento finalizado, o Cielo Mobile retorna o fluxo para a aplicao de


venda com o resultado do cancelamento. O endereo de retorno ser o informado no
parmetro urlCallback da mensagem de cancelamento, e ele dever ser capaz de receber os
parmetros abaixo.

URL

A URL definida na aplicao do parceiro:

nomeDoSeuApp://retornocancelamento

OBS.: nas integraes com iOS o nomeDoSeuApp deve ser o mesmo cadastrado no Cielo
Mobile previamente

Parmetros

Parmetro

Descrio

Exemplo

mensagem

Objeto JSON

{
"captura":"ONL-X",
"codAutorizacao":"141738",
"codProdutoMatriz":"4",
"codProdutoSecundario":"204",
"codResposta":"000",
"dataRequisicao":"141114141730",
"dataServidor":"141114141730",
"estAcquirer":"0000000000000003",
"estVenda":"0010000244470001",
25

"fluxo":"28",
idAplicacao":"com.appParceiro",
"idTransacao":"2",
"modoCaptura":"141010204080",
nomeAplicacao":"App Parceiro",
"nsu":"419345",
"pan":"455182-9478",
referencia":"Venda 123",
"retornoAplicacao":"R00",
"tipoTransacao":2,
"valor":"200",
"versaoAppFinanceira":"1.3.2",
email:cliente@email.com.br,
nomeBandeira:VISA,
nomeProdutoMatriz:CREDITO,
nomeProdutoSecundario:A VISTA
}

Detalhamento parmetro mensagem

Parmetro

Descrio

Exemplo

pan

6 primeiros-4 ltimos dgitos do


carto ou 4 ltimos dgitos do
carto

498453-1214
ou
************121
4

captura

Tipo de captura ("ONL-?" ou "OFF?")

ONL-C

codAutorizacao

Cdigo de Autorizao

100324

codProdutoMatriz

Cdigo produto matriz

codProdutoSecundari
o

Cdigo produto secundrio

204

26

codResposta

Cdigo de resposta

000

dataRequisicao

Data/hora da requisio

140502100145
(yyMMddHHmmss)

dataServidor

Data/hora servidor

140502100145
(yyMMddHHmmss)

estAcquirer

Estab. do Acquirer

000000000000000
3

estVenda

Cdigo do estabelecimento

(EC+LOJA)

001000024447000
1

fluxo

Fluxo do POS

04

idAplicacao

Id da aplicao que enviou a


transao para o Cielo Mobile

com.appParceiro

idTransacao

Id da transao

modoCaptura

Modo captura

141010204080

nomeAplicacao

Nome da aplicao que enviou a


transao para o Cielo Mobile

App Parceiro

nsu

Nmero do documento

469603

codAid

Cdigo do Aid utilizado na


transao

A0000000031010

parcelas

Nmero de parcelas

referencia

Referncia da transao

Venda 123

retornoAplicacao

Cdigo de Retorno da Aplicao

R00

tipoTransacao

Tipo da transao. Cancelamento


ou Pagamento.

1 - Pagamento

valor

Valor da transao

200 para o valor


2,00.

versaoAppFinanceira

Verso da aplicao financeira do


Cielo Mobile

1.3.2

email

E-mail para qual foi enviado o


comprovante de cancelamento da
transao.

cliente@email.com.
br

nomeBandeira

Bandeira do carto utilizado

VISA

nomeProdutoMatriz

Nome do produto matriz

CREDITO

2 Cancelamento

27

nomeProdutoSecunda
rio

Nome do produto secundrio

A VISTA

Mtodo de recebimento

Parmetro

Mtodo

mensagem

GET

HISTRICO

Inicia o aplicativo Cielo Mobile na tela de exibio do histrico.

URL

cielomobile://exibirhistorico

Parmetros

Parmetro

Descrio

urlCallback

Endereo de callback
para a aplicao de
venda.

Exemplo

cielomobile://exibirhistorico?urlCallback=appcliente://retornohistorico

RETORNO HISTRICO

Quando a exibio do histrico for finalizada, o Cielo Mobile retornar o fluxo para a
aplicao de venda informando o resultado da chamada.
28

URL

A URL definida na aplicao do parceiro:

nomeDoSeuApp://retornohistorico

OBS.: nas integraes com iOS o nomeDoSeuApp deve ser o mesmo cadastrado no Cielo
Mobile previamente

Parmetros

Parmetro

Descrio

Exemplo

mensagem

Objeto JSON

{
idAplicacao":"com.appParceiro",
"retornoAplicacao":"R00",
}

Detalhamento parmetro mensagem

Parmetro

Descrio

Exemplo

retornoAplicacao

Cdigo de
Retorno da
Aplicao

R00

idAplicacao

Id da aplicao
que enviou a
transao para o
Cielo Mobile

com.appParceiro

Mtodo de recebimento

Parmetro

Mtodo

29

mensagem

GET

CONSULTAR TRANSAO

Busca uma transao especfica feita pela aplicao do parceiro.

URL

cielomobile://buscartransacao

Parmetros

Parmetro

Descrio

Exemplo

urlCallback

Endereo de callback para


a aplicao de venda.

cielomobile://buscartransacao?url
Callback=nomeDoSeuApp://retor
noconsulta
OBS.: nas integraes com iOS o
nomeDoSeuApp deve ser o mesmo
cadastrado no Cielo Mobile
previamente

MENSAGEM

Objeto JSON

{
"idTransacao":"1"
}

Detalhamento parmetro mensagem

Parmetro

Descrio

Exemplo

idTransacao

Id da transao a ser recuperada

Mtodo de envio

30

Parmetro

Mtodo

urlCallback

GET

mensagem

GET

Exemplo:

cielomobile://buscartransacao?urlCallback=appcliente://retornoconsulta&mensage
m=%7B%22idTransacao%22%3A%22123%22%7D%0A

RESPOSTA DA CONSULTA

Quando a consulta realizada, o Cielo Mobile retornar o fluxo para a aplicao de venda
com os dados da transao consultada. O endereo ser o informado no parmetro
urlCallback na mensagem de consulta. O endereo dever ser capaz de receber os
parmetros abaixo.

URL

A URL definida na aplicao do parceiro:

nomeDoSeuApp://retornoconsulta

OBS.: nas integraes com iOS o nomeDoSeuApp deve ser o mesmo cadastrado no Cielo
Mobile previamente

Parmetros

Parmetro

Descrio

Exemplo

mensagem

Objeto JSON

{
"captura":"ONL-X",

31

"codAutorizacao":"133222",
"codProdutoMatriz":"4",
"codProdutoSecundario":"204",
"codResposta":"000",
"dataRequisicao":"141114133218",
"dataServidor":"141114133218",
"estAcquirer":"0000000000000003",
"estVenda":"0010000244470001",
"fluxo":"4",
"idAplicacao":"b",
"idTransacao":"1",
"modoCaptura":"141010204080",
"nomeAplicacao":"a",
"nsu":"419343",
"pan":"455182-9478",
"referencia":"ref",
"retornoAplicacao":"R00",
"tipoTransacao":1,
"valor":"1000",
"versaoAppFinanceira":"1.3.2",
nomeBandeira:VISA,
nomeProdutoMatriz:CREDITO,
nomeProdutoSecundario:A VISTA
}

Detalhamento parmetro mensagem

Parmetro

Descrio

Exemplo

Pan

6 primeiros-4 ltimos dgitos do

498453-1214
32

carto ou 4 ltimos dgitos do


carto

ou

Captura

Tipo de captura ("ONL-?" ou


"OFF-?")

ONL-C

codAutorizacao

Cdigo de Autorizao

100324

codProdutoMatriz

Cdigo produto matriz

codProdutoSecundari
o

Cdigo produto secundrio

204

codResposta

Cdigo de resposta

000

dataRequisicao

Data/hora da requisio

140502100145

************1214

(yyMMddHHmmss)
dataServidor

Data/hora servidor

140502100145
(yyMMddHHmmss)

estAcquirer

Estab. do Acquirer

0000000000000003

estVenda

Cdigo do estabelecimento

0010000244470001

(EC+LOJA)
Fluxo

Fluxo do POS

04

idAplicacao

Id da aplicao que enviou a


transao para o Cielo Mobile

com.appParceiro

idTransacao

Id da transao

modoCaptura

Modo captura

141010204080

nomeAplicacao

Nome da aplicao que enviou a


transao para o Cielo Mobile

App Parceiro

Nsu

Nmero do documento

469603

codAid

Cdigo do Aid utilizado na


transao

A0000000031010

parcelas

Nmero de parcelas

Referencia

Referncia da transao

Venda 123

retornoAplicacao

Cdigo de Retorno da Aplicao

R00

tipoTransacao

Tipo da transao. Cancelamento


ou Pagamento.

1 Pagamento

Valor da transao

200 para o valor


2,00.

Valor

2 - Cancelamento

33

versaoAppFinanceira

Verso da aplicao financeira do


Cielo Mobile

1.3.2

nomeBandeira

Bandeira do carto utilizado

VISA

nomeProdutoMatriz

Nome do produto matriz

CREDITO

nomeProdutoSecunda
rio

Nome do produto secundrio

A VISTA

Mtodo de recebimento

Parmetro

Mtodo

mensagem

GET

EXPORTAO DE HISTRICO

Retorna do Cielo Mobile todas as transaes do cliente dentro do perodo informado. Essa
exportao dever ser paginada. Cada pgina possui no mximo 20 transaes.

URL

cielomobile://exportarhistorico

Parmetros

Parmetro

Descrio

Exemplo

urlCallback

Endereo de callback
para a aplicao de
venda.

cielomobile://exportarhistorico?urlCallbac
k=appcliente://retornoexportacao

Objeto JSON

mensagem

OBS.: o nome appcliente de uso obrigatrio


nas integraes com iOS

"dataFim":"141114143719",
34

"dataInicio":"140802143019",
"pagina": 1
}

Detalhamento parmetro mensagem

Parmetro

Descrio

Exemplo

dataInicio

Data/hora inicial do perodo desejado

141110140000
(yyMMddHHmmss)

dataFim

Data/hora final do perodo desejado

141110150000
(yyMMddHHmmss)

pagina

Nmero da pgina que deseja


exportar o histrico. Na primeira
requisio, dever enviar a pgina 1.

Mtodo de envio

Parmetro

Mtodo

urlCallback

GET

mensagem

GET

Exemplo:

cielomobile://exportarhistorico?urlCallback=appcliente://retornoexportacao&mensa
gem=%7B%22dataFim%22%3A%22141208101010%22%2C%22dataInicio%22%
3A%22141207101010%22%7D

REPOSTA DA EXPORTAO DO HISTRICO

35

Retorna o fluxo para a aplicao de venda com os dados resultantes da consulta. O


endereo ser o informado no parmetro urlCallBack na mensagem de exportao. O
endereo dever ser capaz de receber os parmetros abaixo.

URL

A URL definida na aplicao do parceiro:

nomeDoSeuApp://retornoexportacao

OBS.: nas integraes com iOS o nomeDoSeuApp deve ser o mesmo cadastrado no Cielo
Mobile previamente

Parmetros

Parmetro

Descrio

Exemplo

mensagem

Objeto JSON

{
"idAplicacao":"b",
"retornoAplicacao":"R00",
"transacoes":
[{"captura":"ONL-X",
"codAutorizacao":"143848",
"codProdutoMatriz":"4",
"codProdutoSecundario":"204",
"codResposta":"000",
"dataRequisicao":"141114143843",
"dataServidor":"141114143843",
"estAcquirer":"0000000000000003",
"estVenda":"0010000244470001",
"fluxo":"4", "idAplicacao":"b",
"idTransacao":"1",
"modoCaptura":"141010204080",
"nomeAplicacao":"a", "nsu":"420697",
"pan":"455182-9478",
"referencia":"ref", "tipoTransacao":1,
"valor":"1000",
36

"versaoAppFinanceira":"1.3.2",nomeB
andeira:VISA,
nomeProdutoMatriz:CREDITO,
nomeProdutoSecundario:A VISTA
}],
"pagina": 1,
"totalPaginas": 10,
"totalTransacoes": 2000,
}

Detalhamento parmetro mensagem

Parmetro

Descrio

Exemplo

idAplicacao

Id da aplicao que
enviou a transao
para o Cielo Mobile

com.appParceiro

retornoAplicacao

Cdigo de Retorno da
Aplicao

R00

transacoes

Lista de objetos de
Transacao que
possuem a mesma
estrutura do objeto
retornado na consulta

[{"captura":"ONL-X",
"codAutorizacao":"143848",
"codProdutoMatriz":"4",
"codProdutoSecundario":"204",
"codResposta":"000",
"dataRequisicao":"1411141438
43",
"dataServidor":"141114143843
",
"estAcquirer":"0000000000000
003",
"estVenda":"001000024447000
1", "fluxo":"4",
"idAplicacao":"b",
"idTransacao":"1",
"modoCaptura":"14101020408
0", "nomeAplicacao":"a",
"nsu":"420697",
"pan":"455182-9478",
37

"referencia":"ref",
"tipoTransacao":1,
"valor":"1000",
"versaoAppFinanceira":"1.3.2"
nomeBandeira:VISA,
nomeProdutoMatriz:CREDIT
O,
nomeProdutoSecundario:A
VISTA}]
pagina

Pgina que as
transaes foram
exportadas.

totalPaginas

Total de pginas de
transaes.

10

totalTransacoes

Total de transaes
que esto gravadas no
aplicativo.

2000

Mtodo de recebimento

Parmetro

Mtodo

mensagem

GET

CONSULTAR PRODUTOS

Retorna do Cielo Mobile a lista de produtos primrios e seus respectivos produtos


secundrios.

URL

cielomobile://consultarprodutos

Parmetros

38

Parmetro

Descrio

Exemplo

urlCallback

Endereo de callback cielomobile://consultarprodutos?urlCallb


para a aplicao de
ack=nomeDoSeuApp://retornoconsulta
venda.
rprodutos
OBS.: nas integraes com iOS o
nomeDoSeuApp deve ser o mesmo
cadastrado no Cielo Mobile previamente

mensagem

Objeto JSON

"estVenda":"0010000244470001"
}

Detalhamento parmetro mensagem

Parmetro
estVenda

Descrio

Exemplo

Cdigo do estabelecimento

0010000244470001

(EC+LOJA)

Mtodo de envio

Parmetro

Mtodo

urlCallback

GET

mensagem

GET

Exemplo:

cielomobile://consultarprodutos?urlCallback=appcliente://retornoconsultaprodutos&
mensagem={"estVenda":"0010000244470001"}

REPOSTA DA CONSULTA DE PRODUTOS

39

Retorna o fluxo para a aplicao de venda com os dados resultantes da consulta. O


endereo ser o informado no parmetro urlCallBack na mensagem de consulta produtos. O
endereo dever ser capaz de receber os parmetros abaixo.

URL

A URL definida na aplicao do parceiro:

nomeDoSeuApp://retornoconsultaprodutos

OBS.: nas integraes com iOS o nomeDoSeuApp deve ser o mesmo cadastrado no Cielo
Mobile previamente

Parmetros

Parmetro

Descrio

Exemplo

mensagem

Objeto JSON

{
"listaProdutosPrimarios ":[
{
"codigo ":4,
"listaProdutosSecundarios ":[
{
"codigo ":204,
"nome ":"A VISTA "
},
{
"codigo ":205,
"nome ":"PARC. ADM "
},
{

40

"codigo ":206,
"nome ":"PARC. LOJA "
}
],
"nome ":"CREDITO "
},
{
"codigo ":8,
"listaProdutosSecundarios ":[
{
"codigo ":208,
"nome ":"A VISTA "
},
{
"codigo ":209,
"nome ":"PRE DATADO "
}
],
"nome ":"DEBITO "
},
{
"codigo ":13,
"listaProdutosSecundarios ":[
{
"codigo ":251,
"nome ":"V.ALIMENTACAO "
},
{
"codigo ":250,
41

"nome ":"V.REFEICAO "


}
],
"nome ":"VISA VALE "
},
{
"codigo ":22,
"listaProdutosSecundarios ":[
{
"codigo ":222,
"nome ":"VENDA "
},
{
"codigo ":223,
"nome ":"SIMULACAO "
}
],
"nome ":"CREDIARIO "
}
]
}

Detalhamento parmetro mensagem

Parmetro

Descrio

Exemplo

listaProdutosPrimarios

Lista com todos os


produtos que o Cielo
Mobile permite
transacionar.

Crdito, dbito

codigo

Cdigo do produto
primrio.

22

42

nome

Nome do produto
primrio.

CRDITO

listaProdutosSecundarios

Lista com todos os


produtos secundrio
atrelados a um
determinado produto
primrio.

vista

codigo

Cdigo do produto
secundrio.

222

nome

Nome do produto
secundrio.

VISTA

Mtodo de recebimento

Parmetro

Mtodo

mensagem

GET

Exemplo de implementao de um cliente IOS

Para integrarmos com o Cielo Mobile temos como exemplo o cdigo abaixo de uma
requisio de envio e outra de recebimento. A String JSON gerada no aplicativo Cliente
para comunicar com o Cielo Mobile. O request montado pela interface URLSchemeSender,
no seu mtodo requestWithUrl com parmtro "strUrl".

Envio IOS (Pagamento)

NSString *strJson ={
"dataTransacao":"141201112612",
"valor":"200",
"idTransacao":"123456",
"referencia":"ref",
"tipoTransacao":1,
"nomeAplicacao":"nome",
"estVenda":"venda"
}

43

NSString *strUrl = [[NSString stringWithFormat:@"%@&mensagem=%@",


@"cielomobile://pagar?urlCallback=appcliente://retornopagamento", strJson]
stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding];

NSString *requestUrl = [NSString stringWithFormat:@"%@", strUrl];

if ([[UIApplication sharedApplication] canOpenURL:[NSURL URLWithString:requestUrl]]){


[[UIApplication sharedApplication] openURL:[NSURL
URLWithString:requestUrl]];
} else {
[[UIApplication sharedApplication] openURL:[NSURL
URLWithString:@"itmss://itunes.apple.com/br/app/cielo-mobile/id387244876?mt=8"]];
}

Recebimento IOS(Pagamento)

Todas as requisies da chamada externa so processadas pelo mtodo descrito


abaixo. Esse mtodo dever ser implementado na classe AppDelegate.

-(BOOL)application:(UIApplication *)application openURL:(NSURL *)url


sourceApplication:(NSString *)sourceApplication annotation:(id)annotation{

NSString *keyValueDecoded = [keyValuePair


stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];

NSArray *pairComponents = [keyValueDecoded componentsSeparatedByString:@"="];

NSString *key = [pairComponents objectAtIndex:0];

NSString *value = [pairComponents objectAtIndex:1];

[queryStringDictionary setObject:value forKey:key];

44

Validao IOS

A aplicao Cielo Mobile recebe os dados da requisio do Cliente, valida e processa a


requisio. A aplicao parceira recebe o resultado da chamada pela URL de callback que
enviou na requisio. O Cielo Mobile retorna em caso de algum parmetro invlido na
requisio R09, este retorno pela URL de callback.

PList Cadastro URL Callback

A aplicao cliente responsvel por processar o retorno vindo do Cielo Mobile deve
configurar o property list do projeto. A configurao do URL Scheme deve estar de acordo
com o exemplo abaixo. No URL Scheme onde definimos o host da URL de Callback.

OBS.: o nome usado abaixo no item 0 "appcliente" deve ser o mesmo cadastrado no Cielo
Mobile previamente

Exemplo de implementao de um cliente Android

Segue abaixo um exemplo de envio e recebimento de chamadas com o Cielo Mobile. A


String JSON que foi gerada a partir da classe de comunicao entre o aplicativo do cliente e
o Cielo Mobile, deve ser enviada via Intent atravs do mtodo putExtra e com o nome
"MENSAGEM". Conforme exemplo a seguir.

Envio (Pagamento)

Uri uri =
Uri.parse("cielomobile://pagar?urlCallback=appcliente://retornopagamen
to");
String jsonString = "{

45

"valor":"200",
"idTransacao":"1",
"nomeAplicacao":"Aplicacao de Venda",
"referencia":"Venda 123"
}";

Uri.Builder builder = uri.buildUpon();


builder.appendQueryParameter("mensagem", jsonString);
uri = builder.build();

Intent intent = new Intent(Intent.ACTION_VIEW, uri);


startActivityForResult(intent, PAGAMENTO_REQUEST);

Recebimento (Pagamento)

Intent i = getIntent();
Uri uri = i.getData();
String jsonString = uri.getQueryParameter("mensagem");

Validao

A aplicao Cielo Mobile valida os dados de requisio. Por isso, a Intent dever ser iniciada
com o mtodo startActivityForResult.

Esse mtodo retorna para a aplicao parceira o resultado da chamada. Caso o resultado
seja RESULT_OK, a aplicao Cielo Mobile ir continuar com o processamento. Caso seja
diferente de RESULT_OK, o Cielo Mobile no ir continuar com o processamento e a
aplicao de venda dever realizar algum tratamento.

Segue exemplo:

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data)

if (requestCode == PAGAMENTO_REQUEST) {

46

if (resultCode == RESULT_OK) {
txtActivityResult.setText("ActivityResult: OK");
} else if (resultCode == 3) { // URL invalida
Toast.makeText(this, "URL invalida", Toast.LENGTH_SHORT).show();
} else if (resultCode == 2) { // Parametros invalidos
Toast.makeText(this, "Parametro invalido", Toast.LENGTH_SHORT).show();
}
}

super.onActivityResult(requestCode, resultCode, data);


}

Dados de Retorno ActivityResult

Cgido

Descrio

RESULT_OK

A requisio foi feita com sucesso. O Cielo Mobile ir


continuar com o processamento.

Os parmetros enviados esto invlidos.

A URL de callback est invlida.

Android Manifest

A activity responsvel por processar o retorno vindo do Cielo Mobile deve estar configurada
no arquivo AndroidManifest.xml para receber a requisio. Exemplo:

<activity
android:name=".activity.respostas.RespostaPagamentoActivity"
android:label="@string/title_activity_resposta_pagamento" >
<intent-filter>
<data android:host="retornopagamento" android:scheme="appcliente" />
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
</intent-filter>

47

</activity>

Dados de Retorno

Fluxo

Fluxo

Descrio

CRDITO VISTA

CRDITO PARCELADO ADMINISTRATIVO

CRDITO PARCELADO LOJA

DBITO VISTA

DBITO PR-DATADO

10

DBITO VENDA CREDIRIO

11

SIMULAO DE CREDIRIO

13

VISA VALE

28

CANCELAMENTO

Tipo de captura

O tipo de captura possui o formato YYY-E, segundo especificao abaixo.

YYY

Descrio

ONL

Se a transao for Online

OFF

Se a transao for Offline

Descrio

Se a captura do nmero do Carto foi


feita por digitao do embosso

Se a captura do nmero do Carto foi


feita por leitura da tarja magntica

48

Se a captura do nmero do Carto foi


feita por leitura do Chip

Se a captura do nmero do Carto foi


feita sem contato.

Cdigos de Resposta

Cdigo

Descrio

000

Aprovada

Diferente de 000

Negada

Retorno da Aplicao

Cdigo

Descio

R00

Processamento com sucesso

R01

Erro interno

R02

Chamada externa no habilitada

R03

Cielo Mobile Bloqueado

R04

Valor Zerado

R05

Transao no encontrada

R06

Transao existente

R07

Terminal inoperante

R08

Nenhuma rede disponvel

R09

Parmetros Invlidos

R10

Limite mximo de transaes atingido para exportar o


histrico. Dever ser paginado.

R11

Pgina invlida.

R15

A Cielo retornou uma mensagem invlida (MI)

R16

Ocorreu timeout ao se comunicar com a Cielo

R17

Ocorreu timeout ao se comunicar com o Eldorado

R18

Ocorreu um erro interno ao se comunicar com o Eldorado

R19

Ocorreu um timeout ao se comunicar com o pinpad

49

R20

O usurio cancelou a operao pelo pinpad

R21

Ocorreu um erro no esperado ao se comunicar com o pinpad

R22

O usurio cancelou a operao pela aplicao

R23

Ocorreu um erro ao ler a tarja do carto

R24

Operao no permitida

R25

Transao duplicada

R26

O carto do cancelamento foi diferente do usado na ltima


transao

R27

Ocorreu um erro ao ler o carto

R28

O terminal no est habilitado para transacionar com chip

R29

Carto contm chip

R30

Modo Invlido. Fallback no permitido.

R31

Erro inicializao

R32

Erro teste de comunicao

R33

Erro enviar pendentes

R34

Venda digitada no permitida

R35

Produto Matriz Invlido

R36

Produto Secundrio Invlido

R37

EC invlido

R38

Produto Primrio no encontrado

R39

Dados de Venda Invlidos. Nmero de Parcelas Invlido

R40

Dados de Venda Invlidos. Valor Mnimo de Parcelas Invlido

R41

Combinao de Parmetros invlidos

A00

Autorizao Sucesso

D00

Desfazimento Sucesso

50

ORIENTAES FINAIS
muito importante que aps o trmino do desenvolvimento o cliente contate a Central
de Suporte Tcnico para ativar a funcionalidade e garantir que suas vendas sejam
capturadas corretamente. Para isso, necessrio realizar os seguintes procedimentos:

1. Desinstalar o aplicativo utilizado no desenvolvimento (Este procedimento


realizado para garantir que ser feito o download da ltima verso)
2. Fazer download do aplicativo
3. Realizar o desbloqueio com o nmero lgico de produo que ser fornecido pelo
analista de Suporte Tcnico
4. Habilitar a funcionalidade

Central de Suporte Tcnico


4002 9111 Capitais e Regies Metropolitanas
0800 570 0111 Demais Localidades
Todos os dias da semana, 24 horas

51

Вам также может понравиться