Personalizar Mensagens do Boleto

Como Sobrescrever Mensagens Cadastradas

Por padrão, as mensagens e instruções são definidas no cadastro da conta bancária. Você pode sobrescrever essas mensagens em cada boleto para personalizar a comunicação com o pagador.

Tipos de Mensagens

Tipo	Campo	Descrição
Instruções	boleto.instrucao1 a boleto.instrucao5	Exibidas no campo “Instruções” do boleto
Informações	boleto.informacao1 a boleto.informacao8	Exibidas no corpo do boleto

Exemplo com Instruções Personalizadas

cURL

curl -X POST "https://sandbox.boletocloud.com/api/v1/boletos" \
  -u "api-key_SUA-API-KEY:token" \
  -d "boleto.conta.token=TOKEN_DA_CONTA" \
  -d "boleto.emissao=2024-01-15" \
  -d "boleto.vencimento=2024-01-30" \
  -d "boleto.documento=MSG-001" \
  -d "boleto.titulo=DM" \
  -d "boleto.valor=350.00" \
  -d "boleto.instrucao1=Sr. Caixa, não receber após 15 dias do vencimento" \
  -d "boleto.instrucao2=Multa de 2% após o vencimento" \
  -d "boleto.instrucao3=Juros de 0,033% ao dia (1% ao mês)" \
  -d "boleto.instrucao4=Em caso de dúvidas: (11) 1234-5678" \
  -d "boleto.pagador.nome=Juliana Alves" \
  -d "boleto.pagador.cprf=000.000.000-00" \
  -d "boleto.pagador.endereco.cep=00000-000" \
  -d "boleto.pagador.endereco.uf=GO" \
  -d "boleto.pagador.endereco.localidade=Goiânia" \
  -d "boleto.pagador.endereco.bairro=Setor Bueno" \
  -d "boleto.pagador.endereco.logradouro=Av. T-63" \
  -d "boleto.pagador.endereco.numero=1200" \
  -o boleto-instrucoes.pdf

Java

Response response = ClientBuilder.newClient()
    .target("https://sandbox.boletocloud.com/api/v1/boletos")
    .register(HttpAuthenticationFeature.basic("api-key_SUA-API-KEY", "token"))
    .request(WILDCARD)
    .post(Entity.form(new Form()
        .param("boleto.conta.token", "TOKEN_DA_CONTA")
        .param("boleto.emissao", "2024-01-15")
        .param("boleto.vencimento", "2024-01-30")
        .param("boleto.documento", "MSG-001")
        .param("boleto.titulo", "DM")
        .param("boleto.valor", "350.00")
        .param("boleto.instrucao1", "Sr. Caixa, não receber após 15 dias do vencimento")
        .param("boleto.instrucao2", "Multa de 2% após o vencimento")
        .param("boleto.instrucao3", "Juros de 0,033% ao dia (1% ao mês)")
        .param("boleto.instrucao4", "Em caso de dúvidas: (11) 1234-5678")
        .param("boleto.pagador.nome", "Juliana Alves")
        .param("boleto.pagador.cprf", "000.000.000-00")
        .param("boleto.pagador.endereco.cep", "00000-000")
        .param("boleto.pagador.endereco.uf", "GO")
        .param("boleto.pagador.endereco.localidade", "Goiânia")
        .param("boleto.pagador.endereco.bairro", "Setor Bueno")
        .param("boleto.pagador.endereco.logradouro", "Av. T-63")
        .param("boleto.pagador.endereco.numero", "1200")));

Python

import requests
from requests.auth import HTTPBasicAuth

response = requests.post(
    'https://sandbox.boletocloud.com/api/v1/boletos',
    auth=HTTPBasicAuth('api-key_SUA-API-KEY', 'token'),
    data={
        'boleto.conta.token': 'TOKEN_DA_CONTA',
        'boleto.emissao': '2024-01-15',
        'boleto.vencimento': '2024-01-30',
        'boleto.documento': 'MSG-001',
        'boleto.titulo': 'DM',
        'boleto.valor': '350.00',
        'boleto.instrucao1': 'Sr. Caixa, não receber após 15 dias do vencimento',
        'boleto.instrucao2': 'Multa de 2% após o vencimento',
        'boleto.instrucao3': 'Juros de 0,033% ao dia (1% ao mês)',
        'boleto.instrucao4': 'Em caso de dúvidas: (11) 1234-5678',
        'boleto.pagador.nome': 'Juliana Alves',
        'boleto.pagador.cprf': '000.000.000-00',
        'boleto.pagador.endereco.cep': '00000-000',
        'boleto.pagador.endereco.uf': 'GO',
        'boleto.pagador.endereco.localidade': 'Goiânia',
        'boleto.pagador.endereco.bairro': 'Setor Bueno',
        'boleto.pagador.endereco.logradouro': 'Av. T-63',
        'boleto.pagador.endereco.numero': '1200'
    }
)

if response.status_code == 201:
    with open('boleto-instrucoes.pdf', 'wb') as f:
        f.write(response.content)

Exemplo com Informações Adicionais

cURL

curl -X POST "https://sandbox.boletocloud.com/api/v1/boletos" \
  -u "api-key_SUA-API-KEY:token" \
  -d "boleto.conta.token=TOKEN_DA_CONTA" \
  -d "boleto.emissao=2024-01-15" \
  -d "boleto.vencimento=2024-01-30" \
  -d "boleto.documento=INFO-001" \
  -d "boleto.titulo=DM" \
  -d "boleto.valor=650.00" \
  -d "boleto.informacao1=Referente ao pedido #98765" \
  -d "boleto.informacao2=Produto: Assinatura Anual Premium" \
  -d "boleto.informacao3=Período: 01/2024 a 12/2024" \
  -d "boleto.informacao4=Suporte: suporte@empresa.com.br" \
  -d "boleto.pagador.nome=Ricardo Santos" \
  -d "boleto.pagador.cprf=000.000.000-00" \
  -d "boleto.pagador.endereco.cep=00000-000" \
  -d "boleto.pagador.endereco.uf=PE" \
  -d "boleto.pagador.endereco.localidade=Recife" \
  -d "boleto.pagador.endereco.bairro=Boa Viagem" \
  -d "boleto.pagador.endereco.logradouro=Av. Boa Viagem" \
  -d "boleto.pagador.endereco.numero=2000" \
  -o boleto-informacoes.pdf

Campos Disponíveis

Instruções (Campo “Instruções” do boleto)

Campo	Uso típico
boleto.instrucao1	Instrução principal para o caixa
boleto.instrucao2	Informação sobre multa
boleto.instrucao3	Informação sobre juros
boleto.instrucao4	Contato para dúvidas
boleto.instrucao5	Instrução adicional

Informações (Corpo do boleto)

Campo	Uso típico
boleto.informacao1 a boleto.informacao8	Detalhes do pedido, produto, período, etc.

Sobrescrição

Quando você informa uma instrução ou informação na requisição, ela substitui completamente o valor cadastrado na conta bancária para aquele campo específico.

Limites

Cada campo possui um limite de caracteres que varia conforme o banco. Mensagens muito longas podem ser truncadas.

Veja Também

• Boleto Personalizado - Mais opções de personalização
• Criar Boleto - Referência completa de criação de boletos
• Campos do Boleto - Todos os campos disponíveis
• Instruções de Cobrança - Configurar instruções no boleto