Boleto Fatura

Como Criar um Boleto Fatura

O boleto fatura é registrado imediatamente no banco no momento da criação. Este é o tipo padrão de boleto, ideal para cobranças onde você tem certeza que o pagador irá pagar.

Quando Usar

• Faturas mensais de serviços recorrentes
• Cobranças de contratos fechados
• Mensalidades escolares
• Condomínios e aluguéis

Como Funciona

1. Você cria o boleto com boleto.instrucao.registrar = true (ou omite o parâmetro, pois é o padrão)
2. O boleto é registrado imediatamente no banco
3. O boleto já está pronto para pagamento assim que é criado

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=true" \
  -d "boleto.emissao=2024-01-15" \
  -d "boleto.vencimento=2024-01-30" \
  -d "boleto.documento=FAT-001" \
  -d "boleto.titulo=DM" \
  -d "boleto.valor=299.90" \
  -d "boleto.pagador.nome=Maria Santos" \
  -d "boleto.pagador.cprf=000.000.000-00" \
  -d "boleto.pagador.endereco.cep=00000-000" \
  -d "boleto.pagador.endereco.uf=RJ" \
  -d "boleto.pagador.endereco.localidade=Rio de Janeiro" \
  -d "boleto.pagador.endereco.bairro=Copacabana" \
  -d "boleto.pagador.endereco.logradouro=Av. Atlântica" \
  -d "boleto.pagador.endereco.numero=500" \
  -o boleto-fatura.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", "true")
        .param("boleto.emissao", "2024-01-15")
        .param("boleto.vencimento", "2024-01-30")
        .param("boleto.documento", "FAT-001")
        .param("boleto.titulo", "DM")
        .param("boleto.valor", "299.90")
        .param("boleto.pagador.nome", "Maria Santos")
        .param("boleto.pagador.cprf", "000.000.000-00")
        .param("boleto.pagador.endereco.cep", "00000-000")
        .param("boleto.pagador.endereco.uf", "RJ")
        .param("boleto.pagador.endereco.localidade", "Rio de Janeiro")
        .param("boleto.pagador.endereco.bairro", "Copacabana")
        .param("boleto.pagador.endereco.logradouro", "Av. Atlântica")
        .param("boleto.pagador.endereco.numero", "500")));

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': 'true',
        'boleto.emissao': '2024-01-15',
        'boleto.vencimento': '2024-01-30',
        'boleto.documento': 'FAT-001',
        'boleto.titulo': 'DM',
        'boleto.valor': '299.90',
        'boleto.pagador.nome': 'Maria Santos',
        'boleto.pagador.cprf': '000.000.000-00',
        'boleto.pagador.endereco.cep': '00000-000',
        'boleto.pagador.endereco.uf': 'RJ',
        'boleto.pagador.endereco.localidade': 'Rio de Janeiro',
        'boleto.pagador.endereco.bairro': 'Copacabana',
        'boleto.pagador.endereco.logradouro': 'Av. Atlântica',
        'boleto.pagador.endereco.numero': '500'
    }
)

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

Parâmetro Principal

Campo	Valor	Descrição
boleto.instrucao.registrar	true	Indica que o boleto deve ser registrado imediatamente (padrão)

Comportamento Padrão

Se você não informar o parâmetro boleto.instrucao.registrar, o comportamento padrão é true, ou seja, o boleto será registrado automaticamente.

Veja Também

• Boleto Proposta - Para boletos que não devem ser registrados imediatamente
• Criar Boleto - Referência completa de criação de boletos
• Campos do Boleto - Todos os campos disponíveis
• Status do Registro - Verificar se foi registrado no banco