Guia de Implementao

CIELO Ecommerce

Verso 3.0

Comrcio Eletrnico Locaweb

Autores: Equipe Comrcio Eletrnico

Guia de Implementao

CIELO Ecommerce

________ __

Verso 3.0

http://www.locaweb.com.br comercio@locaweb.com.br Atendimento: http://atendimento.locaweb.com.br/

2010

CIELO Ecommerce

Pgina 1 de 21

Guia de Implementao
CIELO Ecommerce
Sumrio

Verso 3.0

1. Informaes..................................................................................................................... 2. Fluxo bsico com autorizao e captura automticas.................................................... 3. Registro da transao..................................................................................................... 3.1. Retorno XML do Registro da transao..................................................................... 4. Autorizao direta da transao...................................................................................... 4.1. Retorno XML da Autorizao Direta da transao..................................................... 5. Autorizao da transao................................................................................................ 5.1. Retorno XML da Autorizao da transao............................................................... 6. Consulta da transao.................................................................................................... 6.1. Retorno XML da Consulta da transao.................................................................... 7. Captura da transao...................................................................................................... 7.1. Retorno XML da Captura da transao...................................................................... 8. Cancelamento da transao........................................................................................... 8.1. Retorno XML do Cancelamento da transao........................................................... 9. Dados de teste................................................................................................................ 10. Possveis status de transao....................................................................................... 11. Nveis de segurana da transao................................................................................ 12. Possveis retornos de erro............................................................................................

3 4 5 6 8 9 11 11 13 13 16 16 18 18 20 20 20 21

2010

CIELO Ecommerce

Pgina 2 de 21

Guia de Implementao
CIELO Ecommerce
1. Informaes

Verso 3.0

O ambiente CIELO Ecommerce deve ser configurado inicialmente no nosso servidor de Comrcio Eletrnico da Locaweb. Para configur-lo, acesse o painel de controle do Gateway de Pagamentos (entre em http://painel.locaweb.com.br > Servios Contratados > Gateway de Pagamentos > Acessar Painel do Gateway de Pagamentos). A soluo CIELO Ecommerce funciona de forma sncrona, ou seja, na mesma conexo HTTP em que so postados os dados da transao tambm retornado um arquivo XML com o resultado do processo. Para todas as operaes, os dados da transao para o componente da Locaweb ( https://comercio.locaweb.com.br/comercio.comp) devero ser enviados via POST. Uma transao pode ser processada de duas formas: Com os dados do carto sendo capturados em uma pgina da Cielo; Com os dados do carto sendo capturados na pgina da loja e sendo postados ao sistema da Cielo.

Para uso do fluxo com os dados do carto sendo capturados no site da loja, o estabelecimento deve atender a um conjunto de regras definidas pelo programa de segurana da bandeira do carto de crdito. Para Visa, esse programa o AIS (Account Information Security) da Visa. Para mais informaes acesse http://www.cielo.com.br Servios > Servios de Segurana > AIS Programa de Segurana da Informao ou entre em contato com a CIELO atravs de seus canais de atendimento. Para a Mastercard o programa de segurana o SDP (Site Data Protection) PCI. Para maiores informaes acesse http://www.mastercard.com/us/sdp/index.html, ou entre em contato com a CIELO atravs de seus canais de atendimento. Os canais de atendimento da CIELO so: 4002-9700 (opo 1/2) (Capitais e regies metropolitanas) 0800-570-1700 (opo 1/2) (Demais localidades) suporteweb@cielo.com.br

2010

CIELO Ecommerce

Pgina 3 de 21

Guia de Implementao
CIELO Ecommerce
2 . Fluxo bsico com autorizao e captura automticas

Verso 3.0

O diagrama abaixo mostra a sequncia de um fluxo bsico com autorizao e captura automticas, com os dados do carto sendo informados em uma pgina da Cielo .

2010

CIELO Ecommerce

Pgina 4 de 21

Guia de Implementao
CIELO Ecommerce
3. Registro da transao Os parmetros que devero ser passados via POST so:
Parmetro Formato Tamanho Obrigatrio Descrio

Verso 3.0

identificacao

AlfaNum

Cdigo de servio do Gateway de Pagamentos junto Locaweb (disponvel em seu Painel de Controle da Locaweb http://painel.locaweb.com.br/) Nome do mdulo de pagamento utilizado. Utilizar: CIELO Define a ao que ser executada. Utilizar: Registro Define o ambiente a ser usado. Utilizar: TESTE ou PRODUCAO Seis primeiros nmeros do carto. Idioma do pedido. Utilizar: PT (portugus), EN (ingls) ou ES (espanhol) Valor total da transao sem pontuao os ltimos dois dgitos representam sempre os centavos. Utilizar: 100 para R$ 1,00 Nmero do pedido para controle interno da sua loja. Breve descrio do pedido. Bandeira: visa ou mastercard (em minsculo) Forma de pagamento. Utilizar: 1 (Crdito Vista), 2 (Parcelado loja), 3 (Parcelado administradora), A (Dbito) Nmero de parcelas. Para transao vista ou dbito utilizar: 1 Indicador de autorizao automtica. Utilizar: 0 (no autorizar), 1 (autorizar somente se autenticada), 2 (autorizar autenticada e noautenticada), 3 (autorizar sem passar por autenticao vlido somente para crdito) Captura automtica da transao caso seja autorizada. Utilizar: true ou false Campo livre.

modulo

AlfaNum

operacao

AlfaNum

ambiente bin_cartao idioma

AlfaNum Num AlfaNum

6 2

S N N

valor

Num

12

pedido descricao bandeira

AlfaNum AlfaNum AlfaNum

20 1024 -

S N S

forma_pagamento

Num

parcelas

Num

autorizar

Num

capturar campo_livre

AlfaNum AlfaNum

128

S N

Exemplo do registro da transao:

- ASP: registra_transacao.asp - PHP: registra_transacao.php

2010

CIELO Ecommerce

Pgina 5 de 21

Guia de Implementao
CIELO Ecommerce
3.1. Retorno XML do Registro da transao

Verso 3.0

Aps a postagem dos dados para registro da transao, ser retornado um XML com o resultado do processo. Os seguintes parmetros so retornados no XML:
Parmetro tid status Formato AlfaNum Num Tamanho 40 2 Descrio Cdigo de identificao da transao. Status da transao. Ver item 10. Possveis status de transao. URL de redirecionamento a Cielo para processamento da transao.

url-autenticacao

AlfaNum

256

Dados do Pedido (dados-pedido) numero valor moeda data-hora descricao idioma Num Num Num AlfaNum AlfaNum AlfaNum 20 12 3 19 1024 2 Nmero do pedido para controle interno da loja. Valor total da transao. Cdigo numrico da moeda. Data e hora do pedido. Breve descrio do pedido. Idioma do pedido.

Forma de Pagamento (forma-pagamento) bandeira produto parcelas AlfaNum Num Num 1 3 Bandeira. Forma de pagamento. Nmero de parcelas.

Exemplo do XML retornado:

<?xml version="1.0" encoding="iso-8859-1"?> <transacao versao="1.0.0" id="1" xmlns="http://ecommerce.cbmp.com.br"> <tid>10017348980401201001</tid> <dados-pedido> <numero>1</numero> <valor>100</valor> <moeda>986</moeda> <data-hora>2010-04-27T17:49:50.120-03:00</data-hora> <descricao>Pedido de teste</descricao> <idioma>PT</idioma> </dados-pedido> <forma-pagamento> <bandeira>visa</bandeira> <produto>1</produto> <parcelas>1</parcelas> </forma-pagamento> <status>1</status> <urlautenticacao>https://qasecommerce.cielo.com.br/web/index.cbmp?id=d75b93d1edbc1a84fcf71 6ba727c4c5c</url-autenticacao> </transacao>

2010

CIELO Ecommerce

Pgina 6 de 21

Guia de Implementao
CIELO Ecommerce
Caso ocorra algum erro no processo, sero retornados os parmetros:
Parmetro codigo mensagem Formato Num AlfaNum Tamanho Descrio

Verso 3.0

Cdigo do erro. Ver item 12. Possveis retornos de erro. Descrio do erro.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <erro> <codigo>999</codigo> <mensagem>Valor nao deve conter ponto nem virgula. Formato 1000 para R$ 10,00</mensagem> </erro>

IMPORTANTE:
Nessa etapa a transao ser SOMENTE registrada, mas necessrio que a loja faa o redirecionamento do comprador para a URL retornada no parmetro url-autenticacao para que seja de fato processada. Essa URL ser de uma pgina da CIELO onde o comprador informar dos dados do seu carto. Aps o processamento da transao pelo comprador, ocorrer o redirecionamento do mesmo da pgina da CIELO para a URL de retorno da loja. Essa URL de retorno cadastrada em sua configurao CIELO Ecommerce no seu Painel de Gateway de Pagamentos da Locaweb (conforme explicado no item 1. Informaes, deste guia de implementao). No retorno da pgina da CIELO para a URL de retorno da sua loja, por questes de segurana, no ser postado nenhum dado referente transao. Dessa forma, necessrio que sua loja guarde o tid da transao, que foi recebido no XML de retorno no registro da transao, para efetuar a consulta da transao para obter os dados da mesma. Como sugesto de implementao de como armanezar essa informao do tid, voc pode usar variveis de sesso ou cookies. Os detalhes de como fazer a consulta da transao so explicados no item 6. Consulta da transao deste guia de implementao.

2010

CIELO Ecommerce

Pgina 7 de 21

Guia de Implementao
CIELO Ecommerce
4. Autorizao direta da transao

Verso 3.0

A Autorizao Direta da transao uma operao em que os dados do carto sero obtidos em uma interface do lojista para posterior postagem a CIELO. Neste modelo, no ser exibida uma tela da CIELO durante o processo de compra. A utilizao dessa operao SOMENTE ser possvel caso o seu relacionamento junto a CIELO permita esse tipo de transao. Mais informaes entre em contato com seu representante comercial CIELO. Os parmetros que devero ser passados via POST so:
Parmetro Formato Tamanho Obrigatrio Descrio Cdigo de servio do Gateway de Pagamentos junto Locaweb (disponvel em seu Painel de Controle da Locaweb http://painel.locaweb.com.br/) Nome do mdulo de pagamento utilizado. Utilizar: CIELO Define a ao que ser executada. Utilizar: Autorizacao-Direta Define o tipo de ambiente. Utilizar: TESTE ou PRODUCAO Nome impresso no carto. Nmero do carto. Validade do carto. Formato: AAAAMM Indicador do cdigo de segurana do carto. Utilizar: 0 (no informado), 1 (informado), 2 (ilegvel) e 9 (inexistente). Para Mastercard, deve ser sempre 1. Cdigo de segurana do carto. Obrigatrio se indicador do carto for 1. Idioma do pedido. Utilizar: PT (portugus), EN (ingls) ou ES (espanhol) Valor total da transao. Utilizar: 100 para R$ 1,00 Nmero do pedido para controle interno da loja. Breve descrio do pedido. Bandeira: visa ou mastercard (em minsculo) Forma de pagamento. Utilizar: 1 (Crdito Vista), 2 (Parcelado loja), 3 (Parcelado administradora), A (Dbito) Nmero de parcelas. Para transao vista ou dbito utilizar: 1 Captura automtica da transao caso seja autorizada. Utilizar: true ou false Campo livre.

identificacao

AlfaNum

modulo

AlfaNum

operacao

AlfaNum

ambiente nome_portador_cartao numero_cartao validade_cartao

AlfaNum AlfaNum Num Num

50 16 6

S S S S

indicador_cartao

Num

codigo_seguranca_cartao

Num

idioma

AlfaNum

valor

Num

12

pedido descricao bandeira

AlfaNum AlfaNum AlfaNum

20 1024 -

S N S

forma_pagamento

Num

parcelas

Num

capturar campo_livre

AlfaNum AlfaNum

128

S N

2010

CIELO Ecommerce

Pgina 8 de 21

Guia de Implementao
CIELO Ecommerce
Exemplo do autorizao direta da transao:
- ASP: autorizacao_direta_transacao.asp - PHP: autorizacao_direta_transacao.php

Verso 3.0

4.1. Retorno XML da Autorizao Direta da transao Aps a postagem dos dados para autorizao direta da transao, ser retornado um XML com o resultado do processo. Os seguintes parmetros so retornados no XML:
Parmetro tid pan status Formato AlfaNum AlfaNum Num Tamanho 40 40 2 Descrio Cdigo de identificao da transao. Hash do nmero do carto do portador. Status da transao. Ver item 10. Possveis status de transao. URL de redirecionamento a Cielo para processamento da transao.

url-autenticacao

AlfaNum

256

Dados do Pedido (dados-pedido) numero valor moeda data-hora descricao idioma Num Num Num AlfaNum AlfaNum AlfaNum 20 12 3 19 1024 2 Nmero do pedido para controle interno da loja. Valor total da transao. Cdigo numrico da moeda. Data e hora do pedido. Breve descrio do pedido. Idioma do pedido.

Forma de Pagamento (forma-pagamento) bandeira produto parcelas AlfaNum Num Num 1 3 Bandeira. Forma de pagamento. Nmero de parcelas.

Autenticao (autenticacao) codigo mensagem data-hora valor eci Num AlfaNum AlfaNum Num Num 2 100 19 12 2 Cdigo do processamento. Detalhe do processamento. Data hora do processamento. Valor do processamento sem pontuao. Nvel de segurana da transao. Ver item 11. Nveis de segurana da transao.

Autorizao (autorizacao) codigo mensagem data-hora valor Num AlfaNum AlfaNum Num 2 100 19 12 Cdigo do processamento. Detalhe do processamento. Data hora do processamento. Valor do processamento sem pontuao.

2010

CIELO Ecommerce

Pgina 9 de 21

Guia de Implementao
CIELO Ecommerce
lr arp Num AlfaNum 2 6 Retorno da autorizao.

Verso 3.0

Cdigo da autorizao caso a transao tenha sido autorizada com sucesso.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <transacao versao="1.0.0" id="1" xmlns="http://ecommerce.cbmp.com.br"> <tid>10017348980401251001</tid> <pan>34353531383730303030303030313833</pan> <dados-pedido> <numero>5</numero> <valor>100</valor> <moeda>986</moeda> <data-hora>2010-04-27T18:34:10.427-03:00</data-hora> <descricao>Pedido de teste</descricao> <idioma>PT</idioma> </dados-pedido> <forma-pagamento> <bandeira>visa</bandeira> <produto>1</produto> <parcelas>1</parcelas> </forma-pagamento> <status>9</status> <autenticacao> <codigo>9</codigo> <mensagem>Transacao sem autenticacao</mensagem> <data-hora>2010-04-27T18:35:00.454-03:00</data-hora> <valor>100</valor> <eci>7</eci> </autenticacao> <autorizacao> <codigo>9</codigo> <mensagem>Transao autorizada</mensagem> <data-hora>2010-04-27T18:35:00.502-03:00</data-hora> <valor>100</valor> <lr>00</lr> <arp>183501</arp> </autorizacao> <urlautenticacao>https://qasecommerce.cielo.com.br/web/index.cbmp?id=339986bdf7f744911638a 302b4fc4854</url-autenticacao> </transacao>

Caso ocorra algum erro no processo sero retornados os parmetros:

Parmetro codigo mensagem Formato Num AlfaNum Tamanho Descrio Cdigo do erro. Ver item 12. Possveis retornos de erro. Descrio do erro.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <erro> <codigo>999</codigo> <mensagem>Valor nao deve conter ponto nem virgula. Formato 1000 para R$ 10,00</mensagem> </erro>

2010

CIELO Ecommerce

Pgina 10 de 21

Guia de Implementao
CIELO Ecommerce
5. Autorizao da transao

Verso 3.0

A Autorizao da transao uma operao que poder ser feita inmeras vezes. Este processo retornar todos os dados referentes transao autorizada. Os parmetros que devero ser passados via POST so:
Parmetro Formato Tamanho Obrigatrio Descrio Cdigo de servio do Gateway de Pagamentos junto Locaweb (disponvel em seu Painel de Controle da Locaweb http://painel.locaweb.com.br/) Nome do mdulo de pagamento utilizado. Utilizar: CIELO Define a ao que ser executada. Utilizar: Autorizacao Define o tipo de ambiente. Utilizar: TESTE ou PRODUCAO Cdigo de identificao da transao.

identificacao

AlfaNum

modulo

AlfaNum

operacao

AlfaNum

ambiente tid

AlfaNum AlfaNum

40

S S

Exemplo da autorizao da transao:

- ASP: autorizacao_transacao.asp - PHP: autorizacao_transacao.php

5.1. Retorno XML da Autorizao da transao Aps a postagem dos dados para autorizao da transao ser retornado um XML com o resultado do processo. Os seguintes parmetros so retornados no XML:
Parmetro tid pan status Formato AlfaNum AlfaNum Num Tamanho 40 40 2 Descrio Cdigo de identificao da transao. Hash do nmero do carto do portador. Status da transao. Ver item 10. Possveis status de transao. URL de redirecionamento a Cielo para processamento da transao.

url-autenticacao

AlfaNum

256

Dados do Pedido (dados-pedido) numero valor moeda data-hora descricao idioma Num Num Num AlfaNum AlfaNum AlfaNum 20 12 3 19 1024 2 Nmero do pedido para controle interno da loja. Valor total da transao. Cdigo numrico da moeda. Data e hora do pedido. Breve descrio do pedido. Idioma do pedido.

Forma de Pagamento (forma-pagamento) bandeira AlfaNum Bandeira.

2010

CIELO Ecommerce

Pgina 11 de 21

Guia de Implementao
CIELO Ecommerce
produto parcelas Autorizao (autorizacao) codigo mensagem data-hora valor lr arp Num AlfaNum AlfaNum Num Num AlfaNum 2 100 19 12 2 6 Cdigo do processamento. Detalhe do processamento. Data hora do processamento. Valor do processamento sem pontuao. Retorno da autorizao. Num Num 1 3 Forma de pagamento. Nmero de parcelas.

Verso 3.0

Cdigo da autorizao caso a transao tenha sido autorizada com sucesso.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <transacao versao="1.0.0" id="1" xmlns="http://ecommerce.cbmp.com.br"> <tid>10017348980401251001</tid> <pan>34353531383730303030303030313833</pan> <dados-pedido> <numero>5</numero> <valor>100</valor> <moeda>986</moeda> <data-hora>2010-04-27T18:34:10.427-03:00</data-hora> <descricao>Pedido de teste</descricao> <idioma>PT</idioma> </dados-pedido> <forma-pagamento> <bandeira>visa</bandeira> <produto>1</produto> <parcelas>1</parcelas> </forma-pagamento> <status>9</status> <autorizacao> <codigo>9</codigo> <mensagem>Transao autorizada</mensagem> <data-hora>2010-04-27T18:35:00.502-03:00</data-hora> <valor>100</valor> <lr>00</lr> <arp>183501</arp> </autorizacao> <urlautenticacao>https://qasecommerce.cielo.com.br/web/index.cbmp?id=339986bdf7f744911638a 302b4fc4854</url-autenticacao> </transacao>

Caso ocorra algum erro no processo sero retornados os parmetros:

Parmetro codigo mensagem Formato Num AlfaNum Tamanho Descrio Cdigo do erro. Ver item 12. Possveis retornos de erro. Descrio do erro.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <erro> <codigo>999</codigo> <mensagem>Valor nao deve conter ponto nem virgula. Formato 1000 para R$ 10,00</mensagem> </erro>

2010

CIELO Ecommerce

Pgina 12 de 21

Guia de Implementao
CIELO Ecommerce
6. Consulta da transao

Verso 3.0

A Consulta uma operao que poder ser feita inmeras vezes. Este processo retornar todos os dados referentes transao consultada. Os parmetros que devero ser passados via POST so:
Parmetro Formato Tamanho Obrigatrio Descrio Cdigo de servio do Gateway de Pagamentos junto Locaweb (disponvel em seu Painel de Controle da Locaweb http://painel.locaweb.com.br/) Nome do mdulo de pagamento utilizado. Utilizar: CIELO Define a ao que ser executada. Utilizar: Consulta Define o tipo de ambiente. Utilizar: TESTE ou PRODUCAO Cdigo de identificao da transao.

identificacao

AlfaNum

modulo

AlfaNum

operacao

AlfaNum

ambiente tid

AlfaNum AlfaNum

40

S S

Exemplo da consulta da transao:

- ASP: consulta_transacao.asp - PHP: consulta_transacao.php

6.1. Retorno XML da Consulta da transao Aps a postagem dos dados para consulta da transao ser retornado um XML com o resultado do processo. Os seguintes parmetros so retornados no XML:
Parmetro tid pan status Formato AlfaNum AlfaNum Num Tamanho 40 40 2 Descrio Cdigo de identificao da transao. Hash do nmero do carto do portador. Status da transao. Ver item 10. Possveis status de transao. URL de redirecionamento a Cielo para processamento da transao.

url-autenticacao

AlfaNum

256

Dados do Pedido (dados-pedido) numero valor moeda data-hora descricao idioma Num Num Num AlfaNum AlfaNum AlfaNum 20 12 3 19 1024 2 Nmero do pedido para controle interno da loja. Valor total da transao. Cdigo numrico da moeda. Data e hora do pedido. Breve descrio do pedido. Idioma do pedido.

Forma de Pagamento (forma-pagamento) bandeira AlfaNum Bandeira.

2010

CIELO Ecommerce

Pgina 13 de 21

Guia de Implementao
CIELO Ecommerce
produto parcelas Num Num 1 3 Forma de pagamento. Nmero de parcelas.

Verso 3.0

Autenticao (autenticacao) codigo mensagem data-hora valor eci Num AlfaNum AlfaNum Num Num 2 100 19 12 2 Cdigo do processamento. Detalhe do processamento. Data hora do processamento. Valor do processamento sem pontuao. Nvel de segurana da transao. Ver item 11. Nveis de segurana da transao.

Autorizao (autorizacao) codigo mensagem data-hora valor lr arp Num AlfaNum AlfaNum Num Num AlfaNum 2 100 19 12 2 6 Cdigo do processamento. Detalhe do processamento. Data hora do processamento. Valor do processamento sem pontuao. Retorno da autorizao. Cdigo da autorizao caso a transao tenha sido autorizada com sucesso.

Captura (captura) codigo mensagem data-hora valor Num AlfaNum AlfaNum Num 2 100 19 12 Cdigo do processamento. Detalhe do processamento. Data hora do processamento. Valor do processamento sem pontuao.

Cancelamento (cancelamento) codigo mensagem data-hora valor Num AlfaNum AlfaNum Num 2 100 19 12 Cdigo do processamento. Detalhe do processamento. Data hora do processamento. Valor do processamento sem pontuao.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <transacao versao="1.0.0" id="1" xmlns="http://ecommerce.cbmp.com.br"> <tid>10017348980401251001</tid> <pan>34353531383730303030303030313833</pan> <dados-pedido> <numero>5</numero> <valor>100</valor> <moeda>986</moeda> <data-hora>2010-04-27T18:34:10.427-03:00</data-hora> <descricao>Pedido de teste</descricao> <idioma>PT</idioma> </dados-pedido> <forma-pagamento> <bandeira>visa</bandeira> <produto>1</produto> <parcelas>1</parcelas>

2010

CIELO Ecommerce

Pgina 14 de 21

Guia de Implementao
CIELO Ecommerce

Verso 3.0

</forma-pagamento> <status>9</status> <autenticacao> <codigo>9</codigo> <mensagem>Transacao sem autenticacao</mensagem> <data-hora>2010-04-27T18:35:00.454-03:00</data-hora> <valor>100</valor> <eci>7</eci> </autenticacao> <autorizacao> <codigo>9</codigo> <mensagem>Transao autorizada</mensagem> <data-hora>2010-04-27T18:35:00.502-03:00</data-hora> <valor>100</valor> <lr>00</lr> <arp>183501</arp> </autorizacao> <captura> <codigo>9</codigo> <mensagem>Transacao capturada com sucesso</mensagem> <data-hora>2010-04-27T18:36:09.025-03:00</data-hora> <valor>100</valor> </captura> <cancelamento> <codigo>9</codigo> <mensagem>Transacao cancelada com sucesso</mensagem> <data-hora>2010-04-27T18:37:54.591-03:00</data-hora> <valor>100</valor> </cancelamento> <urlautenticacao>https://qasecommerce.cielo.com.br/web/index.cbmp?id=339986bdf7f744911638a 302b4fc4854</url-autenticacao> </transacao>

Caso ocorra algum erro no processo sero retornados os parmetros:

Parmetro codigo mensagem Formato Num AlfaNum Tamanho Descrio Cdigo do erro. Ver item 12. Possveis retornos de erro. Descrio do erro.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <erro> <codigo>999</codigo> <mensagem>Valor nao deve conter ponto nem virgula. Formato 1000 para R$ 10,00</mensagem> </erro>

2010

CIELO Ecommerce

Pgina 15 de 21

Guia de Implementao
CIELO Ecommerce
7. Captura da transao

Verso 3.0

A Captura uma operao necessria SOMENTE quando na transao o parmetro capturar foi enviado com o valor false e tenha sido aprovada. Este procedimento libera a Visanet de emitir a cobrana para o emissor do carto. A captura deve ser feita em at 5 dias (corridos) aps a transao. Caso isso no ocorra, a transao ser cancelada automaticamente pela operadora. Aps a postagem dos dados para captura da transao ser retornado um XML com o resultado do processo. Os parmetros que devero ser passados via POST so:
Parmetro Formato Tamanho Obrigatrio Descrio Cdigo de servio do Gateway de Pagamentos junto Locaweb (disponvel em seu Painel de Controle da Locaweb http://painel.locaweb.com.br/) Nome do mdulo de pagamento utilizado. Utilizar: CIELO Define a ao que ser executada. Utilizar: Captura Define o tipo de ambiente. Utilizar: TESTE ou PRODUCAO Cdigo de identificao da transao. Valor da transao que ser capturado. Utilizar: 100 para R$ 1,00 Campo livre.

identificacao

AlfaNum

modulo

AlfaNum

operacao

AlfaNum

ambiente tid valor campo_livre

AlfaNum AlfaNum Num AlfaNum

40 12 128

S S N N

Exemplo da captura da transao:

- ASP: captura_transacao.asp - PHP: captura_transacao.php 7.1. Retorno XML da Captura da transao Aps a postagem dos dados para captura da transao ser retornado um XML com o resultado do processo. Os seguintes parmetros so retornados no XML:
Parmetro tid pan status Formato AlfaNum AlfaNum Num Tamanho 40 40 2 Descrio Cdigo de identificao da transao. Hash do nmero do carto do portador. Status da transao. Ver item 10. Possveis status de transao. URL de redirecionamento a Cielo para processamento da transao.

url-autenticacao

AlfaNum

256

Dados do Pedido (dados-pedido) numero valor moeda data-hora Num Num Num AlfaNum 20 12 3 19 Nmero do pedido para controle interno da loja. Valor total da transao. Cdigo numrico da moeda. Data e hora do pedido.

2010

CIELO Ecommerce

Pgina 16 de 21

Guia de Implementao
CIELO Ecommerce
descricao idioma AlfaNum AlfaNum 1024 2 Breve descrio do pedido. Idioma do pedido.

Verso 3.0

Forma de Pagamento (forma-pagamento) bandeira produto parcelas Captura (captura) codigo mensagem data-hora valor Num AlfaNum AlfaNum Num 2 100 19 12 Cdigo do processamento. Detalhe do processamento. Data hora do processamento. Valor do processamento sem pontuao. AlfaNum Num Num 1 3 Bandeira. Forma de pagamento. Nmero de parcelas.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <transacao versao="1.0.0" id="1" xmlns="http://ecommerce.cbmp.com.br"> <tid>10017348980401251001</tid> <pan>34353531383730303030303030313833</pan> <dados-pedido> <numero>5</numero> <valor>100</valor> <moeda>986</moeda> <data-hora>2010-04-27T18:34:10.427-03:00</data-hora> <descricao>Pedido de teste</descricao> <idioma>PT</idioma> </dados-pedido> <forma-pagamento> <bandeira>visa</bandeira> <produto>1</produto> <parcelas>1</parcelas> </forma-pagamento> <status>9</status> <captura> <codigo>9</codigo> <mensagem>Transacao capturada com sucesso</mensagem> <data-hora>2010-04-27T18:36:09.025-03:00</data-hora> <valor>100</valor> </captura> <urlautenticacao>https://qasecommerce.cielo.com.br/web/index.cbmp?id=339986bdf7f744911638a 302b4fc4854</url-autenticacao> </transacao>

Caso ocorra algum erro no processo sero retornados os parmetros:

Parmetro codigo mensagem Formato Num AlfaNum Tamanho Descrio Cdigo do erro. Ver item 12. Possveis retornos de erro. Descrio do erro.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <erro> <codigo>999</codigo> <mensagem>Valor nao deve conter ponto nem virgula. Formato 1000 para R$ 10,00</mensagem> </erro>

2010

CIELO Ecommerce

Pgina 17 de 21

Guia de Implementao
CIELO Ecommerce
8. Cancelamento da transao

Verso 3.0

O Cancelamento uma ao opcional para as transaes aprovadas. Este procedimento notifica a Visanet para no emitir a cobrana ao emissor do carto. O cancelamento deve ser feito em at 24 horas aps a transao, passado esse prazo somente poder ser feito junto operadora. Aps a postagem dos dados para cancelamento da transao, ser retornado um XML com o resultado do processo. Os parmetros que devero ser passados via POST so:
Parmetro Formato Tamanho Obrigatrio Descrio Cdigo de servio do Gateway de Pagamentos junto Locaweb (disponvel em seu Painel de Controle da Locaweb http://painel.locaweb.com.br/) Nome do mdulo de pagamento utilizado. Utilizar: CIELO Define a ao que ser executada. Utilizar: Cancelamento Define o tipo de ambiente. Utilizar: TESTE ou PRODUCAO Cdigo de identificao da transao.

identificacao

AlfaNum

modulo

AlfaNum

operacao

AlfaNum

ambiente tid

AlfaNum AlfaNum

40

S S

Exemplo do cancelamento da transao:

- ASP: cancelamento_transacao.asp - PHP: cancelamento_transacao.php 8.1. Retorno XML do Cancelamento da transao Aps a postagem dos dados para cancelamento da transao, ser retornado um XML com o resultado do processo. Os seguintes parmetros so retornados no XML:
Parmetro tid pan status Formato AlfaNum AlfaNum Num Tamanho 40 40 2 Descrio Cdigo de identificao da transao. Hash do nmero do carto do portador. Status da transao. Ver item 10. Possveis status de transao. URL de redirecionamento a Cielo para processamento da transao.

url-autenticacao

AlfaNum

256

Dados do Pedido (dados-pedido) numero valor moeda data-hora descricao idioma Num Num Num AlfaNum AlfaNum AlfaNum 20 12 3 19 1024 2 Nmero do pedido para controle interno da loja. Valor total da transao. Cdigo numrico da moeda. Data e hora do pedido. Breve descrio do pedido. Idioma do pedido.

2010

CIELO Ecommerce

Pgina 18 de 21

Guia de Implementao
CIELO Ecommerce
Forma de Pagamento (forma-pagamento) bandeira produto parcelas AlfaNum Num Num 1 3 Bandeira. Forma de pagamento. Nmero de parcelas.

Verso 3.0

Cancelamento (cancelamento) codigo mensagem data-hora valor Num AlfaNum AlfaNum Num 2 100 19 12 Cdigo do processamento. Detalhe do processamento. Data hora do processamento. Valor do processamento sem pontuao.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <transacao versao="1.0.0" id="1" xmlns="http://ecommerce.cbmp.com.br"> <tid>10017348980401251001</tid> <pan>34353531383730303030303030313833</pan> <dados-pedido> <numero>5</numero> <valor>100</valor> <moeda>986</moeda> <data-hora>2010-04-27T18:34:10.427-03:00</data-hora> <descricao>Pedido de teste</descricao> <idioma>PT</idioma> </dados-pedido> <forma-pagamento> <bandeira>visa</bandeira> <produto>1</produto> <parcelas>1</parcelas> </forma-pagamento> <status>9</status> <cancelamento> <codigo>9</codigo> <mensagem>Transacao cancelada com sucesso</mensagem> <data-hora>2010-04-27T18:37:54.591-03:00</data-hora> <valor>100</valor> </cancelamento> <urlautenticacao>https://qasecommerce.cielo.com.br/web/index.cbmp?id=339986bdf7f744911638a 302b4fc4854</url-autenticacao> </transacao>

Caso ocorra algum erro no processo sero retornados os parmetros:

Parmetro codigo mensagem Formato Num AlfaNum Tamanho Descrio Cdigo do erro. Ver item 12. Possveis retornos de erro. Descrio do erro.

Exemplo do XML retornado:

<?xml version="1.0" encoding="ISO-8859-1"?> <erro> <codigo>999</codigo> <mensagem>Valor nao deve conter ponto nem virgula. Formato 1000 para R$ 10,00</mensagem> </erro>

2010

CIELO Ecommerce

Pgina 19 de 21

Guia de Implementao
CIELO Ecommerce
9. Dados de teste

Verso 3.0

Para realizar seus testes, utilize os dados abaixo no ambiente de testes (estes dados funcionaro apenas neste ambiente): Dados para configurao de teste em seu Painel de Controle do Comrcio Eletrnico: Afiliao: 1001734898 Chave: e84827130b9837473681c2787007da5914d6359947015a5cdb2b8843db0fa832 Afiliao para autorizao direta: 1006993069 Chave para autorizao direta: 25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3 Dados de carto de teste: Carto com autenticao: 4012 0010 3714 1112 (visa) Carto sem autenticao: 4551 8700 0000 0183 (visa), 5453 0100 0006 6167 (mastercard) Data de validade: qualquer combinao posterior a data atual Cdigo de segurana: qualquer combinao de 3 dgitos Valor do pedido: para simular transao autorizada, use qualquer valor em que os dois ltimos dgitos sejam zeros. Do contrrio, toda autorizao ser negada.

IMPORTANTE: Para simular uma transao autorizada, necessrio que no valor da transao os
dois ltimos dgitos seja 0. Do contrrio, toda autorizao ser negada.

10. Possveis status de transao

Cdigo 0 1 2 3 4 5 6 8 9 10 Criada Em andamento Autenticada No autenticada Autorizada ou pendente de captura No autorizada Capturada No capturada Cancelada Em autenticao Erro

11. Nveis de segurana da transao

Resultado da autenticao Portador autenticado com sucesso Portador no realizou autenticao, pois o Emissor no forneceu mecanismos de autenticao Portador no se autenticou com sucesso ou a loja optou por autorizar sem passar pela autenticao Visa 5 6 Mastercard 2 1

2010

CIELO Ecommerce

Pgina 20 de 21

Guia de Implementao
CIELO Ecommerce
12. Possveis retornos de erro
Cdigo 001 002 003 010 Erro Mensagem invlida Credenciais invlidas Transao inexistente Inconsistncia no envio do carto Descrio

Verso 3.0

A mensagem XML est fora do formato especificado pelo arquivo ecommerce.xsd Impossibilidade de autenticar uma requisio da loja virtual. No existe transao para o identificador informado A transao, com ou sem carto, est divergente com a permisso do envio dessa informao A transao est configurada com uma modalidade de pagamento no habilitada para a loja O nmero de parcelas solicitado ultrapassa o mximo permitido No permitido realizar autorizao para o status da transao No permitido realizar autorizao, pois o prazo est vencido EC no possui permisso para realizar a autorizao A captura no pode ser realizada, pois a transao no est autorizada A captura no pode ser realizada, pois o prazo para captura est vencido O valor solicitado para captura no vlido No foi possvel realizar a captura O cancelamento no pode ser realizado, pois o prazo est vencido O atual status da transao no permite cancelamento No foi possvel realizar o cancelamento Falha no sistema

011 012 020 021 022 030

Modalidade no habilitada Nmero de parcelas invlido Status no permite autorizao Prazo de autorizao vencido EC no autorizado Transao no autorizada para captura Prazo de captura vencido Valor de captura invlido Falha ao capturar Prazo de cancelamento vencido Status no permite cancelamento Falha ao cancelar Erro inesperado

031 032 033 040 041 042 099

2010

CIELO Ecommerce

Pgina 21 de 21