É possível descartar um boleto onde a Situação seja igual a EMITIDO, FALHA ou REJEITADO.
Recomendamos que a rota de descarte seja utilizada apenas para excluir boletos que não foram encaminhados ao banco ainda, para evitar que existam boletos Registrados no banco e que já tenham sido descartados de nossa API
POST
A solicitação é feita através de uma requisição POST. A rota chamada deve ter a seguinte URL:
Homologação:
https://homologacao.plugboleto.com.br/api/v1/boletos/descarta/lote
Produção:
https://plugboleto.com.br/api/v1/boletos/descarta/lote
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| cnpj-sh | CNPJ da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
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 |
Body
Exemplo de JSON:
Esta rota recebe um array no corpo (body) de IdIntegracao dos boletos que se deseja descartar.
["IdIntegracao1","IdIntegracao2","IdIntegracao3"]
O array pode receber um ou mais Ids. Caso queira, você pode descartar boletos de vários bancos diferentes! Ah, e lembre-se sempre, altere as informações em destaque na cor amarela.
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"_sucesso": [
{
"idintegracao": "BJSdV7dYz"
}
]
"_falha": []
}
}
Exemplo de retorno com erro:
{
"_status": "sucesso",
"_dados": {
"_sucesso": []
"_falha": [
"idintegracao": "BJSdV7dYz",
"_erro": "Boleto não encontrado",
"_status_http": 404
]
}
}
Tendo retorno de Sucesso o boleto estará descartado e assim finalizamos a nossa integração com a API Boleto!
Comentários
0 comentário
Por favor, entre para comentar.