Comandos de instrução
Comandos de instrução alteram o estado de um boleto já cadastrado. Padrão comum a todos:
- Método PATCH, com o nossoNumero (9 dígitos) no path.
- Headers:
x-api-key,Authorization:Bearer,Content-Type: application/json, cooperativa, posto, ecodigoBeneficiario(header). - Retorno 202 Accepted com o schema
ComandoResponse(transactionId,dataMovimento,codigoBeneficiario,nossoNumero, cooperativa, posto,statusComando,dataHoraRegistro,tipoMensagem). - Processamento assíncrono: 202 significa "instrução recebida", não "concluída".
- Erros aplicáveis: 400, 401, 422 e 429.
Endpoints (todos em /cobranca/boleto/v1/boletos/{nossoNumero}/...)
| Comando | Path | Body | Regra principal |
|---|---|---|---|
| Baixar | /baixa | vazio | — |
| Alterar vencimento | /data-vencimento | dataVencimento | Carência de juros/multa é reajustada preservando o intervalo |
| Alterar desconto | /desconto | valorDesconto1..3 | — |
| Alterar data de desconto | /data-desconto | data1..3 | — |
| Alterar juros | /juros | valorOuPercentual | Só o valor muda; o tipo de juros permanece |
| Alterar seu número | /seu-numero | seuNumero (máx. 10) | — |
| Conceder abatimento | /conceder-abatimento | valorAbatimento (> 0) | Deve ser compatível com a situação do título |
| Cancelar abatimento | /cancelar-abatimento | vazio | Exige abatimento previamente concedido |
| Pedir protesto | /protesto | vazio | Título deve estar vencido; espécie deve permitir protesto |
| Sustar protesto e baixar | /sustar-protesto-baixar-titulo | vazio | Exige protesto em andamento; encerra o título |
| Sustar protesto e manter | /sustar-protesto-manter-titulo | vazio | Exige protesto em andamento; mantém em carteira |
| Incluir negativação | /negativacao | vazio | Título vencido; exige produto Serasa ativo; espécie deve permitir |
| Excluir negativação e baixar | /sustar-negativacao-baixar-titulo | vazio | Exige negativação existente |
| Cancelar protesto automático | /cancelar-protesto-automatico | vazio | Só para título com protesto automático configurado |
Regras de estado (geram 422), restrições comuns: título já liquidado, baixado, rejeitado, aguardando confirmação, ou já com uma solicitação do mesmo tipo em processamento. Protesto e negativação exigem que o beneficiário tenha o produto/permissão correspondente ativo.
Updated 10 days ago
Did this page help you?
