{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "situacaoBoleto": 1
}
Por meio deste endpoint, o parceiro pode permitir que o operador realize atualizações em um determinado boleto desde que esteja dentro do vencimento e não tenha sido pago.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Headers

​
IdempotencyKey
string
required

Chave única para garantir que uma operação seja executada apenas uma vez.

​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

​
codigoRegistroBoleto
string<uuid> | null

Código UUID de registro do boleto.

​
codigoBarras
string | null

Código de barras do boleto.

​
dadosBoleto
object
​
pagador
object
​
sacadorAvalista
object
​
juros
object
​
multa
object
​
desconto
object
​
descontos
object[] | null
​
identificadorCliente
string | null
​
instrucoesBeneficiario
string[] | null

Response

200 - application/json

Success

​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
codigoAlteracaoBoleto
string<uuid>

Código UUID identificador da alteração de boleto.

​
situacaoBoleto
enum<integer>

1 = Pendente Registro; 2 = Registrado; 3 = Erro Registro; 4 = Pago; 5 = Baixado Cedente; 6 = Baixado Data Limite Pagto; 7 = Pendente Baixa Cedente; 8 = Pendente Baixa Protesto; 9 = Protestado; 10 = Pago Em Cartorio

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10