跳到主要内容

在操作中添加担保品

此端点集合允许添加与操作关联的担保品。担保品(collateral)将与操作文件一同提交签名。每种担保品类型都有其所需文件的规则,所有担保品类型均在本文档中涵盖。


提交担保品 (POST)​

Request​

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/collateral
MÉTODO
POST

Path Params​

字段类型描述最大字符数
OPERATION-KEY *string操作的唯一键(UUID v4)。36

担保品系统支持添加不同类型的工具,每种类型都有其附加文件的配置。本节涵盖所有可用的担保品模型及其相应的 payload。

担保品类型​

1 - 不动产信托转让

2 - 车辆信托转让

3 - 航空器信托转让

4 - 设备/产品/库存信托转让

5 - 艺术品信托转让

6 - 有价证券信托转让

7 - 股份和份额信托转让

8 - 信贷权信托转让

9 - 不动产抵押

10 - 船舶抵押

11 - 保证人

12 - 担保人

13 - 银行保函

14 - 信用卡应收款

15 - 库存担保

16 - 担保品监控

17 - 车辆库存担保 (Floor Plan)

18 - 其他担保品

不动产信托转让​

Request Body
{
"collateral_document_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
"collateral_type": "fiduciary_alienation_property",
"additional_documents": [
{
"document_type": "property_appraisal_report",
"document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff"
},
{
"document_type": "property_registration_updated",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "property_full_content_certificate",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "property_insurance_policy",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
}
]
}

文件类型​

枚举值描述
property_appraisal_report**不动产评估报告。
property_registration_updated**最新产权登记。
property_full_content_certificate**产权完整内容证明。
property_insurance_policy保险单(合同规定时要求)。
others其他文件。
注意

(**) 不动产信托转让必须提供

车辆信托转让​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_vehicle",
"additional_documents": [
{
"document_type": "vehicle_appraisal_report",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "vehicle_inspection_report",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "vehicle_crv_certificate",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
}
]
}

文件类型​

枚举值描述
vehicle_appraisal_report**车辆评估报告(最多延迟30天)或 FIPE 表。
vehicle_inspection_report**车辆检验报告。
vehicle_crv_certificate**最新车辆登记证书(CRLV)。
others其他文件。
注意

(**) 车辆信托转让必须提供

航空器信托转让​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_aircraft",
"additional_documents": [
{
"document_type": "aircraft_certificate_anac",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "aircraft_rab_consult",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "aircraft_insurance_policy",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
},
{
"document_type": "aircraft_appraisal_report",
"document_key": "df608f78-5293-4f96-ab60-31185633b52c"
}
]
}

文件类型​

枚举值描述
aircraft_certificate_anac**登记证书 - ANAC。
aircraft_rab_consult**巴西航空登记册中的航空器查询。
aircraft_insurance_policy**保险单 - 受益人为基金。
aircraft_appraisal_report**航空器评估报告。
others其他文件。
注意

(**) 航空器信托转让必须提供

设备产品和库存信托转让​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_equipment",
"additional_documents": [
{
"document_type": "equipment_purchase_invoice",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "fiduciary_depositary_declaration",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "equipment_appraisal_report",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
},
{
"document_type": "equipment_insurance_policy",
"document_key": "df608f78-5293-4f96-ab60-31185633b52c"
}
]
}

文件类型​

枚举值描述
equipment_purchase_invoice**发票 - 购买记录。
equipment_appraisal_report**设备评估报告(最多延迟30天)。
equipment_insurance_policy设备保险单(合同规定时要求)。
fiduciary_depositary_declaration忠实保管人声明。
others其他文件。
注意

(**) 设备/产品/库存信托转让必须提供

艺术品信托转让​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_artwork",
"additional_documents": [
{
"document_type": "artwork_appraisal_report",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "artwork_storage_certificate",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
}
]
}

文件类型​

枚举值描述
artwork_appraisal_report**艺术品评估报告。
artwork_storage_certificate**带合规证书的存储地点。
artwork_insurance_policy保险单(合同规定时要求)。
others其他文件。
注意

(**) 艺术品信托转让必须提供

有价证券信托转让​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_alienation_securities",
"additional_documents": [
{
"document_type": "securities_negotiation_block",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}

文件类型​

枚举值描述
securities_negotiation_block**在托管方处的交易冻结。
securities_registration_gravame带合规证书的存储地点。
others其他文件。
注意

(**) 有价证券信托转让必须提供

股份和份额信托转让​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_assignment_shares",
"additional_documents": [
{
"document_type": "share_registration_book",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}

文件类型​

枚举值描述
share_registration_book**带质押注记的记名股份登记簿。
others其他文件。
注意

(**) 股份/份额信托转让/质押必须提供

信贷权信托转让​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "fiduciary_assignment_shares"
}

文件类型​

枚举值描述
others其他文件。

不动产抵押​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "mortgage_property",
"additional_documents": [
{
"document_type": "property_appraisal_report",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "property_registration",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "property_insurance_policy",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
},
{
"document_type": "property_full_content_certificate",
"document_key": "df608f78-5293-4f96-ab60-31185633b52c"
}
]
}

文件类型​

枚举值描述
property_appraisal_report**不动产评估报告。
property_registration**最新产权登记。
property_full_content_certificate**产权完整内容证明。
property_insurance_policy保险单(合同规定时要求)。
others其他文件。
注意

(**) 不动产抵押必须提供

船舶抵押​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "mortgage_ship",
"additional_documents": [
{
"document_type": "ship_registration",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "ship_appraisal_report",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "ship_insurance_policy",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
}
]
}

文件类型​

枚举值描述
ship_registration**最新船舶产权登记。
ship_appraisal_report**船舶评估报告(最多延迟3个月)。
ship_insurance_policy船舶保险单(合同规定时要求)。
others其他文件。
注意

(**) 船舶抵押必须提供

保证人​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "guarantor",
"additional_documents": [
{
"document_type": "guarantor_civil_status_declaration",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "guarantor_personal_document",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
}
]
}

文件类型​

枚举值描述
guarantor_civil_status_declaration**保证人婚姻状况声明。
guarantor_personal_document**保证人个人证件。
guarantor_income_tax_declaration保证人所得税申报表。
others其他文件。
注意

(**) 保证人必须提供

担保人​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "surety",
"additional_documents": [
{
"document_type": "surety_civil_status_declaration",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "surety_personal_document",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
},
{
"document_type": "surety_income_tax_declaration",
"document_key": "4cc6d706-551f-4d5e-8539-1b59b2f96cff"
}
]
}

文件类型​

枚举值描述
surety_civil_status_declaration**担保人婚姻状况声明。
surety_personal_document**担保人个人证件。
surety_income_tax_declaration担保人所得税申报表。
others其他文件。
注意

(**) 担保人必须提供

银行保函​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "bank_surety",
"additional_documents": [
{
"document_type": "others",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}

文件类型​

枚举值描述
others其他文件。

信用卡应收款​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "card_receivables",
"additional_documents": [
{
"document_type": "others",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}

文件类型​

枚举值描述
others其他文件。

库存担保​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "stock_guarantee",
"additional_documents": [
{
"document_type": "others",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
]
}

文件类型​

枚举值描述
others其他文件。

担保品监控​

Request Body
{
"collateral_document_key": "a14e8b2c-bda7-4f3d-aebb-ae63822428ff",
"collateral_type": "monitoring_guarantee",
"additional_documents": [
{
"document_type": "guarantee_contract",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
},
{
"document_type": "guarantee_agent_contract",
"document_key": "210c38b5-6b61-4b74-b042-19ebef77e360"
}
]
}

文件类型​

枚举值描述
guarantee_contract**担保合同。
guarantee_agent_contract**担保代理合同。
others其他文件。
注意

(**) 担保品监控必须提供

车辆库存担保 (Floor Plan)​

在 Floor Plan 操作中使用的担保品模式,发行人以车辆库存作为操作的担保品。与其他类型不同,此模式不使用 collateral_document_key——每个担保品代表一辆车,通过 vehicle 字段提交。

如需登记 N 辆车,请发送 N 次 POST 请求,每次一辆车。每次请求都会创建一个独立的担保品,拥有各自的 collateral_key 和 collateral_status。

Request Body
{
"collateral_type": "vehicle_stock",
"additional_documents": [
{
"document_type": "vehicle_crlv_certificate",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
],
"vehicle": {
"chassis": "9BWZZZ377VT004251",
"plate": "ABC1D23",
"plate_state": "SP",
"renavam": "12345678901",
"value": 85000.00,
"year": 2023,
"mileage": 32000
}
}

vehicle 对象​

字段类型描述必填
chassis *string车辆底盘号(车架号)。17 位大写字母或数字。是
platestring车牌号,Mercosul 格式或旧格式。否**
plate_statestring车辆登记所在州(缩写)。否**
renavamstring车辆 RENAVAM 编号。9 至 11 位数字。否**
valuenumber车辆价值。大于或等于 0。否
yearinteger车辆年份。大于或等于 1900,且最多为当前年份的下一年。否
mileageinteger车辆里程。大于或等于 0。要求同时提供 plate、plate_state 和 renavam。否
注意

() plate、plate_state 和 renavam 构成一个全有或全无**的字段组:车辆必须同时提交这三个字段(已上牌/二手车),或三个都不提交(尚未上牌的新车)。只提交其中一部分会被拒绝并返回验证错误 (400)。新车也不能提交 mileage。

文件类型​

枚举值描述
vehicle_crlv_certificate车辆登记和年检证书 (CRLV)。

CRLV 通过请求体根级的 additional_documents 提交(参见 additional_documents 列表)。提交为可选项,且仅接受 vehicle_crlv_certificate 类型。该文件会保存到担保品中,并在响应的 additional_documents 字段中返回,而不是在 collateral_data 中。

车辆验证​

登记时,系统会在 B3 车辆库存数据库中查询(不进行登记锁定)该车辆:

  • 车辆可用(无有效预留或在 B3 中未找到):担保品创建为 validated,请求返回 201 及该担保品。
  • 车辆在 B3 有有效预留或查询出错:担保品保存为 canceled,请求返回 422 及错误码 COM000087。已取消的担保品在错误响应体的 collateral 字段中返回。canceled 状态的担保品不会进入合同草稿或发行,也不会出现在操作的担保品列表中。
  • 底盘号已存在于同一操作的另一个 validated 担保品中:请求被拒绝并返回 409 (COM000085),不保存任何数据。如果某底盘号之前的担保品已被取消,可以重新提交。

Response​

Response Body (201)
{
"collateral_key": "8a0c6e0e-3f5b-4c2a-9d7e-1b2f3c4d5e6f",
"collateral_type": "vehicle_stock",
"collateral_status": "validated",
"collateral_data": {
"vehicle": {
"chassis": "9BWZZZ377VT004251",
"plate": "ABC1D23",
"plate_state": "SP",
"renavam": "12345678901",
"value": 85000.00,
"year": 2023,
"mileage": 32000
}
},
"collateral_document_key": null,
"collateral_instrument_document_key": null,
"additional_documents": [
{
"collateral_document_key": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"collateral_document_type": "vehicle_crlv_certificate",
"document_key": "1bffe8c6-0a54-4854-b693-745b3dba9e04"
}
],
"collateral_event_list": [
{
"collateral_status": "validated",
"event_type": "collateral_status_change",
"event_data": {
"from": "created",
"to": "validated",
"reason": "vehicle_consult_free",
"b3_response": {
"reservations": []
},
"b3_code": null,
"b3_description": null,
"b3_http_status": 200
},
"event_datetime": "2026-09-28T14:32:10.123456+00:00"
}
]
}
Response Body (422 — COM000087)
{
"title": "Unprocessable Entity",
"description": "Vehicle with chassis '9BWZZZ377VT004251' could not be validated on B3 (code: None, description: Vehicle has an active reservation with status 'Ativo'); the vehicle_stock collateral was registered as canceled.",
"translation": "O veiculo com chassi '9BWZZZ377VT004251' nao pode ser validado na B3 (codigo: None, descricao: Vehicle has an active reservation with status 'Ativo'); a garantia de estoque de veiculos foi registrada como cancelada.",
"code": "COM000087",
"collateral": {
"collateral_key": "8a0c6e0e-3f5b-4c2a-9d7e-1b2f3c4d5e6f",
"collateral_type": "vehicle_stock",
"collateral_status": "canceled",
"collateral_data": {
"vehicle": {
"chassis": "9BWZZZ377VT004251",
"plate": "ABC1D23",
"plate_state": "SP",
"renavam": "12345678901"
}
},
"collateral_document_key": null,
"collateral_instrument_document_key": null,
"additional_documents": [],
"collateral_event_list": [
{
"collateral_status": "canceled",
"event_type": "collateral_status_change",
"event_data": {
"from": "created",
"to": "canceled",
"reason": "vehicle_consult_marked",
"b3_response": {
"reservations": [
{
"reservation_status": "Ativo"
}
]
},
"b3_code": null,
"b3_description": "Vehicle has an active reservation with status 'Ativo'",
"b3_http_status": 200
},
"event_datetime": "2026-09-28T14:32:10.123456+00:00"
}
]
}
}

担保品状态 (collateral_status)​

所有类型的担保品都会返回 collateral_status 字段。对于不依赖外部验证的类型,担保品创建时为 validated,签署后变为 finished。对于 vehicle_stock,完整生命周期如下:

状态描述
validated登记时已接受的担保品。对于 vehicle_stock,表示车辆已查询且在 B3 中可用。
canceled已取消的担保品:登记时车辆有有效预留或查询出错、担保品被删除或操作被取消。不会进入合同草稿或发行。
pending操作已签署;车辆等待在 B3 登记锁定。
finished车辆已在 B3 登记锁定(对于其他类型,表示操作已签署)。
failed签署后在 B3 登记锁定车辆失败。

事件历史 (collateral_event_list)​

所有担保品都会返回 collateral_event_list 字段,按时间顺序记录状态变更历史。

字段类型描述
collateral_statusstring事件发生后担保品的状态。
event_typestring事件类型。状态变更时为 collateral_status_change。
event_dataobject事件数据:from(原状态)、to(新状态)、reason(原因),对于 vehicle_stock 还包括 B3 的响应(b3_response、b3_code、b3_description、b3_http_status)。
event_datetimestring事件日期和时间(ISO 8601,UTC)。

签署后的流程​

  • 所有相关方签署后,操作变为 pending_collateral,每辆拥有 validated 担保品的车辆会再次查询并在 B3 登记锁定。
  • 如果所有车辆都登记成功,担保品变为 finished,操作继续变为 issued。
  • 如果任何车辆的查询或登记失败,受影响的担保品变为 failed,操作也变为 failed。操作可通过 QI Tech 执行的重新处理或取消来离开 failed 状态。

错误​

HTTP 状态码错误码描述
400—Schema 验证错误(例如 plate/plate_state/renavam 字段组不完整)。
400COM000083租户无权使用此担保品类型。
400COM000084车辆年份晚于当前年份的下一年。
409COM000085该底盘号已存在于同一操作的 validated 担保品中。
422COM000087车辆在 B3 有有效预留或查询出错。担保品保存为 canceled,并在错误响应体的 collateral 字段中返回。

另请参阅错误目录。


Request Body Params​

字段类型描述必填
collateral_document_key *string担保工具的键。是
collateral_type *string担保品类型。collateral_type 枚举
collateral_dataobject与担保品相关的元数据结构。是
additional_documentslist与担保品相关的文件。-

additional_documents 列表​

字段类型描述必填
document_key *string担保工具的键。是
document_type *string担保品文件类型。是

collateral_type 枚举​

枚举值描述
fiduciary_alienation_property不动产信托转让。
fiduciary_alienation_vehicle车辆信托转让。
fiduciary_alienation_aircraft航空器信托转让。
fiduciary_alienation_equipment设备/产品/库存信托转让。
fiduciary_alienation_artwork艺术品信托转让。
fiduciary_alienation_securities有价证券信托转让。
fiduciary_assignment_shares股份/份额信托转让/质押。
fiduciary_assignment_credit_rights信贷权信托转让。
mortgage_property不动产抵押。
mortgage_ship船舶抵押。
guarantor保证人。
surety担保人。
bank_surety银行保函。
card_receivables信用卡应收款。
stock_guarantee库存担保。
monitoring_guarantee担保品监控。
vehicle_stock车辆库存担保 (Floor Plan)。不使用 collateral_document_key——参见车辆库存担保 (Floor Plan)。
others其他担保品。