跳到主要内容

查询资产

此端点允许使用唯一键查询资产的详情。

Request​

ENDPOINT
/security/security/SECURITY-KEY
MÉTODO
GET

Path Params​

字段类型描述字符数
SECURITY-KEYstringsecurity 的唯一键（UUID v4）。36

Response​

STATUS
200
Response Body
{
    "tenant_key": "13a6a1d5-7a3c-4627-a0a6-9fd746662ca4",
    "security_key": "42bd7161-5ec1-4f64-ac0c-861d93ffb4c2",
    "operation_key": "8eb2291e-2dbf-4af1-9d12-f29fac665ed2",
    "operation_type": "commercial_paper",
    "contract_number": "0000000027",
    "issuer_key": "9e08fd62-ce43-4c95-99e0-4386e980d618",
    "issuer_name": "Blue Logic",
    "issuer_document_number": "97.923.586/0001-06",
    "issuer_bank_account": {
        "account_type": "checking",
        "account_digit": "3",
        "account_branch": "0001",
        "account_number": "4464541",
        "financial_institution_ispb": "32402502",
        "financial_institution_code_number": "329"
    },
    "financial_base_date": "2025-02-18",
    "current_unit_price": 1.0,
    "latest_accrual_date": "2025-02-18",
    "integralized_quantity": 100000,
    "issue_quantity": 100000,
    "security_status": "active",
    "is_defaulted": false,
    "financial": {},
    "investment_list": []
}

Response Body Params​

字段类型描述
tenant_keystring与 security 关联的租户唯一键。
security_keystringsecurity 的唯一键。
operation_keystring与 security 关联的操作唯一键。
operation_typestring操作类型。可能的值：commercial_paper。
contract_numberstring与 security 关联的合同编号。
issuer_keystring关联发行人的唯一键。
issuer_namestringsecurity 发行人名称。
issuer_document_numberstring发行人证件号码（CPF/CNPJ）。
issuer_bank_accountobjectissuer_bank_account 对象。
financial_base_datestringsecurity 的财务基准日期。
current_unit_pricenumbersecurity 的当前单价。
latest_accrual_datestring最后一次计息日期。
integralized_quantityinteger已认缴的总股份数量。
issue_quantityinteger操作中发行的总股份数量。
security_statusstringsecurity 状态。可能的值：active、inactive。
is_defaultedboolean指示 security 是否违约（true 或 false）。
financialobjectfinancial 对象。
investment_listarray投资列表。investment 对象。

bank_account 对象​

字段类型描述
account_numberstring发行人银行账户号码。
account_digitstring发行人银行账户校验位。
account_branchstring发行人银行支行。
financial_institution_ispbstring发行人金融机构 ISPB。
financial_institution_code_numberstring发行人金融机构代码。

financial 对象​

字段类型描述
financial_base_datestring财务基准日期。
issue_quantityinteger已发行股份数量。
unit_pricenumber每股单价。
issue_amountnumber发行总金额。
released_amountnumber已释放总金额。
cetnumber总有效成本（CET）。
annual_cetnumber年化总有效成本。
number_of_installmentsinteger总分期数。
prefixed_interest_rateobjectprefixed_interest_rate 对象。
post_fixed_interest_rateobjectpost_fixed_interest_rate 对象。
financial_indexobjectfinancial_index 对象。
fine_delay_rateobjectfine_delay_rate 对象。
contract_fine_ratenumber违约罚款。
feesarray费用列表。fees 对象。
installment_listarray分期列表。installment 对象。

investment 对象​

字段类型描述
investment_keystring投资的唯一键。
acquisition_datestring投资获取日期。
acquisition_unit_pricenumber获取时的单价。
acquisition_amountnumber获取总金额。
acquisition_quantityinteger已获取股份数量。
investor_keystring投资人的唯一键。
investor_namestring投资人名称。
investor_document_numberstring投资人证件（CPF/CNPJ）。
investor_bank_accountobjectinvestor_bank_account 对象。
total_sell_amountnumber已实现销售总金额。
total_yield_amountnumber总收益金额。
total_amortization_amountnumber总摊销金额。
current_quantityinteger当前股份数量。
investment_transaction_listarray交易列表。investment_transaction 对象。

investment_transaction 对象​

字段类型描述
transaction_typestring交易类型（integralization、maturity）。
transaction_datestring交易日期。
transaction_unit_pricenumber交易时的单价。
transaction_amountnumber交易总金额。
transaction_quantityinteger已交易股份数量。
amortization_amountnumber交易中的摊销金额。
yield_amountnumber交易中的收益金额。
old_quantityinteger交易前的股份数量。
new_quantityinteger交易后的股份数量。
investment_transaction_originstring交易来源（subscription、settlement_process_payment）。
investment_transaction_origin_keystring交易来源键。

prefixed_interest_rate 对象​

字段类型描述
daily_ratenumber固定日利率。
annual_ratenumber固定年利率。
monthly_ratenumber固定月利率。
interest_basestring利息计算基础（calendar_days_365）。

post_fixed_interest_rate 对象​

字段类型描述
daily_ratenumber浮动日利率。
annual_ratenumber浮动年利率。
monthly_ratenumber浮动月利率。
interest_basestring利息计算基础（calendar_days_365）。

financial_index 对象​

字段类型描述
index_typestring金融指数类型（CDI、IPCA 等）。
index_valuenumber金融指数值。

fine_delay_rate 对象​

字段类型描述
daily_ratenumber逾期付款日利率。
annual_ratenumber逾期付款年利率。
monthly_ratenumber逾期付款月利率。
interest_basestring利息计算基础（calendar_days_365）。

fees 对象​

字段类型描述
typestring费用类型（internal、external）。
amountnumber费率的百分比或绝对值。
fee_typestring费用类型。
fee_amountnumber已应用费用的货币金额。
amount_typestring金额类型（percentage、absolute）。

installment 对象​

字段类型描述
installment_keystring分期的唯一键。
installment_statusstring分期状态。
installment_numberinteger计划中的分期序号。
workdaysinteger到期前的工作日数量。
calendar_daysinteger到期前的日历日数量。
principal_amortization_unit_pricenumber本金摊销单价。
principal_amortization_amountnumber本金摊销总金额。
interest_amountnumber分期利息总金额。
interest_amount_unit_pricenumber分期利息单价。
post_fixed_interest_amountnumber分期浮动利息总金额。
post_fixed_interest_amount_unit_pricenumber分期浮动利息单价。
amountnumber分期总金额。
due_principalnumber分期前未偿还本金金额。
due_interestnumber分期前未偿还利息金额。
due_datestring分期到期日。
has_interestboolean指示分期是否含有利息（true 或 false）。
current_unit_pricenumber分期更新的单价。
latest_accrual_datestring分期最后计息日期。
paid_atstring分期付款日期（如适用）。
paid_amountnumber分期已支付总金额（如适用）。
settlement_process_listarray清算流程列表。settlement_process 对象

settlement_process 对象​

字段类型描述
settlement_process_keystring清算流程的唯一键。
installment_keystring与清算关联的分期唯一键。
due_datestring关联分期的到期日。
reference_datestring清算参考日期。
current_integralized_quantityinteger清算时已认缴的股份数量。
principal_amortization_amountnumber本金摊销金额。
interest_amountnumber清算中支付的利息总金额。
post_fixed_interest_amountnumber清算中支付的浮动利息金额。
fine_amountnumber已应用罚款金额（如有）。
total_amountnumber清算总金额。
expected_total_amountnumber清算预期总金额。
paid_amountnumber清算中已支付总金额。
settlement_process_statusstring清算状态（waiting_payment、paid、canceled）。
paid_atstring清算付款日期（如适用）。
settlement_process_payment_listarray与清算关联的付款列表。settlement_process_payment 对象

settlement_process_payment 对象​

字段类型描述
settlement_process_payment_keystring清算流程付款的唯一键。
investmentobject投资信息。investment 对象。
investment_quantityinteger付款中涉及的投资股份数量。
amountnumber已付款金额。
paid_atstring付款日期和时间（ISO 8601 格式）。
settlement_process_payment_statusstring付款状态（waiting_payment、paid、canceled）。
settlement_process_payment_typestring付款类型（manual）。
settlement_process_payment_receipt_listarray付款收据列表。settlement_process_payment_receipt 对象。

settlement_process_payment_receipt 对象​

字段类型描述
settlement_process_payment_receipt_keystring清算流程付款收据的唯一键。
settlement_process_payment_receipt_statusstring收据状态（waiting_confirmation、confirmed、denied）。
amountnumber收据金额。
updated_atstring收据最后更新日期和时间（ISO 8601 格式）。

security_status 枚举​

枚举值描述
issuedsecurity 已发行，但尚未激活。
activesecurity 已激活且进行中。
maturedsecurity 已到期。
canceledsecurity 已取消。

installment_status 枚举​

枚举值描述
created分期已创建，但尚未开放付款。
opened分期已开放。
waiting_payment分期等待投资人付款。
paid_partial分期已部分支付。
paid分期已全额支付。
paid_early分期已提前支付。
overdue分期已到期且未支付。
paid_partial_overdue分期在到期后已部分支付。
paid_overdue分期在到期后已支付。
canceled分期已取消，无需支付。
unmonitored分期未被监控付款。