Boleto Proposta

Como Criar um Boleto Proposta

O boleto proposta é um tipo de boleto que não é registrado imediatamente no banco. Ele funciona como uma proposta de pagamento que só será registrada quando o pagador demonstrar intenção de pagar.

Quando Usar

• Vendas online onde o cliente pode desistir da compra
• Orçamentos e propostas comerciais
• Situações onde você quer evitar custos de registro de boletos não pagos

Como Funciona

1. Você cria o boleto com boleto.instrucao.registrar = false
2. O boleto é gerado mas não é enviado ao banco
3. Quando o pagador acessa o boleto ou você decide registrá-lo, ele é então registrado
4. Após o registro, o boleto passa a ser válido para pagamento

Exemplo de Requisição

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.instrucao.registrar=false" \
  -d "boleto.emissao=2024-01-15" \
  -d "boleto.vencimento=2024-01-30" \
  -d "boleto.documento=DOC-001" \
  -d "boleto.titulo=DM" \
  -d "boleto.valor=150.00" \
  -d "boleto.pagador.nome=João da Silva" \
  -d "boleto.pagador.cprf=000.000.000-00" \
  -d "boleto.pagador.endereco.cep=00000-000" \
  -d "boleto.pagador.endereco.uf=SP" \
  -d "boleto.pagador.endereco.localidade=São Paulo" \
  -d "boleto.pagador.endereco.bairro=Centro" \
  -d "boleto.pagador.endereco.logradouro=Rua Exemplo" \
  -d "boleto.pagador.endereco.numero=123" \
  -o boleto-proposta.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.instrucao.registrar", "false")
        .param("boleto.emissao", "2024-01-15")
        .param("boleto.vencimento", "2024-01-30")
        .param("boleto.documento", "DOC-001")
        .param("boleto.titulo", "DM")
        .param("boleto.valor", "150.00")
        .param("boleto.pagador.nome", "João da Silva")
        .param("boleto.pagador.cprf", "000.000.000-00")
        .param("boleto.pagador.endereco.cep", "00000-000")
        .param("boleto.pagador.endereco.uf", "SP")
        .param("boleto.pagador.endereco.localidade", "São Paulo")
        .param("boleto.pagador.endereco.bairro", "Centro")
        .param("boleto.pagador.endereco.logradouro", "Rua Exemplo")
        .param("boleto.pagador.endereco.numero", "123")));

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.instrucao.registrar': 'false',
        'boleto.emissao': '2024-01-15',
        'boleto.vencimento': '2024-01-30',
        'boleto.documento': 'DOC-001',
        'boleto.titulo': 'DM',
        'boleto.valor': '150.00',
        'boleto.pagador.nome': 'João da Silva',
        'boleto.pagador.cprf': '000.000.000-00',
        'boleto.pagador.endereco.cep': '00000-000',
        'boleto.pagador.endereco.uf': 'SP',
        'boleto.pagador.endereco.localidade': 'São Paulo',
        'boleto.pagador.endereco.bairro': 'Centro',
        'boleto.pagador.endereco.logradouro': 'Rua Exemplo',
        'boleto.pagador.endereco.numero': '123'
    }
)

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

Parâmetro Principal

Campo	Valor	Descrição
boleto.instrucao.registrar	false	Indica que o boleto não deve ser registrado imediatamente

Atenção

Boletos proposta não podem ser pagos até que sejam registrados. Certifique-se de registrá-los antes de disponibilizá-los para pagamento efetivo.

Veja Também

• Controlar Momento do Registro - Mais opções de controle de registro
• Criar Boleto - Referência completa de criação de boletos
• Campos do Boleto - Todos os campos disponíveis
• Boleto Fatura - Boletos para registro imediato