跳到主要内容

申请份额锁定

简介​

本资源旨在为投资者创建份额锁定申请。

Input / Output:​

需发送锁定类型以及该锁定类型的特定信息。

作为输出，将返回代表该份额锁定的 quota_lock_key。

适用范围
角色主机所需权限
管理人manager-api写入
顾问consultant-api由集成团队开通

各主机的 Base URL：环境（主机）。

Request​

ENDPOINT
/quota_lock/investor/INVESTOR_KEY/quota_lock
MÉTODO
POST
STATUS
201
担保份额锁定 - CCE - 自然人
{
    "type": "collateral",
    "collateral": {
        "recipient": {
            "name": "Sample Recipient Name",
            "document_number": "000.000.000-00",
            "person_type": "natural_person",
            "natural_person": {
               "birthdate": "YYYY-MM-DD",
               "mother_name": "Sample Recipient Mother Name"
            }
        },
        "borrower": {
            "name": "Sample Borrower Name",
            "document_number": "000.000.000-00",
            "person_type": "natural_person",
            "natural_person": {
               "birthdate": "YYYY-MM-DD",
               "mother_name": "Sample Borrower Mother Name"
            }
        },
        "assets": [
            {
                "asset_type": "cce",
                "credit_operation": {
                    "contract_number": "1000000001",
                    "principal_value": 0.0,
                    "interest_rate_type": "post_fixed",
                    "pre_fixed": {
                        "monthly_rate": 0.0,
                        "calendar_base": "calendar_360"
                    },
                    "post_fixed": {
                        "calendar_base": "workdays",
                        "indexer": "di",
                        "rate": 1,
                        "lag": {
                           "reference": "daily",
                           "amount": 1
                        }
                    }
                }
            }
        ],
        "issuance_series": [
            {
                "issuance_serie_key": "UUID",
                "number_of_quotas": 0.00,
                "financial_value": 0.00
            },
            {
                "issuance_serie_key": "UUID",
                "number_of_quotas": 0.00,
                "financial_value": 0.00
            }
        ],
        "bank_account_key": "UUID"
    }
}
担保份额锁定 - CCE - 法人
{
    "type": "collateral",
    "collateral": {
        "recipient": {
            "name": "Sample Recipient Name",
            "document_number": "00.000.000/0000-00",
            "person_type": "legal_person",
            "legal_person": {
                "activity_code": "00.00-0-00",
                "representatives": [
                    {
                        "name": "Sample Recipient Representative Name",
                        "document_number": "000.000.000-00"
                    }
                ]
            }
        },
        "borrower": {
            "name": "Sample Borrower Name",
            "document_number": "00.000.000/0000-00",
            "person_type": "legal_person",
            "legal_person": {
                "activity_code": "00.00-0-00",
                "representatives": [
                    {
                        "name": "Sample Borrower Representative Name",
                        "document_number": "000.000.000-00"
                    }
                ]
            }
        },
        "assets": [
            {
                "asset_type": "cce",
                "credit_operation": {
                    "contract_number": "1000000001",
                    "principal_value": 0.0,
                    "interest_rate_type": "post_fixed",
                    "pre_fixed": {
                        "monthly_rate": 0.0,
                        "calendar_base": "calendar_360"
                    },
                    "post_fixed": {
                        "calendar_base": "workdays",
                        "indexer": "di",
                        "rate": 1,
                        "lag": {
                           "reference": "daily",
                           "amount": 1
                        }
                    }
                }
            }
        ],
        "issuance_series": [
            {
                "issuance_serie_key": "UUID",
                "number_of_quotas": 0.00,
                "financial_value": 0.00
            },
            {
                "issuance_serie_key": "UUID",
                "number_of_quotas": 0.00,
                "financial_value": 0.00
            }
        ],
        "bank_account_key": "UUID"
    }
}
担保份额锁定 - 租赁合同 - 自然人
{
    "type": "collateral",
    "collateral": {
        "recipient": {
            "name": "Sample Recipient Name",
            "document_number": "000.000.000-00",
            "person_type": "natural_person",
            "natural_person": {
               "birthdate": "YYYY-MM-DD",
               "mother_name": "Sample Recipient Mother Name"
            }
        },
        "borrower": {
            "name": "Sample Borrower Name",
            "document_number": "000.000.000-00",
            "person_type": "natural_person",
            "natural_person": {
               "birthdate": "YYYY-MM-DD",
               "mother_name": "Sample Borrower Mother Name"
            }
        },
        "assets": [
            {
                "asset_type": "rental_contract",
                "rental_contract": {
                    "monthly_value": 0.0,
                    "property_address": {
                        "street": "Sample Street",
                        "number": "123",
                        "neighborhood": "Sample Neighborhood",
                        "city": "Sample City",
                        "uf": "SP",
                        "complement": "Sample Complement",
                        "postal_code": "00000-000",
                        "country": "BRA"
                    },
                    "start_date": "YYYY-MM-DD",
                    "end_date": "YYYY-MM-DD",
                    "readjustment_index": 0.0
                }
            }
        ],
        "issuance_series": [
            {
                "issuance_serie_key": "UUID",
                "number_of_quotas": 0.00,
                "financial_value": 0.00
            }
        ],
        "bank_account_key": "UUID"
    }
}
担保份额锁定 - 租赁合同 - 法人
{
    "type": "collateral",
    "collateral": {
        "recipient": {
            "name": "Sample Recipient Name",
            "document_number": "00.000.000/0000-00",
            "person_type": "legal_person",
            "legal_person": {
                "activity_code": "00.00-0-00",
                "representatives": [
                    {
                        "name": "Sample Recipient Representative Name",
                        "document_number": "000.000.000-00"
                    }
                ]
            }
        },
        "borrower": {
            "name": "Sample Borrower Name",
            "document_number": "00.000.000/0000-00",
            "person_type": "legal_person",
            "legal_person": {
                "activity_code": "00.00-0-00",
                "representatives": [
                    {
                        "name": "Sample Borrower Representative Name",
                        "document_number": "000.000.000-00"
                    }
                ]
            }
        },
        "assets": [
            {
                "asset_type": "rental_contract",
                "rental_contract": {
                    "monthly_value": 0.0,
                    "property_address": {
                        "street": "Sample Street",
                        "number": "123",
                        "neighborhood": "Sample Neighborhood",
                        "city": "Sample City",
                        "uf": "SP",
                        "complement": "Sample Complement",
                        "postal_code": "00000-000",
                        "country": "BRA"
                    },
                    "start_date": "YYYY-MM-DD",
                    "end_date": "YYYY-MM-DD",
                    "readjustment_index": 0.0
                }
            }
        ],
        "issuance_series": [
            {
                "issuance_serie_key": "UUID",
                "financial_application_keys": [
                    "UUID",
                    "UUID"
                ]
            }
        ],
        "bank_account_key": "UUID"
    }
}

Quota Lock​

字段类型描述字符数
typestring份额锁定类型枚举值最多255
collateralJSON担保 对象-

Quota Lock Type​

枚举值描述
collateral担保

Collateral​

字段类型描述字符数必填
recipientJSON受益人 对象-是
borrowerJSON借款人 对象-是
assetsArray资产 对象列表-是
issuance_seriesArray发行系列 对象列表-是
bank_account_keystring与担保关联的银行账户 UUID-否

Recipient​

字段类型描述字符数必填
namestring受益人姓名最多255是
document_numberstring受益人 CPF / CNPJ14或18是
person_typestring自然人或法人枚举值最多255是
natural_personJSON自然人 对象-否
legal_personJSON法人 对象-否

Borrower​

字段类型描述字符数必填
namestring借款人姓名最多255是
document_numberstring借款人 CPF / CNPJ14或18是
person_typestring自然人或法人枚举值最多255是
natural_personJSON自然人 对象-否
legal_personJSON法人 对象-否

Person Type​

枚举值描述
natural_person自然人
legal_person法人

Natural Person​

字段类型描述字符数必填
birthdatestring出生日期10是
mother_namestring母亲姓名最多255是
字段类型描述字符数必填
activity_codestring国家经济活动分类代码 (CNAE)10是
representativesarray代表人 对象列表-是

Representative​

字段类型描述字符数必填
namestring代表人姓名最多255是
document_numberstring代表人 CPF14是

Asset​

字段类型描述字符数必填
asset_typestring资产类型枚举值最多255是
credit_operationJSON信贷操作 对象-否
rental_contractJSON租赁合同 对象-否

Asset Type​

枚举值描述
ccbCCB
cceCCE
rental_contract租赁合同

Credit Operation​

字段类型描述字符数必填
contract_numberstring合同号最多255是
principal_valuestring操作本金价值-是
interest_rate_typestring浮动/固定利率枚举值最多255是
pre_fixedJSON固定利率 对象-否
post_fixedJSON浮动利率 对象-否

Interest Rate Type​

枚举值描述
pre_fixed固定利率
post_fixed浮动利率

Pre fixed​

字段类型描述字符数
calendar_basestring工作日 / 360 天日历 / 365 天日历枚举值最多255
monthly_ratefloat月利率-

Post fixed​

字段类型描述字符数
calendar_basestring工作日 / 360 天日历 / 365 天日历枚举值最多255
indexerstringDI / IPCA 枚举值最多255
ratefloat利率-
lagJSONLag 对象-

calendar_base​

枚举值描述
workdays工作日
calendar_360360 天日历
calendar_365365 天日历

Indexer​

枚举值描述
diDI
ipcaIPCA

Lag​

字段类型描述字符数
referencestring每日 / 每月枚举值最多255
amountintegerLag 数量-

Reference​

枚举值描述
daily每日
monthly每月

Rental Contract​

字段类型描述字符数必填
monthly_valuefloat月租金额-是
property_addressJSON房产的 地址 对象-是
start_datestring合同开始日期（YYYY-MM-DD）10是
end_datestring合同结束日期（YYYY-MM-DD）10是
readjustment_indexfloat合同调整指数-否

Address​

字段类型描述字符数必填
streetstring街道最多255否
numberstring门牌号-否
neighborhoodstring街区最多255否
citystring城市最多255否
ufstring联邦州（2 位字母缩写）2否
complementstring地址补充信息最多255否
postal_codestring邮政编码（CEP），格式为 00000-0009否
countrystring国家代码（3 位字母）3否

Issuance Serie​

字段类型描述字符数必填
issuance_serie_keystring发行系列键36是
number_of_quotasfloat待锁定的份额数量-否
financial_valuefloat待锁定的金融价值-否

Responses​

响应体
{
    "quota_lock_key": "UUID"
}

错误​

认证、权限和主机相关错误：参见 API 错误。