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 |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
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",
"TituloCarteira": "17",
"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
Exemplos de retorno:
Sucesso:
Json de retorno padrão da aplicação, com o campo "situacao=SALVO" indicando que o boleto gerado passou pelo primeiro nível de análise e foi incluído na fila de processamento do PlugBoleto.
Falha:
JSON de retorno com o campo "_sucesso" vazio e com o campo "_falha" populado, indicando que o boleto gerado não passou pelo primeiro nível de validação da API e não pode ser processado. No campo "erros" haverá o descritivo da falha encontrada. Geralmente são falhas que impediram a sequência da emissão do título, como campos obrigatórios não informados ou duplicidade de nossoNumero.
Observe que quando obtemos sucesso no processo de emissão será gerado um campo chamado 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.
Para uma utilização saudável da rota, recomendamos que sejam enviados no máximo 800 boletos por vez no endpoint, caso seja necessário. De modo que não haja uma sobrecarga no processamento.
Comentários
0 comentário
Por favor, entre para comentar.