A inclusão do boleto se resume em preenchermos um objeto JSON com os dados do boleto e enviarmos para o nosso servidor.
POST
Homologação:
https://homologacao.plugboleto.com.br/api/v1/boletos/lote
Produção:
https://plugboleto.com.br/api/v1/boletos/lote
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-sh | CNPJ da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
Objeto
Para incluir um boleto, o objeto JSON possuirá os campos presentes neste link: clique aqui para visualizar os campos disponíveis.
Tais campos irão compor o objeto json que será passado como application/json no body da requisição, conforme exemplo a seguir.
Body
Exemplo de JSON:
[
{
"CedenteContaNumero": "54321",
"CedenteContaNumeroDV": "0",
"CedenteConvenioNumero": "321",
"CedenteContaCodigoBanco": "341",
"SacadoCPFCNPJ": "28436161661",
"SacadoEmail": "email@sacado.com",
"SacadoEnderecoNumero": "987",
"SacadoEnderecoBairro": "Centro",
"SacadoEnderecoCEP": "87098765",
"SacadoEnderecoCidade": "Maringá",
"SacadoEnderecoComplemento": "Fundos",
"SacadoEnderecoLogradouro": "Rua teste, 987",
"SacadoEnderecoPais": "Brasil",
"SacadoEnderecoUF": "PR",
"SacadoNome": "Teste de Souza",
"SacadoTelefone": "4499999999",
"SacadoCelular": "44999999999",
"TituloDataEmissao": "01/01/2020",
"TituloDataVencimento": "01/02/2020",
"TituloMensagem01": "Juros de 0,01 ao dia",
"TituloMensagem02": "Nao receber apos 30 dias de atraso",
"TituloMensagem03": "Titulo sujeito a protesto apos 30 dias",
"TituloNossoNumero": "6",
"TituloNumeroDocumento": "01012020",
"TituloValor": "0,02",
"TituloLocalPagamento": "Pagável em qualquer banco até o vencimento."
}
]
Para fazer uma inclusão em lote, basta enviar um array de boletos separados por ,:
Exemplo:
[{
"CedenteContaNumero": "54321",
"CedenteContaNumeroDV": "0",
"CedenteConvenioNumero": "321",
"CedenteContaCodigoBanco": "341",
"SacadoCPFCNPJ": "28436161661",
...
...
...
},
{
"CedenteContaNumero": "54321",
"CedenteContaNumeroDV": "0",
"CedenteConvenioNumero": "321",
"CedenteContaCodigoBanco": "341",
"SacadoCPFCNPJ": "28436161661",
...
...
...
}
}]
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"_sucesso": [
{
"idintegracao": "Hyecr_Ywdx",
"situacao": "SALVO",
"TituloNumeroDocumento": "01012020",
"TituloNossoNumero": "6",
"CedenteContaCodigoBanco": "341",
"CedenteContaNumero": "54321",
"CedenteConvenioNumero": "321"
},
{
"idintegracao": "ByZcr_FPul",
"situacao": "SALVO",
"TituloNumeroDocumento": "01012020",
"TituloNossoNumero": "7",
"CedenteContaCodigoBanco": "341",
"CedenteContaNumero": "54321",
"CedenteConvenioNumero": "321"
}
],
"_falha": []
}
}
Exemplo de retorno com erro:
{
"_status": "sucesso",
"_dados": {
"_sucesso": [
{
"idintegracao": "H1-vGuYDul",
"situacao": "SALVO",
"TituloNumeroDocumento": "01012020",
"TituloNossoNumero": "6",
"CedenteContaCodigoBanco": "341",
"CedenteContaNumero": "54321",
"CedenteConvenioNumero": "321"
}
],
"_falha": [
{
"_status_http": 400,
"_erro": {
"erroValidacao": true,
"erros": {
"boleto": "Boleto com Nosso Número 7 já existe para este convênio."
}
},
"_dados": {
"CedenteContaNumero": "54321",
"CedenteContaNumeroDV": "0",
"CedenteConvenioNumero": "321",
"CedenteContaCodigoBanco": "341",
"SacadoCPFCNPJ": "28436161661",
"SacadoEmail": "email@sacado.com",
"SacadoEnderecoNumero": "987",
"SacadoEnderecoBairro": "Centro",
"SacadoEnderecoCEP": "87098765",
"SacadoEnderecoCidade": "Maringá",
"SacadoEnderecoComplemento": "Fundos",
"SacadoEnderecoLogradouro": "Rua teste, 987",
"SacadoEnderecoPais": "Brasil",
"SacadoEnderecoUF": "PR",
"SacadoNome": "Teste de Souza",
"SacadoTelefone": "4499999999",
"SacadoCelular": "44999999999",
"TituloDataDesconto": "05/01/2020",
"TituloValorDesconto": "0,01",
"TituloDataEmissao": "01/01/2020",
"TituloDataVencimento": "01/01/2020",
"TituloValorJuros": "0,01",
"TituloPrazoProtesto": "30",
"TituloMensagem01": "Juros de 0,01 ao dia",
"TituloMensagem02": "Nao receber apos 30 dias de atraso",
"TituloMensagem03": "Titulo sujeito a protesto apos 30 dias",
"TituloNossoNumero": "7",
"TituloNumeroDocumento": "01012020",
"TituloValor": "0,02",
"TituloLocalPagamento": "Pagável em qualquer banco até o vencimento."
}
}
]
}
}
Faça um teste e veja que no retorno existem algumas informações sobre o boleto e o IdIntegracao. O IdIntegracao é o identificador único do boleto que emitimos, e vamos utilizá-lo no próximo passo para sabermos se o boleto está pronto para ser impresso e enviado ao banco.
Comentários
0 comentário
Por favor, entre para comentar.