Esta rota é utilizada para comandar a baixa de um boleto, seja por motivo de pagamento presencial ou cancelamento definitivo do título. Para realizar a operação, é necessário informar apenas o IdIntegracao do boleto correspondente.
Observações Importantes:
Garantia de Funcionamento: A baixa via API é garantida exclusivamente para boletos que foram emitidos via Web Service (WS).
Boletos via CNAB: Embora algumas instituições permitam a baixa individual via WS para títulos gerados originalmente por arquivos CNAB, este comportamento não é uma regra e pode apresentar instabilidades.
Recomendação: Não recomendamos o uso desta rota para títulos emitidos via CNAB, visando evitar divergências de processamento junto ao banco.
Bancos
- CAIXA ECONOMICA FEDERAL
- BRADESCO
- INTER
- C6
- BTG
- CORA
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/individual/:idIntegracao
Produção:
https://plugboleto.com.br/api/v1/boletos/baixa/individual/:idIntegracao
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 |
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 boleto. 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
0 comentário
Por favor, entre para comentar.