Referência da API
SiteCentral de AjudaAPI Status
Start typing to search…

Atualizar o Boleto

put
https://{apiHost}/v1/bank_billets/

Atualiza informações específicas de um Boleto.

Você pode alterar boletos no status de Aberto(opened) ou Vencido(overdue)

Você receberá webhooks generating e opened para o boleto alterado.

Em carteiras registradas, a alteração irá entrar na remessa e pode ser cobrada taxa bancária.

Path Params
string
required

ID do Boleto

Body Params

Informações a serem atualizadas no boleto

float

Valor do Boleto

date

Data de vencimento

tags
array of strings | null

Tags associadas ao boleto

tags
string | null

Anotações

integer | null
enum

Tipo de dias para protesto: * 0 Corridos * 1 Úteis

Allowed:
integer | null

Dias corridos para Protesto

integer | null

Dias corridos para Baixa Bancos Suportados: Itaú

string | null

Código de Protesto(Somente por CNAB 240). Consulte os possíveis valores para cada banco.

string | null

Instruções para o Caixa

string | null

Descrição do produto ou serviço

integer | null
enum
Defaults to 0

Tipo de juros/mora:

  • 0 Inexistente (Padrão)
  • 1 Para porcentagem diária
  • 2 Para valor diário
  • 7 Para porcentagem mensal - Bancos suportados: Bradesco, BB, BTG, Caixa, Inter, Itaú, Safra, Santander, Sicoob e Sicredi
Allowed:
integer | null

Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).

float | null

Porcentagem de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1 ou 7. Até 2 casas decimais.

float | null

Valor diário de juros (R$). Obrigatório se interest_type é igual a 2. Até 2 casas decimais.

integer | null
enum
Defaults to 0

Tipo de desconto: O tipo de desconto será o mesmo para todos os três descontos, caso existam. : * 0 Inexistente (Padrão) * 1 Para valor fixo * 2 Para percentual do valor do boleto

Allowed:
integer | null

Dias para desconto. Obrigatório se discount_type é diferente de 0(zero)

float | null

Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2

float | null

Valor do desconto (R$). Obrigatório se discount_type é igual a 1.

integer | null

Dias para segundo desconto.

float | null

Percentual do valor do boleto equivalente ao segundo desconto.

float | null

Valor do segundo desconto (R$).

integer | null

Dias para terceiro desconto.

float | null

Percentual do valor do boleto equivalente ao terceiro desconto.

float | null

Valor do terceiro desconto (R$).

integer | null
enum

Tipo de abatimento:

1: Valor. 2: Porcentagem. 3: Sem abatimento

Allowed:
float

Valor do abatimento. Obrigatório se reduction_type é igual a 1.

float | null

Porcentagem de Abatimento. Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se reduction_type é igual a 2. Até 2 casas decimais.

integer | null
enum

Tipo de pagamento divergente:

  • 1 Aceita qualquer valor divergente
  • 2 Aceita pagamentos dentro de uma faixa de valores ou percentuais
  • 3 Não aceita pagamento de valores divergentes
  • 4 Aceita pagamentos de valores superiores a um valor ou percentual mínimo Bancos suportados: Itaú
Allowed:
integer | null
enum

Tipo de valor a considerar para os limites de pagamentos: Válido apenas para Itaú e Caixa.

  • 1 Informa pagamentos divergentes por valores
  • 2 Informa pagamentos divergentes por percentuais Bancos suportados: Itaú
Allowed:
float | null

Valor máximo para a faixa de pagamentos divergentes. Bancos suportados: Itaú

float | null

Valor mínimo para a faixa de pagamentos divergentes. Bancos suportados: Itaú

float | null

Percentual máximo para a faixa de pagamentos divergentes. Bancos suportados: Itaú

float | null

Percentual mínimo para a faixa de pagamentos divergentes. Bancos suportados: Itaú

integer | null
enum
Defaults to 0

Tipo de multa:

  • 0 Inexistente (Padrão)
  • 1 Para percentual do valor do boleto
  • 2 Para valor fixo
Allowed:
integer | null

Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).

integer | null
enum

Birô de Crédito/Órgão Negativador.

0: Serasa. 1: Quod. 2: SPC

Opções disponíveis para cada banco suportado:

  • Banco do Brasil: Serasa e Quod.
Allowed:
integer | null

Quantidade de dias após o vencimento para negativar o título.

float | null

Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1. Até 2 casas decimais.

float | null

Valor da multa (R$). Obrigatório se fine_type é igual a 2. Até 2 casas decimais.

string | null

Número do Documento, Tamanho depende do banco, formato e forma de envio (API / EDI): * Itau |Cnab240| 10 | * Itau |Cnab400| 10 |

string
length ≤ 120

Nome do cliente. Bancos Suportados: Santander

string
length ≤ 20

CPF/CNPJ do cliente. Bancos Suportados: Santander

string
length ≤ 2

Estado. Bancos Suportados: Santander

string
length ≤ 60

Cidade(Nome deve estar correto e completo). Bancos Suportados: Santander

string
length ≤ 8

CEP (formato 99999999). Bancos Suportados: Santander

string
length ≤ 255

Endereço. Bancos Suportados: Santander

string
length ≤ 80

Bairro. Bancos Suportados: Santander

string | null

Nome do Beneficiário final (Sacador/Avalista). Bancos Suportados: Santander

string | null

CNPJ/CPF do Beneficiário final (Sacador/Avalista). Bancos Suportados: Santander

string
enum
Defaults to 02

Tipo de Documento: * Código | Sigla | Descrição * 01 | CH | Cheque * 02 | DM | Duplicata Mercantil (Padrão) * 03 | DMI | Duplicata Mercantil p/ Indicação * 04 | DS | Duplicata de Serviço * 05 | DSI | Duplicata de Serviço p/ Indicação * 06 | DR | Duplicata Rural * 07 | LC | Letra de Câmbio * 08 | NCC | Nota de Crédito Comercial * 09 | NCE | Nota de Crédito a Exportação * 10 | NCI | Nota de Crédito Industrial * 11 | NCR | Nota de Crédito Rural * 12 | NP | Nota Promissória * 13 | NPR | Nota Promissória Rural * 14 | TM | Triplicata Mercantil * 15 | TS | Triplicata de Serviço * 16 | NS | Nota de Seguro * 17 | RC | Recibo * 18 | FAT | Fatura * 19 | ND | Nota de Débito * 20 | AP | Apólice de Seguro * 21 | ME | Mensalidade Escolar * 22 | PC | Parcela de Consórcio * 23 | NF | Nota Fiscal * 24 | DD | Documento de Dívida * 25 | CPR | Cédula de Produto Rural * 26 | CTR | Contrato * 27 | CSG | Cosseguros * 28 | EC | Encargos Condominiais * 29 | CPS | Conta de Prestação de Serviços * 30 | WR | Warrant * 31 | DP | Duplicata Prestação * 32 | CSR | Cobrança Seriada * 33 | CAR | Carnê * 34 | ARE | Apólice Ramos Elementares * 35 | CC | Cartão de Crédito * 36 | BDP | Boleto de Proposta * 37 | NPD | Nota Promissória Direta * 38 | DAE | Dívida Ativa de Estado * 39 | DAM | Divida Ativa de Município * 40 | DAU | Dívida Ativa União * 41 | CCB | Célula de Crédito Bancário * 42 | FI | Financiamento * 43 | RD | Rateio de Despesas * 44 | DRI | Duplicata Rural p/ Indicação * 45 | ECI | Encargos Condominiais p/ Indicação * 99 | Outros | Outros

              Bancos Suportados: Santander
string | null

Número de controle: Pode conter qualquer informação de interesse da Empresa. A informação contida neste campo sempre retornará com o respectivo título no arquivo-retorno. Bancos Suportados: Santander

integer | null

Quantidade de pagamentos parciais aceitos para este boleto. Bancos Suportados: Santander

date | null

Data de emissão. Bancos Suportados: Santander

string | null

Chave do bolepix. Bancos Suportados: Santander

string | null

TxId do pix. Bancos Suportados: Santander

Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses
204

Boleto atualizado

Updated 6 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago