Skip to main content

Register Debenture Operation

This endpoint creates a complete Debenture operation in a single request.

info

The financial object is required and must be sent already calculated, as this endpoint does not run the financial simulation. The issuer and its bank account must be previously registered.

Request​

ENDPOINT
/debenture/create_operation
METHOD
POST

The request body ranges from a payload with the required fields (including the financial object) to a complete payload that also includes related parties. See both variations below.

Payload with the required fields
{
    "tenant_key": "1d29d606-649a-487f-af1c-c0f5cb3e9814",
    "issuer_key": "48e2c597-f2ca-487e-9f06-2b628ecb831e",
    "issue_number": 10,
    "issue_series": 1,
    "issue_date": "2025-01-20",
    "investors": [
        {
            "investor_key": "70b1b638-ca56-4eb3-9a88-2fd5ffd077a7",
            "bank_account": {
                "account_number": "33400254",
                "account_digit": "3",
                "account_branch": "0001",
                "financial_institution_code_number": "329",
                "financial_institution_ispb": "32402502",
                "account_type": "checking"
            }
        }
    ],
    "financial": {
        "financial_base_date": "2025-01-20",
        "interest_type": "pre_price_days",
        "issue_amount": 1075268.82,
        "issue_quantity": 1075268,
        "unit_price": 1.0000007626,
        "released_amount": 1075268.82,
        "cet": 7.7,
        "annual_cet": 143.55,
        "first_due_date": "2025-02-20",
        "number_of_installments": 5,
        "prefixed_interest_rate": {
            "interest_base": "calendar_days_365",
            "monthly_rate": 0.05,
            "daily_rate": 0.0016053474,
            "annual_rate": 0.795856326
        },
        "fine_delay_rate": { "interest_base": "calendar_days_365", "monthly_rate": 0.01 },
        "contract_fine_rate": 0.02,
        "fees": [
            { "amount": 2.0, "fee_amount": 21505.38, "amount_type": "percentage", "fee_type": "bookkeeping_fee", "type": "internal" }
        ],
        "installments": [
            {
                "installment_number": 1,
                "due_date": "2025-02-20",
                "amount": 248113.17,
                "principal_amortization_amount": 193292.79655634,
                "principal_amortization_unit_price": 1.02,
                "interest_amount": 0.0,
                "calendar_days": 31,
                "workdays": 23
            }
        ]
    }
}
Complete payload (with related parties)
{
    "tenant_key": "1d29d606-649a-487f-af1c-c0f5cb3e9814",
    "issuer_key": "48e2c597-f2ca-487e-9f06-2b628ecb831e",
    "issue_number": 10,
    "issue_series": 1,
    "contract_number": "DEB-2025-0001",
    "issue_date": "2025-01-20",
    "investors": [
        {
            "investor_key": "70b1b638-ca56-4eb3-9a88-2fd5ffd077a7",
            "subscription_percentage": 100,
            "bank_account": {
                "account_number": "33400254",
                "account_digit": "3",
                "account_branch": "0001",
                "financial_institution_code_number": "329",
                "financial_institution_ispb": "32402502",
                "account_type": "checking"
            }
        }
    ],
    "financial": {
        "financial_base_date": "2025-01-20",
        "interest_type": "pre_price_days",
        "issue_amount": 1075268.82,
        "issue_quantity": 1075268,
        "unit_price": 1.0000007626,
        "released_amount": 1075268.82,
        "cet": 7.7,
        "annual_cet": 143.55,
        "first_due_date": "2025-02-20",
        "number_of_installments": 5,
        "prefixed_interest_rate": {
            "interest_base": "calendar_days_365",
            "monthly_rate": 0.05,
            "daily_rate": 0.0016053474,
            "annual_rate": 0.795856326
        },
        "fine_delay_rate": { "interest_base": "calendar_days_365", "monthly_rate": 0.01 },
        "contract_fine_rate": 0.02,
        "fees": [
            { "amount": 2.0, "fee_amount": 21505.38, "amount_type": "percentage", "fee_type": "bookkeeping_fee", "type": "internal" }
        ],
        "installments": [
            {
                "installment_number": 1,
                "due_date": "2025-02-20",
                "amount": 248113.17,
                "principal_amortization_amount": 193292.79655634,
                "principal_amortization_unit_price": 1.02,
                "interest_amount": 0.0,
                "calendar_days": 31,
                "workdays": 23
            }
        ]
    },
    "related_party_list": [
        {
            "person_type": "legal",
            "name": "Garantidora S.A.",
            "document_number": "12.345.678/0001-90",
            "trading_name": "Garantidora",
            "cnae_code": "64.62-0-00",
            "company_type": "sa",
            "foundation_date": "2010-05-01",
            "street": "Av. Paulista",
            "number": "1000",
            "neighborhood": "Bela Vista",
            "postal_code": "01310-100",
            "city": "São Paulo",
            "state": "SP",
            "role_type": "guarantor"
        },
        {
            "person_type": "natural",
            "name": "João da Silva",
            "document_number": "123.456.789-00",
            "street": "Rua das Flores",
            "number": "123",
            "neighborhood": "Centro",
            "postal_code": "01001-000",
            "city": "São Paulo",
            "state": "SP",
            "role_type": "solidary_debtor",
            "is_pep": false
        }
    ]
}

Request Body Params​

FieldTypeDescriptionMax Characters
tenant_key *stringUnique tenant key.-
issuer_key *stringUnique issuer key (previously registered).-
issue_number *integerIssue number.-
issue_series *integerIssue series.-
issue_date *stringOperation issue date (format "YYYY-MM-DD").-
investors *arrayList of involved investors.investors Object
financial *objectAlready-calculated operation financial data.financial Object
contract_numberstringContract number.-
related_party_listarrayOperation related parties (guarantors, debtors, etc.).related_party Object

investors Object​

FieldTypeDescription
investor_key *stringUnique investor key (previously registered).
bank_account *objectInvestor bank account (bank_account Object).
subscription_percentagenumberSubscription percentage.
subscription_quantitynumberSubscribed quantity.

bank_account Object​

FieldTypeDescription
account_number *stringBank account number.
account_digit *stringBank account digit.
account_branch *stringBank account branch.
financial_institution_code_numberstringFinancial institution code.
financial_institution_ispb *stringFinancial institution ISPB code.
account_type *stringAccount type (checking, savings, salary, payment).

financial Object​

FieldTypeDescription
financial_base_date *stringFinancial base date (format "YYYY-MM-DD").
interest_type *stringInterest type.
issue_amountnumberTotal issued amount.
issue_quantityintegerQuantity of issued units.
unit_pricenumberUnit price of the issuance.
released_amountnumberNet released amount.
cet / annual_cetnumberTotal Effective Cost (monthly and annual), in percentage.
number_of_installments *integerNumber of installments.
prefixed_interest_rate *objectPrefixed interest rate.
fine_delay_rateobjectDelay fine rate.
contract_fine_ratenumberContractual fine in percentage.
feesarrayList of fees.
installmentsarrayList of already-calculated installments.

Each item in related_party_list represents a party involved in the operation.

FieldTypeDescription
person_type *stringPerson type (natural for individuals, legal for companies).
name *stringRelated party name.
document_number *stringCPF (individual) or CNPJ (company).
role_type *stringParty role in the operation. role_type Enumerators
street *stringStreet.
number *stringAddress number.
neighborhoodstringNeighborhood.
postal_code *stringPostal code (format "00000-000").
city *stringCity.
state *stringState (2 letters).
complementstringAddress complement.
is_pepboolean(Individual) Whether the person is a Politically Exposed Person.
marital_statusstring(Individual) Marital status.
property_systemstring(Individual) Property regime.
birthdatestring(Individual) Date of birth.
mother_namestring(Individual) Mother's name.
occupationstring(Individual) Occupation.
trading_namestring(Company) Trading name.
cnae_codestring(Company) CNAE code (format "00.00-0-00").
company_typestring(Company) Company type.
foundation_datestring(Company) Foundation date.
Attention

Required fields vary by person_type:

  • Individual (natural): in addition to the common fields, is_pep is required.
  • Company (legal): in addition to the common fields, trading_name, cnae_code, company_type and foundation_date are required.

role_type Enumerators​

EnumDescription
issuerIssuer.
investorInvestor.
cosignerCo-obligor.
fiduciary_debtorFiduciary debtor.
solidary_debtorJoint debtor.
guarantorGuarantor (aval).
bonafide_depositaryBona fide depositary.
intervening_guarantorIntervening guarantor.
intervening_consentorIntervening consentor.
intervening_dischargerIntervening discharger.
assignorAssignor.
endorserEndorser.
consultingConsulting.
fund_administratorFund administrator.
fund_representativeFund representative.
company_representativeCompany representative.
attestantAttestant.
debtorDebtor.
bestowalGrantor.
managerManager.
tip

Collateral and underlying assets are sent through a separate endpoint, after the operation is created. See the Send collateral page in this section.

Response​

STATUS
201
Response Body
{
    "tenant_key": "1d29d606-649a-487f-af1c-c0f5cb3e9814",
    "operation_key": "a846cc4a-b542-4f66-9823-b6d5458bd127",
    "operation_status": "finished",
    "issuer_key": "48e2c597-f2ca-487e-9f06-2b628ecb831e",
    "issuer_name": "Dynamic Enterprises",
    "issuer_document_number": "28980395000155",
    "issue_number": 10,
    "issue_series": 1,
    "related_party_list": [ ... ],
    "financial": { ... }
}

The response returns the complete JSON of the created operation, including operation_key, the investor and related-party lists, and the calculated financial object.