Pular para o conteúdo principal

Cadastro de Operação de CRA

Este endpoint cria uma operação de CRA completa em uma única requisição.

informação

O objeto financial é obrigatório e deve ser enviado já calculado, pois este endpoint não executa a simulação financeira. O emissor e sua conta bancária devem estar previamente cadastrados.

Request​

ENDPOINT
/cra/create_operation
MÉTODO
POST

O corpo da requisição vai desde um payload com os campos obrigatórios (incluindo o objeto financeiro) até um payload completo que inclui também partes relacionadas. Veja as duas variações abaixo.

Payload com os campos obrigatórios
{
    "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
            }
        ]
    }
}
Payload completo (com partes relacionadas)
{
    "tenant_key": "1d29d606-649a-487f-af1c-c0f5cb3e9814",
    "issuer_key": "48e2c597-f2ca-487e-9f06-2b628ecb831e",
    "issue_number": 10,
    "issue_series": 1,
    "contract_number": "CRA-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​

CampoTipoDescriçãoCaracteres Máx.
tenant_key *stringChave única do tenant.-
issuer_key *stringChave única do emissor (previamente cadastrado).-
issue_number *integerNúmero da emissão.-
issue_series *integerSérie da emissão.-
issue_date *stringData de emissão da operação (formato "YYYY-MM-DD").-
investors *arrayLista de investidores envolvidos.Objeto investors
financial *objectDados financeiros já calculados da operação.Objeto financial
contract_numberstringNúmero do contrato.-
related_party_listarrayPartes relacionadas da operação (garantidores, devedores, etc.).Objeto related_party

Objeto investors​

CampoTipoDescrição
investor_key *stringChave única do investidor (previamente cadastrado).
bank_account *objectConta bancária do investidor (Objeto bank_account).
subscription_percentagenumberPercentual de subscrição.
subscription_quantitynumberQuantidade subscrita.

Objeto bank_account​

CampoTipoDescrição
account_number *stringNúmero da conta bancária.
account_digit *stringDígito da conta bancária.
account_branch *stringAgência da conta bancária.
financial_institution_code_numberstringCódigo da instituição financeira.
financial_institution_ispb *stringCódigo ISPB da instituição financeira.
account_type *stringTipo da conta (checking, savings, salary, payment).

Objeto financial​

CampoTipoDescrição
financial_base_date *stringData base financeira (formato "YYYY-MM-DD").
interest_type *stringTipo de juros.
issue_amountnumberValor total emitido.
issue_quantityintegerQuantidade de unidades emitidas.
unit_pricenumberPreço unitário da emissão.
released_amountnumberValor líquido liberado.
cet / annual_cetnumberCusto Efetivo Total (mensal e anual), em percentual.
number_of_installments *integerNúmero de parcelas.
prefixed_interest_rate *objectTaxa de juros prefixada.
fine_delay_rateobjectTaxa de multa por atraso.
contract_fine_ratenumberMulta contratual em percentual.
feesarrayLista de taxas.
installmentsarrayLista de parcelas já calculadas.

Cada item de related_party_list representa uma parte envolvida na operação.

CampoTipoDescrição
person_type *stringTipo de pessoa (natural para PF, legal para PJ).
name *stringNome da parte relacionada.
document_number *stringCPF (PF) ou CNPJ (PJ).
role_type *stringPapel da parte na operação. Enumeradores role_type
street *stringLogradouro.
number *stringNúmero do endereço.
neighborhoodstringBairro.
postal_code *stringCEP (formato "00000-000").
city *stringCidade.
state *stringUF (2 letras).
complementstringComplemento do endereço.
is_pepboolean(PF) Indica se é Pessoa Politicamente Exposta.
marital_statusstring(PF) Estado civil.
property_systemstring(PF) Regime de bens.
birthdatestring(PF) Data de nascimento.
mother_namestring(PF) Nome da mãe.
occupationstring(PF) Ocupação.
trading_namestring(PJ) Nome fantasia.
cnae_codestring(PJ) Código CNAE (formato "00.00-0-00").
company_typestring(PJ) Tipo de empresa.
foundation_datestring(PJ) Data de fundação.
Atenção

Os campos obrigatórios variam conforme o person_type:

  • Pessoa física (natural): além dos campos comuns, is_pep é obrigatório.
  • Pessoa jurídica (legal): além dos campos comuns, trading_name, cnae_code, company_type e foundation_date são obrigatórios.

Enumeradores role_type​

EnumDescrição
issuerEmissor.
investorInvestidor.
cosignerCoobrigado.
fiduciary_debtorDevedor fiduciante.
solidary_debtorDevedor solidário.
guarantorAvalista.
bonafide_depositaryFiel depositário.
intervening_guarantorInterveniente garantidor.
intervening_consentorInterveniente anuente.
intervening_dischargerInterveniente quitante.
assignorCedente.
endorserEndossante.
consultingConsultoria.
fund_administratorAdministrador do fundo.
fund_representativeRepresentante do fundo.
company_representativeRepresentante da empresa.
attestantAnuente / testemunha.
debtorDevedor.
bestowalOutorgante.
managerGestor.
dica

Garantias e lastro são enviados em um endpoint separado, após a criação da operação. Consulte a página Cadastro de lastro desta seção.

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": { ... }
}

A resposta retorna o JSON completo da operação criada, incluindo operation_key, listas de investidores e partes relacionadas, e o objeto financeiro calculado.