Criar transação
Endpoint - Produção
Segue abaixo as informações de verbo HTTP e URI:
Verbo HTTP |
URI produção |
POST |
https://api.gatewaylocaweb.com.br/v1/transacao/ |
Endpoint - Ambiente de Testes (Sandbox)
Segue abaixo as informações de verbo HTTP e URI:
Verbo HTTP |
URI Sandbox |
POST |
https://api-sandbox.gatewaylocaweb.com.br/v1/transacao/ |
Exemplo de corpo da Requisição
Exemplo do corpo já em formato JSON que é o formato recebido pelo gateway.
{
"token":"3a5bbed0-50d4-012f-8d73-0026bb5a6240",
"transacao":{
"url_retorno":"http://www.sualoja.com.br/retorno",
"capturar":"true",
"pedido":{
"numero":"123",
"total":"100.00",
"moeda":"real",
"descricao":"Camisa Xadrez"
},
"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"
}
}
}
Detalhes dos campos
Nome do Parâmetro |
Descrição |
token |
Campo contendo o seu token do gateway que irá identificá-lo. |
url_retorno |
Campo contendo a url a de retorno para Cielo buy-page e Itau Shopline |
capturar |
Campo contendo “true” ou “false” definindo se a captura deve ocorrer
automaticamente. Default: "true" |
pedido |
Nó
com as informações do pedido |
pagamento |
Nó
com as informações do pagamento. |
comprador |
Nó
contendo Informações do comprador. |
Nó de Pedido
Campo |
Descrição |
numero |
Número do pedido. |
descricao |
Descrição do pedido. |
total |
Valor total da compra em formato “NNNN.DD” ex: (1250.25). |
moeda |
Moeda a ser utilizada na transação (Apenas cielo suporta moeda estrangeira). |
Nó de Pagamento
Campo |
Descrição |
meio_pagamento |
Convênio a ser utilizado nas transações. Mais detalhes na tabela ( Tabela Meios de Pagamento ). |
data_vencimento |
Campo para informar a data do vencimento em caso de boleto, o formato esperado é "DDMMYYYY". |
bandeira |
Bandeira do cartão utilizado ex.: 'visa' , 'master', 'diners', 'elo'. Mais detalhes na tabela ( Tabela Bandeiras de Cartão ). |
cartao_numero |
Numero do cartão, apenas números. |
cartao_cvv |
Verificador do cartão, CVV2 ( Cielo/Redecard ). |
cartao_validade |
Validade do cartão (MMYYYY) ex:“012012”(Cielo/Redecard). |
parcelas |
Numero de parcelas para compras parceladas ( Cielo/Redecard ). |
tipo_operacao |
Tipo da operação ( Cielo/Redecard ) Mais detalhes na tabela ( Tabela Tipo Operações ). |
Nó de Comprador
Campo |
Descrição |
nome |
Nome do comprador. |
documento |
Documento do comprador apenas numeros ex.: '12345678900'. |
endereco |
Endereço do comprador. |
complemento |
Complemento do endereço |
numero |
Numero do endereço |
complemento |
Complemento do Endereço |
cep |
Cep do comprador apenas numeros ex.: '12345123'. |
bairro |
Bairro do comprador. |
cidade |
Cidade do comprador. |
estado |
Sigla do Estado do comprador. |
Tabela Tipo Operações
Tipo de Operação |
Operadora |
“credito_a_vista” |
Cielo / Redecard |
“parcelado_loja” |
Cielo / Redecard |
“parcelado_administradora” |
Cielo / Redecard |
“debito” |
Cielo |
Tabela Meios de Pagamento
Meio de Pagamento |
Operadora |
“cielo” |
Operações via cartão pela Cielo |
“redecard_web” |
Operações via cartão pelo Redecard Komerci Integrado |
“redecard_ws” |
Operações via cartão pelo Redecard Komerci Webservice |
“itau_shopline” |
Operações via Itaú Shopline |
“boleto_banco_brasil” |
Boleto do Banco do Brasil |
“boleto_bradesco” |
Boleto do Bradesco |
“boleto_caixa” |
Boleto da Caixa Economica Federal |
“boleto_hsbc” |
Boleto do HSBC |
“boleto_itau” |
Boleto do Itaú ( Sem ser via Shopline ) |
Tabela Bandeiras de cartão
Bandeira |
Operadoras que suportam |
“visa” |
Cielo / Redecard |
“mastercard” |
Cielo / Redecard |
“diners” |
Cielo / Redecard |
"amex" |
Cielo |
“elo” |
Cielo |
“discover” |
Cielo |
Exemplo de Requisição
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.sualoja.com.br/retorno",
"capturar":"true",
"pedido":{
"numero":"123",
"total":"100.00",
"moeda":"real",
"descricao":"Carrinho de Compras"
},
"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":"Teste Locaweb",
"documento":"12345678900",
"endereco":"Rua Itapaiuna",
"complemento":"Sala 11",
"numero":"1",
"cep":"09710240",
"bairro":"Centro",
"cidade":"São Paulo",
"estado":"SP"
}
}
}'
<?php
$transacao = LocawebGateway::criar(array(
'url_retorno' => 'http://www.sualoja.com.br/retorno',
'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);
?>
<!-- #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")
Response.Write("Código de erro: " & transacao.ErroCodigo & "")
Response.Write("Mensagem de erro: " & transacao.ErroMensagem & "")
Else
Response.Write("Dados da transação")
Response.Write("ID: " & transacao.ID & "")
Response.Write("Status: " & transacao.Status & "")
Response.Write("Número do pedido: " & transacao.NumeroPedido & "")
Response.Write("Meio de pagamento: " & transacao.MeioPagamento & "")
Response.Write("URL de acesso: " & transacao.UrlAcesso & "")
Response.Write("Detalhes: ")
'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) & "")
Next
End If
'Sempre libere os recursos dos objetos após utilizá-los.'
Set cielo = Nothing
Set transacao = Nothing
Set gateway = Nothing
%>
require 'locaweb-gateway'
transacao = Locaweb::Gateway.criar(
:url_retorno => 'http://www.sualoja.com.br/retorno',
: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 => "Teste Locaweb",
:documento => "12345678900",
:endereco => "Rua Itapaiuna",
:numero => "23",
:cep => "09710240",
:bairro => "Centro",
:cidade => "São Paulo",
:estado => "SP"
}
)
from locaweb_gateway import LocawebGateway
transacao = LocawebGateway.criar({
"url_retorno": 'http://www.sualoja.com.br/retorno',
"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": "Teste Locaweb",
"documento": "12345678900",
"endereco": "Rua Itapaiuna",
"numero": "23",
"cep": "09710240",
"bairro": "Centro",
"cidade": u"São Paulo",
"estado": "SP"
}
})
Exemplo de Retorno
{
"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
}
}