Cobrança via Boleto

O Boleto Bancário é o método ideal para pagamentos programados e para clientes que preferem métodos tradicionais de compensação.

Gerar Cobrança Boleto

Este endpoint cria um registro de cobrança e gera os dados do boleto para pagamento.

Endpoint

POST /billing/charges

Headers

Header	Valor
Content-Type	application/json
Authorization	Bearer {seu_token}

Parâmetros da Requisição (JSON)

{
    "amount": 5.00,
    "due_date": "2026-12-31",
    "description": "Descrição do boleto",
    "payment_method": "BOLETO",
    "name": "Nome do Cliente",
    "document": "12345678901",
    "email": "cliente@email.com",
    "webhook": "https://seu-sistema.com/webhook"
}

---

Resposta de Sucesso (201 Created)

O retorno contém os dados estruturados da cobrança e o PDF do boleto no objeto boleto.

{
    "data": {
        "id": 247870,
        "amount": 5,
        "code": "yuhqqpvywkvroxgylmnmulthweyfa5jx",
        "description": "Descrição do boleto",
        "boleto": {
            "boleto_id": 310322,
            "barcode": "279051234567890123456789012345678901234567...",
            "digitable_line": "27905.12345...",
            "path_pdf": "https://universities.fastgivr.com.br/storage/boletos/310322.pdf"
        },
        "status": {
            "id": 1,
            "title": "pending",
            "description": "Em Aberto"
        },
        "timestamps": {
            "due_date": {
                "iso": "2026-12-31T03:00:00.000000Z",
                "human": "31 de dezembro de 2026"
            }
        }
    }
}

Campos Principais do Boleto

• data.boleto.barcode: Código de barras para pagamento em caixas eletrônicos.
• data.boleto.digitable_line: Linha digitável para pagamento via Internet Banking.
• data.boleto.path_pdf: Link direto para download e visualização do boleto em formato PDF.

---

Observações Técnicas

• Compensação: Boletos podem levar de 1 a 2 dias úteis para serem compensados e o status mudar para paid.
• Validação de Documento: Certifique-se de enviar o CPF ou CNPJ apenas com números.