É através do arquivo gerado por essa rota que vamos indicar a baixa no boleto (seja por pagamento presencial ou até mesmo por cancelamento do título). Para fazer essa geração, vamos precisar apenas do IdIntegracao do boleto que você deseja gerar na remessa.
Também disponível para o títulos gerados usando o Web Service referentes aos bancos: Itaú V2, Banco do Brasil V2, Sicredi WS, SICOOB V2 o processo de solicitação da baixa é o mesmo e ela será enviada diretamente ao WebService do banco.
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/baixa/lote
Produção:
https://plugboleto.com.br/api/v1/boletos/baixa/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 obter remessa de baixa.
["IdIntegracao1","IdIntegracao2","IdIntegracao3"]
Apenas as situações EMITIDO e REGISTRADO permitem a geração da remessa. Ah, lembre-se que, para gerar remessa para mais de um Id, você deve informar a vírgula como separador.
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_mensagem": "Solicitação pendente de processamento",
"_dados": [
"situacao": "PROCESSANDO",
"protocolo": "B1qvLYTxG",
]
}
}
Exemplo de retorno com erro:
{
"_status": "sucesso",
"_mensagem": "Solicitação pendente de processamento",
"_dados": [
"_campo": "corpo_requisicao",
"_erro": "O corpo da requisição deve ser um array de IDs de integração.",
]
}
}
A partir do momento que recebermos a resposta de sucesso, vamos efetuar a consulta do processamento desse arquivo. Essa consulta é feita com o valor retornado no campo protocolo, sendo assim, guarde-o agora pois vamos usá-lo em nosso próximo passo.
Comentários
3 comentários
Olá, como é possível que um arquivo Emitido, Liquidado ou Baixado seja solicitada a sua Baixa? Não parece fazer sentido no meu entendimento. Pode explicar o cenário?
Outra dúvida, a variavel _dados, é um Array ou um Objeto?
Olá Lennon, desculpa pela demora na resposta,
Em relação à primeira dúvida, Iremos corrigir esta posição levantada. Para gerar baixa para EMITIDO e REGISTRADO.
Em relação a segunda dúvida ela seria um array de objetos.
Obrigado!
Qualquer dúvida estamos a disposição.
Por favor, entre para comentar.