Informações e instruções das APIs dos produtos Locaweb.
Emissão de boletos através do Gateway de Pagamento
A emissão de boletos através do Gateway de Pagamento funciona como todos os outros meios de pagamento: com base no envio de informações. A diferença é que é o único parâmetro a ser enviado é o meio de pagamento, com o nome do banco. Assim, para emitir um boleto do Banco do Brasil, o meio de pagamento a ser passado é “boleto_banco_brasil”.
Segue uma tabela contendo os meios de pagamentos que podem ser utilizados:
Banco | Meio de Pagamento |
---|---|
Banco do Brasil | boleto_banco_brasil |
Bradesco | boleto_bradesco |
HSBC | boleto_hsbc |
CEF | boleto_caixa |
Itaú | boleto_itau |
Uma requisição de criação de boleto irá retornar uma resposta que contem o nó “url_acesso”. Essa URL deverá ser utilizada para visualizar o boleto emitido.
Para ser executada com sucesso, uma requisição para criação de boleto deverá conter os dados do pedido e os dados do comprador. Veja o exemplo abaixo:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"token":"3a5bbed0-50d4-012f-8d73-0026bb5a6240",
"transacao":{
"pedido":{
"numero":"123",
"total":"100.00",
"moeda":"real"
},
"pagamento":{
"meio_pagamento":"boleto_bradesco",
"data_vencimento":"23122012"
},
"comprador":{
"nome":"Nome do comprador",
"documento":"12345678900"
}
}
}
1
2
3
4
5
6
7
8
9
10
11
{
"transacao": {
"id": 444,
"status": "aguardando_pagamento",
"meio_pagamento": "boleto_bradesco",
"numero_pedido": 123,
"total": "100.00",
"url_acesso": "https://api.gatewaylocaweb.com.br/v1/boleto/0ff77c04-fc3f-4f0b-957a-d29ec1fc12e2",
"erro": null
}
}
A URL retornada no campo “url_acesso” é a URL que dá permite acesso ao boleto e que deverá ser repassada ao seu comprador.
Tendo em vista que suportamos apenas boletos não registrados e que portanto a conferência do pagamento do boleto deve ser feita manualmente no ambiente da loja, os meio de pagamentos do tipo “boleto” não possuem nenhum estado além de “aguardando pagamento”.
O campo “nosso número” do boleto varia de acordo com o número do pedido. Portanto, no exemplo acima, o campo “Nosso número” teria valor “123″. Caso o campo tenha um tamanho mínimo, serão acrescentados zeros à esquerda. No exemplo, o campo ficou com o valor “06/00000000123-6″.