make-billing-slip

Geração de boleto de cobrança.

Obs.: "sender" = Pagador, "recipients" = quem receberá o valor.

Atualização 17/01/2025: Agora o informe de endereço na chave sender_account se tornou obrigatório.
Se o pagador estiver cadastrado na base da agência, o endereço cadastrado será utilizado e se não, o endereço informado será utilizado (Em ambos os casos o envio de endereço é obrigató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 Bodyapplication/json

Exemplo

{
    "external_identifier": "{{externalIdentifier}}",
    "total_amount": "20.00",
    "currency": "{{currency}}",
    "sender_tax_id_number": "11082166928",
    "sender_tax_id_country": "{{country}}",
    "sender_name": "Natan Reis Chmura",
    "sender_address": {
        "street": "Praça Tiradentes",
        "number": "320",
        "complement": "Sala 1",
        "district": "Centro",
        "city": "Curitiba",
        "state": "PR",
        "zip_code": "01310000",
        "country": "BRA"
    },
    "bank": "341",
    "shopper_statement": "APOS O VENCIMENTO COBRAR JUROS DE 1% AO DIA, MULTA DE 2%. DESCONTO DE 5% PARA PAGAMENTO ANTES DO VENCIMENTO",
    "accounting_method": "DEF",
    "interest_rate": 10,
    "fine_percentage": 20,
    "discount_percentage": 50,
    "due_date": "2025-04-30",
    "recipients": [
        {
            "account_id": "{{accountId}}",
            "amount": "20.00",
            "currency": "BRL"
        }
    ]
}

Respostas

🟢200Success

application/json

Body

Exemplo

{
    "transaction_id": "77BCB755-XXXX-XXXX-XXXX-8FE980AE41D5",
    "boleto_url": "https://inovanti-mp-hml-boletos.s3.amazonaws.com/boleto-F4CC0BF9-XXXX-XXXX-XXXX-4633B5FF7EA9.pdf",
    "typeable_line": "3419109008000005131XXXXXX4530007999190000002000",
    "status": "CREATED",
    "due_date": "2024-12-03",
    "transaction_date": "2024-11-26T14:06:24.361-03:00",
    "transaction_type": "BoletoCobranca",
    "total_amount": 20,
    "paid_amount": 20
}