Developer Network

Documentação

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

Informações Iniciais

Entenda como consultamos transações no Gateway de pagamentos

Endpoint – Produção

Segue abaixo as informações de verbo HTTP e URI:

Verbo HTTP URI produção
GET https://api.gatewaylocaweb.com.br/v1/transacao/:id

OBS.: No “:id” você precisará passar o id da transação que você deseja consultar.

Endpoint – Ambiente de Testes (Sandbox)

Segue abaixo as informações de verbo HTTP e URI:

Verbo HTTP URI Sandbox
GET https://api-sandbox.gatewaylocaweb.com.br/v1/transacao/:id

OBS.: No “:id” você precisará passar o id da transação que você deseja consultar.

Dados da requisição – Estrutura

O Id da transação será passado no próprio endereço, portanto, o único dado necessário é o token.

Essa é a única transação executada via GET nesta API , os dados deverão ser enviados como parâmetros na própria URL.

Campos que necessitam ser enviados como parâmetros:

Campo Descrição
token Campo que contem o token do gateway que identifica o usuário.

Exemplo do corpo da Requisição

Exemplo já em formato de pârametro.

Nos exemplos abaixo o “id” da transação retornado na criação é 150.

1
token=3a5bbed0-50d4-012f-8d73-0026bb5a6240
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
30
31
32
33
34
35
curl 'https://api.gatewaylocaweb.com.br/v1/transacao' \
-H "Content-Type: application/json" \
-d '{
 "token":"3a5bbed0-50d4-012f-8d73-0026bb5a6240",
 "transacao":{
   "url_retorno":"http://www.minha-loja.com.br/confirmacao-pedido.php?id=12345",
   "capturar":"true",
   "pedido":{
      "numero":"123",
      "total":"100.00",
      "moeda":"real",
      "descricao":"An African or European swallow?"
   },
   "pagamento":{
      "bandeira":"visa",
      "meio_pagamento":"redecard_ws",
      "cartao_numero":"4012001037141112",
      "cartao_cvv":"973",
      "cartao_validade":"082015",
      "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"
   }
 }
}'
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
30
31
32
<?php
  $transacao = LocawebGateway::criar(array(
    'url_retorno' => 'http://www.minha-loja.com.br/confirmacao-pedido.php?id=12345',
    'capturar' => 'true',
    'pedido' => array(
      'numero' => "123",
      'total' => "100.00",
      'moeda' => "real",
      'descricao' => "Carrinho de Compras"
    ),
    'pagamento' => array(
      'meio_pagamento' => 'redecard_ws',
      'bandeira' => "visa",
      'cartao_numero' => "4012001037141112",
      'cartao_cvv' => "973",
      'parcelas' => "1",
      'tipo_operacao' => "credito_a_vista",
      'cartao_validade' => "082015"
    ),
    'comprador' => array(
      'nome' => "Nome do comprador",
      'documento' => "27836038881",
      'endereco' => "Rua da Casa",
      'numero' => "1",
      'cep' => "09710240",
      'bairro' => "Centro",
      'cidade' => "São Paulo",
      'estado' => "SP"
    )
  ))->sendRequest();
  var_dump($transacao);
?>
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<!-- #include file="locaweb/LocawebGateway.asp" -->
<%
  Set cielo = New LocawebGatewayTransacaoDados

  With cielo
    .UrlRetorno = "http://www.sualoja.com.br/retorno"
    .Capturar = True

    .PedidoNumero = "987654"
    .PedidoTotal = 123.45
    .PedidoMoeda = "real"
    .PedidoDescricao = "Bola de Basquete Never Flat Spalding (1)"

    .PagamentoMeioPagamento = "cielo"
    .PagamentoBandeira = "Visa"
    .PagamentoCartaoNumero = "4012001037141112"
    .PagamentoCartaoCvv = "123"
    .PagamentoCartaoValidade = "082015"
    .PagamentoTipoOperacao = "credito_a_vista"
    .PagamentoParcelas = 1

    .CompradorNome = "Pedro Bonamides"
    .CompradorDocumento = "1234568909"
    .CompradorEndereco = "Rua Itapaiúna"
    .CompradorNumero = "5434"
    .CompradorBairro = "Jardim Morumbi"
    .CompradorCidade = "São Paulo"
    .CompradorEstado = "SP"
    .CompradorCEP = "05707-001"
  End With

  Set gateway = New LocawebGateway
  Set transacao = gateway.Criar(cielo)

  If transacao.TemErro Then
    Response.Write("Erros encontrados<br />")
    Response.Write("Código de erro: " & transacao.ErroCodigo & "<br />")
    Response.Write("Mensagem de erro: " & transacao.ErroMensagem & "<br />")
  Else
    Response.Write("Dados da transação<br />")
    Response.Write("ID: " & transacao.ID & "<br />")
    Response.Write("Status: " & transacao.Status & "<br />")
    Response.Write("Número do pedido: " & transacao.NumeroPedido & "<br />")
    Response.Write("Meio de pagamento: " & transacao.MeioPagamento & "<br />")
    Response.Write("URL de acesso: " & transacao.UrlAcesso & "<br />")
    Response.Write("Detalhes: <br />")

    'A propriedade Detalhes é um objeto do tipo "Scripting.Dictionary".'
    'As chaves do dicionário variam de acordo com o meio de pagamento da transação.'
    Dim key : For Each key In transacao.Detalhes.keys()
        Response.Write("- " & key & ": " & transacao.Detalhes(key) & "<br />")
    Next
  End If

  'Sempre libere os recursos dos objetos após utilizá-los.'
  Set cielo = Nothing
  Set transacao = Nothing
  Set gateway = Nothing
%>
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
30
require 'locaweb-gateway'
  transacao = Locaweb::Gateway.criar(
    :url_retorno => 'http://foo.com/sucesso_pedido.php?pedido=12345',
    :capturar => true,
    :pedido => {
      :numero => "123",
      :total => "100.00",
      :moeda => :real,
      :descricao => "Carrinho de Compras"
    },
    :pagamento => {
      :meio_pagamento => :redecard_ws,
      :bandeira => :visa,
      :cartao_numero => "4012001037141112",
      :cartao_cvv => "973",
      :parcelas => "1",
      :tipo_operacao => "credito_a_vista",
      :cartao_validade => "082015"
    },
    :comprador => {
      :nome => "Nome do comprador",
      :documento => "12345678900",
      :endereco => "Rua da Casa",
      :numero => "23",
      :cep => "09710240",
      :bairro => "Centro",
      :cidade => "São Paulo",
      :estado => "SP"
    }
  )
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
30
from locaweb_gateway import LocawebGateway
  transacao = LocawebGateway.criar({
    "url_retorno": 'http://foo.com/sucesso_pedido.php?pedido=12345',
    "capturar": True,
    "pedido": {
      "numero": "123",
      "total": "100.00",
      "moeda":  "real",
      "descricao": "Carrinho de Compras"
    },
    "pagamento": {
      "meio_pagamento": "redecard_ws",
      "bandeira": "visa",
      "cartao_numero": "4012001037141112",
      "cartao_cvv": "973",
      "parcelas": "1",
      "tipo_operacao": "credito_a_vista",
      "cartao_validade": "082015"
    },
    "comprador": {
      "nome": "Nome do comprador",
      "documento": "12345678900",
      "endereco": "Rua da Casa",
      "numero": "23",
      "cep": "09710240",
      "bairro": "Centro",
      "cidade": u"São Paulo",
      "estado": "SP"
    }
  })

Exemplo de Retorno

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "transacao": {
    "id": 314,
    "status": "paga",
    "meio_pagamento": "redecard_ws",
    "numero_pedido": 123,
    "total": "100.00",
    "detalhes": {
      "numero_sequencial": "948",
      "numero_comprovante_venda": "7227",
      "numero_autenticacao": "9002",
      "numero_autorizacao": "4243",
      "url_comprovante": "https://ecommerce.redecard.com.br/pos_virtual/cupom.asp?DATA=20120306&TRANSACAO=201&NUMAUTOR=4243&NUMCV=7227&FILIACAO=1234567890"
    },
    "erro": null
  }
}