Emissão de Boletos de Cobrança

Endpoint destinado à emissão e registro bancário de boletos de cobrança a terceiros (sacados/clientes finais). Permite a parametrização de encargos por atraso (multa e juros), concessão de descontos escalonados por pontualidade, políticas de recebimento com valor divergente e diretrizes de protesto em cartório.

1. Multa por Atraso `fine`

A multa incide uma única vez após o vencimento do título. O bloco fine é opcional; quando informado, configure conforme a modalidade:

Modalidade / Campo	Código (`code_type_fine`)	Tipo / Unidade	Obrigatoriedade	Exemplo & Instrução Impressa
Valor Fixo (`amount_of_fine`)	`01`	`string` (R$)	Obrigatório* (se cód `01`)	`"code_type_fine": "01", "amount_of_fine": "9.99"` Imprime: "Multa de R$ 9,99 após o vencimento."
Percentual (`percentage_of_fine`)	`02`	`string` (%)	Obrigatório* (se cód `02`)	`"code_type_fine": "02", "percentage_of_fine": "2.00"` Imprime: "Multa de 2,00% após o vencimento."
Isento de Multa	`03`	-	Opcional	`"code_type_fine": "03"` Imprime: "Multa: isento."
Carência (`number_of_days_fine`)	-	`integer`	Opcional (Padrão: 1)	`"number_of_days_fine": 1` Dias corridos após o vencimento para início da incidência.

2. Juros de Mora `fees`

Os juros incidem proporcionalmente aos dias de atraso após o vencimento do título. O bloco fees é opcional; quando informado, configure conforme a modalidade:

Modalidade / Campo	Código (`interest_type_code`)	Tipo / Unidade	Obrigatoriedade	Exemplo & Instrução Impressa
Percentual ao Mês (`interest_percentage`)	`90`	`string` (%)	Obrigatório* (se cód `90`)	`"interest_type_code": "90", "interest_percentage": "1.00"` Imprime: "Juros de 1,00% ao mês."
Valor Fixo Diário (`interest_value`)	`93`	`string` (R$)	Obrigatório* (se cód `93`)	`"interest_type_code": "93", "interest_value": "0.50"` Imprime: "Juros de R$ 0,50 por dia."
Percentual ao Dia (`interest_percentage`)	`91`	`string` (%)	Obrigatório* (se cód `91`)	`"interest_type_code": "91", "interest_percentage": "0.033"` Imprime: "Juros de 0,033% ao dia."
Percentual ao Ano (`interest_percentage`)	`92`	`string` (%)	Obrigatório* (se cód `92`)	`"interest_type_code": "92", "interest_percentage": "12.00"` Imprime: "Juros de 12,00% ao ano."
Isento de Juros	`05`	-	Opcional	`"interest_type_code": "05"` Imprime: "Juros: isento."
Data Inicial dos Juros (`interest_date`)	-	`string` (`YYYY-MM-DD`)	Opcional	`"interest_date": "2026-04-16"` Data a partir da qual os juros serão cobrados.
Dias de Carência (`amount_of_interest_days`)	-	`integer`	Opcional	`"amount_of_interest_days": 1` Tolerância em dias antes da incidência dos juros.

3. Descontos por Antecipação `discount`

Permite conceder abatimentos para pagamentos realizados antes da data de vencimento. Suporta até 3 faixas de desconto escalonadas dentro da lista discounts:

Modalidade	Código (`discount_type_code`)	Campos na Lista `discounts`	Obrigatoriedade	Exemplo & Instrução Impressa
Valor Fixo	`01`	`discount_value` `discount_date`	Obrigatório* (se cód `01`)	`"discount_type_code": "01", "discounts": [{"discount_date": "2026-04-10", "discount_value": "10.00"}]` Imprime: "Desconto de R$ 10,00 até DD/MM/AAAA."
Percentual	`02`	`discount_percentage` `discount_date`	Obrigatório* (se cód `02`)	`"discount_type_code": "02", "discounts": [{"discount_date": "2026-04-10", "discount_percentage": "1.52"}]` Imprime: "Desconto de 1,52% até DD/MM/AAAA."
Sem Desconto	`00`	(Omitir ou lista vazia)	Opcional	`"discount_type_code": "00"` Nenhuma instrução impressa no boleto.

4. Diretrizes de Recebimento Divergente `divergent_receipt`

Define se a rede bancária pode acolher pagamentos com valores diferentes do valor nominal do boleto:

Campo	Tipo	Obrigatoriedade	Regra / Domínio de Valores
`authorization_type_code`	`integer`	Obrigatório	`1`: Não autoriza valor divergente. `2`: Autoriza pagamento dentro de uma faixa (mínimo e máximo). `3`: Autoriza qualquer valor. `4`: Autoriza qualquer valor a partir do valor mínimo.
`minimum_value`	`string`	Condicional*	Obrigatório quando `authorization_type_code` for `2` ou `4`. Valor monetário em R$ (ex: `"50.00"`).
`maximum_value`	`string`	Condicional*	Obrigatório quando `authorization_type_code` for `2`. Valor monetário em R$ (ex: `"500.00"`).

5. Instruções de Protesto `protest`

Instruções para negativação ou envio a cartório em caso de inadimplência:

Campo	Tipo	Obrigatoriedade	Regra / Domínio de Valores
`protest`	`boolean`	Opcional	`true`: Habilita o protesto em cartório por inadimplência. `false`: Desabilita a instrução de protesto.
`protest_type_code`	`integer`	Condicional*	Obrigatório se `protest: true`. `1`: Contagem em dias corridos. `2`: Contagem em dias úteis. `3`: Não protestar.
`number_of_protest_days`	`integer`	Condicional*	Obrigatório se `protest: true`. Quantidade de dias após o vencimento para efetivar o protesto em cartório.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
    "billing_instrument_description": "slip",
    "slip_type": "in_cash",
    "shipping_format": "email",
    "wallet_code": "109",
    "due_type_code": 3,
    "species_code": "01",
    "accepted_code": "S",
    "partial_payment": true,
    "free_text": "Texto livre que pode ser enviado pelo cliente",
    "payer": {
        "taxid_number": "86655450934",
        "taxid_country": "BRA",
        "name": "Gabriel Bernardo Rocha",
        "email": "jorgefkania@gmail.com",
        "address": {
            "street": "Escadaria Marcelo Duarte Nunes",
            "number": "123",
            "complement": "Casa 3",
            "district": "São Pedro",
            "city": "Vitória",
            "state": "ES",
            "zip_code": "29030155",
            "country": "BRA"
        }
    },
    "guarantor_drawer": {
        "name": "Empresa Avalista Exemplo LTDA",
        "taxid_number": "85313416000112",
        "street": "Rua das Flores",
        "number": "100",
        "complement": "Conjunto 12",
        "district": "Centro",
        "city": "Vitória",
        "state": "ES",
        "zip_code": "29010000",
        "country": "BRA"
    },
    "final_beneficiary": {
        "uuid": "b9d543fc-710c-424d-beff-1dbf00b4c616",
        "exclusion_of_final_beneficiary": false
    },
    "individual_data_bill": [
        {
            "due_date": "2026-09-28",
            "total_amount": "20.25",
            "payment_deadline": "2026-09-19",
            "text_your_number": "ABC1234567"
        }
    ],
    "cancel_after_due": {
        "active": true,
        "days": 30
    },
    "fees": {
        "active": true,
        "type": "fixed",
        "interest_type_code": "93",
        "interest_value": "1.25",
        "interest_percentage": "0.025",
        "interest_date": "2026-06-05"
    },
    "fine": {
        "active": true,
        "type": "percentage",
        "code_type_fine": "01",
        "fine_date": "2026-06-05",
        // "percentage_of_fine": "9999999.99999"
        "amount_of_fine": "9.99"
    },
    "discount": {
        "discount_type_code": "02",
        "discounts": [
            {
                "discount_date": "2026-06-01",
                // "discount_value": "2.05"
                "discount_percentage": "1.52"
            }
        ]
    },
    "billing_instruction": [
        {
            "billing_instruction_code": "01",
            "number_of_billing_instruction_days": 99,
            "useful_day": false
        },
        {
            "billing_instruction_code": "05",
            "number_of_billing_instruction_days": 89,
            "useful_day": false
        },
        {
            "billing_instruction_code": "07",
            "number_of_billing_instruction_days": 79,
            "useful_day": false
        }
    ],
    "protest": {
        "active": true,
        "protest_type_code": 1,
        "number_of_protest_days": 99
    },
    "negativation": {
        "negativation": true,
        "code_type_negation": 2,
        "amount_of_negative_days": 2
    },
    "divergent_receipt": {
        "authorization_type_code": 1
    },
    "allowed_actions": {
        "issue_second_copy": true,
        "command_instruction_change_billing_data": true
    }
}

send-invoice

Emissão de Boletos de Cobrança

1. Multa por Atraso `fine`

2. Juros de Mora `fees`

3. Descontos por Antecipação `discount`

4. Diretrizes de Recebimento Divergente `divergent_receipt`

5. Instruções de Protesto `protest`

Requisição

Respostas

send-invoice

Emissão de Boletos de Cobrança#

1. Multa por Atraso fine#

2. Juros de Mora fees#

3. Descontos por Antecipação discount#

4. Diretrizes de Recebimento Divergente divergent_receipt#

5. Instruções de Protesto protest#

Requisição

Respostas

Emissão de Boletos de Cobrança

1. Multa por Atraso `fine`

2. Juros de Mora `fees`

3. Descontos por Antecipação `discount`

4. Diretrizes de Recebimento Divergente `divergent_receipt`

5. Instruções de Protesto `protest`