Developer Network

Documentação

Informações e instruções das APIs dos produtos Locaweb.

Cielo Buy Page Cielo

O “Cielo Buy Cielo” consiste da captura dos dados do cartão dentro do ambiente da cielo.

O “Cielo Buy Cielo” consiste da captura dos dados do cartão dentro do ambiente da cielo, te isentando de maiores cuidados no tráfego desses dados. Para utilização da Cielo com a captação de dados pela cielo, é necessário que seu contrato com a cielo reflita essa opção, para maiores informações sobre essa modalidade de contrato consulte a documentação acerca da contratação no link: Contratar um Meio de Pagamento.

Esse meio utilizará o conceito de “Url de Acesso” , tendo o fluxo:

  1. ‘Criar transação’
  2. ‘Redirecionar o usuário para a url de acesso’
  3. ‘Receber o usuário de volta na página de Retorno’
  4. ‘Consultar a transação após o retorno do usuário’

Esta modalidade não permite que você envie os dados do cartão , sendo assim o nó “pagamento” a ser enviado não deve conter os dados do cartão(somente a bandeira), ficando parecido com a estrutura abaixo:

1
2
3
4
5
6
"pagamento":{
  "meio_pagamento":"cielo",
  "bandeira": "visa",
  "parcelas":"1",
  "tipo_operacao":"credito_a_vista"
}

Além disso o nó transação deverá conter uma url de retorno para onde o usuário será redirecionado após ter preenchido os dados no ambiente da cielo em caso de sucesso e de erro respectivamente:

URL Retorno

Após o preenchimento dos dados, o usuário será redirecionado para a url_retorno deverá executar a Operação de consulta passando o id da transação, onde terá como retorno o novo status da transação e os dados adicionais:

Exemplo:

1
"url_retorno":"http://www.minha-loja.com/url-retorno"

Requisição/Resposta Cielo Buy Page Cielo:

Segue abaixo um exemplo do corpo da requisição usando o Buy Page Cielo:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
 "token":"3a5bbed0-50d4-012f-8d73-0026bb5a6240",
 "transacao":{
   "url_retorno":"http://www.sualoja.com.br/retorno",
   "capturar":"true",
   "pedido":{
    "numero":"6512",
    "total":"7630.00",
    "moeda":"real",
    "descricao":"Carrinho de Compras"
  },
  "pagamento":{
    "bandeira":"visa",
    "meio_pagamento":"cielo",
    "parcelas":"1",
    "tipo_operacao":"credito_a_vista"
  },
  "comprador":{
    "nome":"Nome do comprador",
    "documento":"12345678900",
    "endereco":"Rua da Casa",
    "complemento":"Ap 82",
    "numero":"1",
    "cep":"09710240",
    "bairro":"Centro",
    "cidade":"São Paulo",
    "estado":"SP"
  }
}

Depois de realizada a criação de uma transação usando Buy Page Cielo, o Gateway de Pagamentos da Locaweb retornará uma resposta semelhante:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "transacao" : {
    "status" : "aguardando_pagamento",
    "meio_pagamento" : "cielo",
    "numero_pedido" : 6512,
    "id" : 163,
    "detalhes" : {
      "arp" : null,
      "lr" : null,
      "nsu" : null,
      "pan" : null,
      "tid" : "10017348980825651001"
    },
    "erro" : null,
    "total" : "7630.00",
    "url_acesso" : "https://qasecommerce.cielo.com.br/web/index.cbmp?id=b817bc2ed8ac0009a1d6dc8199069b27"
  }
}

Visitando a Url de Acesso

Redirecionando o usuário para a url de acesso, o usuário precisara digitar os dados do cartão:

Depois de confirmado a compra será passado o id da transacao na url de retorno passada:

1
http://www.sualoja.com.br/retorno?transacao=163

Com o id da transação sendo passado na url de retorno, você já pode Consultar a transação.

Segue abaixo um exemplo de como seria o retorno da Consulta da Transação:

Concluindo: Após a criação armazene o Id da transação , no caso “163”, e redirecione o usuário da sua loja para a “url_acesso” retornada, que é onde o usuário irá preencher os dados do cartão de crédito.
Quando o usuário for redirecionado para url de retorno você deverá consultar a transação.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "transacao": {
    "status": "paga",
    "meio_pagamento": "cielo",
    "numero_pedido": 6512,
    "id": 163,
    "detalhes": {
      "arp": "765",
      "lr": "57",
      "nsu": "375755",
      "pan": "IqVz7P9zaIgTYdU41HaW/OB/d7Idwttqwb2vaTt8MT0=",
      "tid": "10017348980825651001"
    },
    "erro": null,
    "total": "7630.00",
    "url_acesso": "https://qasecommerce.cielo.com.br/web/index.cbmp?id=b817bc2ed8ac0009a1d6dc8199069b27"
  }
}

Operações de Teste

Para mais detalhes das operações de teste veja Ambiente de Testes

Formato do retorno

O Formato do retorno como todos os outros retornos da API será em formato Json e conterá o seguintes campos:

Campo Descrição
id Identificação da transação no Gateway de Pagamentos da Locaweb.
total Total da Transação criada no Gateway de Pagamentos da Locaweb.
status Status da transação.
url_acesso Url que o usuário precisará ser redirecionado. Esse nó é retornado em alguns casos específicos, como por exemplo quando você configura a Cielo para ser autenticado
meio_pagamento Meio de pagamento utilizado na Transação criada no Gateway de Pagamentos da Locaweb.
detalhes onde retorna informações específicas da Cielo.

Segue abaixo as informações do nó de detalhes da Cielo:

Campo Descrição
tid O TID é o elo de ligação entre o pedido de compra da loja e a transação na Cielo.
nsu Número de sequência da autorização na Cielo.
pan Hash do número do cartão do portador na Cielo.
arp Código da autorização caso a transação tenha sido autorizada com sucesso.
lr Retorno da autorização na Cielo. Quando negada, é o motivo da negação.

Exemplo de Retorno

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "transacao": {
    "id" : 163,
    "status": "paga",
    "meio_pagamento" : "cielo",
    "numero_pedido" : 12345,
    "detalhes" : {
      "arp": "776655",
      "lr": null,
      "nsu": "998877",
      "pan": "887766",
      "tid": "10017348980826441001"
    },
    "erro": null,
    "total": "189.00",
    "url_acesso": "https://qasecommerce.cielo.com.br/web/index.cbmp?id=671387a5190760b7c9e0fa8ccbaf72c4"
  }
}