O processo de baixa de um título é utilizado quando temos um boleto já previamente registrado junto ao banco, e desejamos fazer a baixa (ou o cancelamento) deste registro. Nesse post, vamos falar sobre o processo de baixa de boletos via webservice.
Banco Inter
Para o processo de baixa do banco Inter, é obrigatório passar o motivo de cancelamento!
Motivos de cancelamento.
| Código | Descrição |
| 01 |
ACERTOS(cancelado por acertos) |
| 02 |
APEDIDODOCLIENTE(cancelado a pedido do cliente) |
| 03 |
PAGODIRETOAOCLIENTE(cancelado por ter sido pago direto ao cliente) |
| 04 |
SUBSTITUICAO(cancelado por substituição) |
POST
Produção:
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 |
Body
Exemplo JSON:
{
"motivoCancelamento": "04"
}Exemplo de resposta:
Sucesso:
{
"_status": "sucesso",
"_mensagem": "Solicitação pendente de processamento",
"_dados": {
"situacao": "PROCESSANDO",
"protocolo": "X2ZWZ4Y7C"
}
}Consulta do protocolo pode ser realizada na rota dessa documentação:
Realizando a consulta da baixa
Possíveis erros:
{
"_status": "error",
"_mensagem": "Motivo de cancelamento inválido.",
"_dados": []
}{
"_status": "error",
"_mensagem": "Para baixa individual do banco Inter, informe o motivo do cancelamento.",
"_dados": []
}
Baixa via OCX
Para realizar a baixa pelo componente, utilize o método BaixarBoletoIndividualComMotivo, informando o ID de integração do título e o código do motivo de cancelamento.
var
_Retorno: IspdRetBaixarBoletoIndividual;
begin
_Retorno := FBoletoX.BaixarBoletoIndividualComMotivo('X2ZWZ4Y7C', '04');
if AnsiSameText(_Retorno.Status, 'ERRO') then
ShowMessage(_Retorno.Mensagem)
else
edtProtocolo.Text := _Retorno.Protocolo;
end;Retorno
| Campo | Descrição |
| Protocolo | Protocolo da solicitação |
| Situacao | Situação da solicitação |
| Status | Resultado da chamada (SUCESSO ou ERRO) |
| Mensagem | Mensagem retornada |
| ErroClasse | Classificação do erro, quando houver |
Comentários
0 comentário
Por favor, entre para comentar.