跳到主要内容

创建资产——CCB

用于向转让批次中插入 CCB(Cédula de Crédito Bancário,银行信贷凭证)类资产的端点。每项资产代表一笔将转让给基金的信贷业务。同一接口契约也适用于 structured_cci。

适用范围
角色主机所需权限
管理人manager-api写入
顾问consultant-apiBatches
转让方assignor-api写入

各主机的 Base URL:环境(主机)。

我在流程中的哪一步?

这是转让流程的第 2 步。在此之前,您应已创建批次。插入资产后,请提交所需的文件并结束插入。

注意

信贷业务的 external_id 字段用于在批次内标识资产,不要与批次的 external_id 混淆。

Request​

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/asset
MÉTODO
POST
Request Body
{
"asset_type": "ccb",
"total_purchase_value": 1351.66,
"premiums": [
{
"premium_type": "spread",
"total_value": 13.38
}
],
"credit_operation": {
"contract": {
"number": "0008309052/NBF",
"disbursement_date": "2023-07-06",
"issue_date": "2023-07-06",
"signature_date": "2023-07-06",
"issue_value": 1338.28
},
"amortization_type": "sac",
"borrower": {
"name": "Empresa Exemplo Ltda",
"document_number": "11.222.333/0001-81",
"person_type": "legal_person",
"email": "financeiro@empresaexemplo.com.br",
"address": {
"street": "Pátio de Teixeira",
"number": "1",
"neighborhood": "Estrela do Oriente",
"city": "Rondônia",
"postal_code": "01012-030",
"uf": "RO",
"country": "BRA"
},
"phone": {
"area_code": "11",
"number": "936360268"
},
"legal_person": {
"activity_code": "11.11-1-11"
}
},
"delay": {
"fine": {
"fine_type": "percentage",
"percentage_value": 0.0
},
"interest": {
"method": "compound",
"pre_fixed": {
"monthly_rate": 0.0,
"calendar_base": "calendar_360"
}
}
},
"principal_value": 1338.28,
"interest_rate_type": "pre_fixed",
"external_id": "ccf6f331-d55f-46c0-a32f-fb909884dbb2",
"originator_document_number": "22.333.444/0001-81",
"pre_fixed": {
"calendar_base": "calendar_365",
"monthly_rate": 0.018
},
"installments": [
{
"maturity_date": "2023-10-01",
"installment_number": 1,
"face_value": 689.33
},
{
"maturity_date": "2024-10-01",
"installment_number": 2,
"face_value": 482.53
},
{
"maturity_date": "2025-10-01",
"installment_number": 3,
"face_value": 300.36
},
{
"maturity_date": "2026-10-01",
"installment_number": 4,
"face_value": 162.77
},
{
"maturity_date": "2027-10-01",
"installment_number": 5,
"face_value": 81.39
},
{
"maturity_date": "2028-10-01",
"installment_number": 6,
"face_value": 40.69
}
],
"modality_code": "0202",
"consignee": {
"consignee_type": "inss",
"name": "Consignee name",
"document_number": "33.444.555/0001-81"
},
"collaterals": [
{
"collateral_type": "social_security",
"benefit_number": "0000000000",
"benefit_type": "benefit_type",
"status": "reserved"
}
]
}
}

请求体属性​

字段类型是否必填描述
asset_typestring必填资产类型。CCB 请填写 ccb。
total_purchase_valuenumber必填资产的购买总额——即受让方实际支付的金额。最多 2 位小数。
premiumsarray可选交易中涉及的溢价列表。参见 premiums 属性。
deductionsarray可选交易中涉及的折价列表。参见 deductions 属性。
credit_operationobject必填信贷业务数据。参见 credit_operation 属性。
溢价和折价计入金额核对

插入时,QI Tech 计算各分期的现值,并与资产的购买价值进行比较:total_purchase_value − premiums 之和 + deductions 之和。较小的差额会被自动记录为调整项(math_adjustment);超出范围时,插入返回 TRC100014。

premiums 属性​

字段类型是否必填描述
premium_typestring必填溢价类型:spread、math_adjustment、banker_fee、transaction_fee 或 originator_fee。
total_valuenumber必填溢价总额。最小值 0.01。最多 2 位小数。

deductions 属性​

字段类型是否必填描述
deduction_typestring必填折价类型:bad_debt_discount 或 math_adjustment。
total_valuenumber必填折价总额。最小值 0.01。最多 2 位小数。

credit_operation 属性​

字段类型是否必填描述
external_idstring必填该资产在合作伙伴系统中的唯一标识 key。最多 50 个字符。
originator_document_numberstring必填促成该业务的发起人的 CPF 或 CNPJ,带格式(000.000.000-00 或 00.000.000/0000-00)。必须已在 QI Tech 注册;否则返回 TRC000019。
principal_valuenumber必填该业务的未偿本金总额。最多 8 位小数。
contractobject必填合同数据。参见 contract 属性。
borrowerobject必填付款人/债务人数据。参见 borrower 属性。
amortization_typestring必填计算所使用的摊销类型。
interest_rate_typestring必填该业务的利率类型。
pre_fixedobject条件必填固定利率部分的计算数据。interest_rate_type 为 pre_fixed 时必填。参见 pre_fixed 属性。
post_fixedobject条件必填浮动利率部分的计算数据。interest_rate_type 为 post_fixed 时必填。参见 post_fixed 属性。
installmentsarray必填该业务的分期列表。参见 installments 属性。
delayobject必填逾期罚金和逾期利息数据。参见 delay 属性。
modality_codestring可选4 位代码,指定与该资产相关的金融业务类别或类型。省略时使用转让配置中的值。
b3_codestring可选资产在 B3 的代码。最多 50 个字符。仅当转让配置使用 registry_transfer、deferred_registry 或 external_registry 登记方式时接受;其他情况返回 TRC000188。
b3_self_codestring可选资产在 B3 的自有代码。最多 50 个字符。规则同 b3_code。
consigneeobject可选代扣机构数据。参见 consignee 属性。
collateralsarray可选与该业务关联的担保列表。参见 collaterals 属性。

amortization_type 枚举值:

值描述
sacSAC 摊销。
pricePrice 摊销。
price_days按自然日计息的 Price 摊销。

interest_rate_type 枚举值:

值描述
pre_fixed用于固定利率业务。请提供 pre_fixed 对象。
post_fixed用于浮动利率业务。请提供 post_fixed 对象。

contract 属性​

字段类型是否必填描述
numberstring必填合同编号。最多 50 个字符。
disbursement_datestring必填放款日期,格式为 YYYY-MM-DD。
issue_datestring必填签发日期,格式为 YYYY-MM-DD。
signature_datestring可选合同签署日期,格式为 YYYY-MM-DD。
issue_valuenumber必填合同签发金额。最多 2 位小数。

borrower 属性​

字段类型是否必填描述
namestring必填付款人名称。最多 255 个字符。
document_numberstring必填付款人的 CPF 或 CNPJ。
person_typestring必填人员类型。
emailstring可选付款人的邮箱。最多 255 个字符。
addressobject可选付款人的地址。参见 address 属性。
phoneobject可选付款人的电话。参见 phone 属性。

person_type 枚举值:

值描述
natural_person自然人。会校验 document_number 中 CPF 的校验位。填写该值时,在 borrower 中包含 natural_person 对象。参见 natural_person 属性。
legal_person法人。填写该值时,在 borrower 中包含 legal_person 对象。参见 legal_person 属性。

address 属性​

字段类型是否必填描述
streetstring可选街道。如信息不完整,请将汇总信息填写在此字段中。最多 255 个字符。
numberstring可选门牌号。最多 40 个字符。
neighborhoodstring可选街区。最多 255 个字符。
citystring可选城市。最多 255 个字符。
ufstring可选州缩写,大写(例如:SP)。
complementstring可选地址补充信息。最多 255 个字符。
postal_codestring必填邮政编码(CEP),格式为 00000-000。只要提供了 address 对象就必填。
countrystring可选国家,ISO 3166-1 alpha-3 格式。3 个字符。

phone 属性​

字段类型是否必填描述
area_codestring必填区号(DDD)。2 位数字。
numberstring必填电话号码。8 或 9 位数字。
international_dial_codestring可选国际区号(DDI)。最多 3 个字符。

natural_person 属性​

字段类型是否必填描述
birthdatestring可选出生日期,格式为 YYYY-MM-DD。
genderstring可选性别。
mother_namestring可选母亲姓名。最多 255 个字符。

gender 枚举值:

值描述
male男。
female女。
字段类型是否必填描述
foundation_datestring可选成立日期,格式为 YYYY-MM-DD。
activity_codestring可选经营活动代码(CNAE),格式为 11.11-1-11。
annual_revenuesinteger可选年收入,以分为单位。
representativesarray可选法定代表人列表。参见 representatives 属性。

representatives 属性​

字段类型是否必填描述
namestring必填代表的姓名。最多 255 个字符。
document_numberstring必填代表的 CPF 或 CNPJ。
emailstring必填代表的邮箱。最多 255 个字符。
phoneobject必填电话。结构同 phone 属性。
addressobject必填地址。结构同 address 属性。
person_typestring可选人员类型(natural_person 或 legal_person)。
representative_typestring可选代表类型。最多 50 个字符。

pre_fixed 属性​

字段类型是否必填描述
calendar_basestring必填所使用的计算基准。
monthly_ratenumber必填合同月利率,以 0 到 1 之间的小数表示。1% 请填写 0.01。最多 8 位小数。
nominal_monthly_ratenumber可选合同名义月利率,格式同 monthly_rate。

calendar_base 枚举值:

值描述
workdays以工作日(252)为计算基准。
calendar_365以 365 天为计算基准。
calendar_360以 360 天为计算基准。

post_fixed 属性​

字段类型是否必填描述
calendar_basestring必填调整所用的计日基准。枚举值同 calendar_base。
indexerstring必填业务所参照的指数:di、selic 或 ipca。
ratenumber必填对指数适用的比例。100% DI 请填写 1。
lagobject必填指数滞后:reference(daily 或 monthly)和 amount(数量)。如需使用两个月前的指数,请填写 {"reference": "monthly", "amount": 2}。

installments 属性​

字段类型是否必填描述
maturity_datestring必填分期到期日,格式为 YYYY-MM-DD。
installment_numberinteger必填分期期数。
face_valuenumber必填分期面值。最多 8 位小数。
principal_valuenumber可选预计在到期日摊还的本金。最多 8 位小数。
external_idstring可选该分期在您系统中的标识。

delay 属性​

字段类型是否必填描述
fineobject必填逾期罚金数据。参见 fine 属性。无罚金时,请发送 fine_type percentage 且 percentage_value 为 0。
interestobject必填逾期利息数据。参见 interest 属性。无逾期利息时,请发送 monthly_rate 0。

fine 属性​

字段类型是否必填描述
fine_typestring必填罚金类型。
percentage_valuenumber条件必填fine_type 为 percentage 时的罚金值。取值 0 到 1,对应 0% 到 100%。最多 2 位小数。
amountnumber条件必填fine_type 为 fixed 时的固定罚金金额。最多 2 位小数。

fine_type 枚举值:

值描述
percentage按分期金额的百分比计算罚金。
fixed固定金额罚金。

interest 属性​

字段类型是否必填描述
methodstring必填逾期利息的计算方法。
pre_fixedobject必填逾期利息利率:calendar_base 加 monthly_rate 或 daily_rate。不接受 nominal_monthly_rate。见逾期利息的 pre_fixed 属性。

method 枚举值:

值描述
compound复利计算逾期利息。
simple单利计算逾期利息。
pre_fixed固定利率计算逾期利息。

consignee 属性​

字段类型是否必填描述
namestring可选代扣机构名称。最多 255 个字符。
document_numberstring必填代扣机构的 CPF 或 CNPJ。
consignee_typestring必填代扣贷款类型。

consignee_type 枚举值:

值描述
public公共部门代扣贷款。
private私营部门代扣贷款。
inssINSS 代扣贷款。

collaterals 属性​

字段类型是否必填描述
collateral_typestring必填担保类型。
如何构造 collaterals

collaterals 是一个列表,每一项代表一项担保。collateral_type 决定该项可接受的字段——某一类型的字段在其他类型中不被接受。任何不属于所填类型字段集合的属性都会被拒绝并返回 QIT000001。

collateral_type 枚举值:

值描述
fgtsFGTS 担保。包含 FGTS 担保属性中的字段。
social_securityINSS 担保。包含 INSS 担保属性中的字段。
home_equity不动产担保。包含不动产担保属性中的字段。
vehicle车辆担保。包含车辆担保属性中的字段。

FGTS 担保属性​

字段类型是否必填描述
protocol_numberstring必填协议编号。
statusstring必填担保状态。

INSS 担保属性​

字段类型是否必填描述
benefit_numberstring必填福利编号。
benefit_typestring必填福利类型。
statusstring必填担保状态。

不动产担保属性​

字段类型是否必填描述
enterprise_namestring必填项目名称。
registration_numberstring必填不动产登记编号。
enterprise_document_numberstring可选与该项目关联的 CPF 或 CNPJ。
collateral_propertiesarray必填不动产列表。参见 collateral_properties 属性。

collateral_properties 属性​

字段类型是否必填描述
addressobject必填不动产地址。结构同 address 属性。
total_collateral_valuenumber必填不动产价值。最多 8 位小数。

车辆担保属性​

字段类型是否必填描述
vehicle_loan_valuenumber可选车辆融资金额。不得为负数。
vehicle_total_market_valuenumber可选车辆总市场价值。不得为负数。
vehicle_identificationobject必填车辆识别信息。参见 vehicle_identification 属性。
车辆担保示例
{
"collateral_type": "vehicle",
"vehicle_loan_value": 30000.00,
"vehicle_total_market_value": 55000.00,
"vehicle_identification": {
"brand": "Toyota",
"model": "Corolla XEi 2.0",
"manufacturing_year": 2022,
"chassis_number": "9BRBLWHEXK0123456",
"license_plate": "ABC1D23",
"renavam": "12345678901"
}
}

vehicle_identification 属性​

字段类型是否必填描述
brandstring可选车辆品牌。
modelstring必填车辆型号。
manufacturing_yearinteger必填车辆生产年份。最小值 1900。
chassis_numberstring必填车架号。
license_platestring可选车牌号。
renavamstring可选车辆的 RENAVAM 代码。

Response​

STATUS
201
Response Body
{
"asset_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"external_id": "ccf6f331-d55f-46c0-a32f-fb909884dbb2",
"status": "pending_eligibility"
}

响应属性​

字段类型描述
asset_keystringQI Tech 生成的资产唯一标识(UUID)。
external_idstring与 credit_operation 的 external_id 字段中提供的外部 key 相同。
statusstring资产的初始状态。始终返回 pending_eligibility,表示资产已插入,等待合格性审查。

错误​

状态码代码触发条件
400QIT000001请求体不符合预期格式:缺少必填字段、类型或格式无效。description 会指出具体字段。
404TRC000018该转让配置中不存在使用此 assignment_external_id 的批次。
404TRC000015该 asset_type 不存在。
400TRC000025asset_type 与转让配置的资产类型不同。
400TRC000022批次不再接受资产:插入已结束。如需添加更多资产,请重新开放批次。
400TRC000009originator_document_number 或自然人付款人的 document_number 中的 CPF 或 CNPJ 无效。
404TRC000019没有使用所提供 originator_document_number 注册的发起人。尽管标题为 Originator bond not found,该错误与和配置的关联无关。
400TRC000188在登记类型不接受 b3_code 或 b3_self_code 的配置中发送了这些字段。
409TRC000054该批次中已存在使用此 external_id 的资产。
400TRC100014分期现金流的现值与购买价值(total_purchase_value、溢价和折价)不符。
400TRC100004 / TRC100005分期编号不连续,或未按到期日升序排列。
400TRC100009issue_value 小于该业务的本金。
409TRC100017基金不能购买已逾期的资产。

TRC1000xx 代码来自插入时进行的资产财务校验。错误体格式如下:

{
"title": "Already Exist This External Id",
"description": "Already exist an asset with this External Id and asset_key->41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"translation": "Ja existe um ativo com esse External Id e asset_key->41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"code": "TRC000054"
}

如发生错误,请重发请求。重复(TRC000054)表示该资源已存在:请通过资产查询端点查询它,而不是重新创建。详见重发与重复。

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

后续步骤​

插入资产后,流程继续:

  1. 提交文件——为每项通过合格性审查的资产提交所需文件。
  2. 结束插入——表明所有资产均已插入,以便批次进入合格性审查。