跳到主要内容

合同 Webhook


转让合同会发送两类 webhook:一类在合同每次状态变更时发送,另一类在合同的某个产品启用时发送。两类 webhook 都会发送给管理人、转让方,以及合同的顾问(如有)——只要对方已配置 webhook。签名、重发和配置:参见 Webhook 认证。

合同状态变更​

webhook_type:assignment_contract.assignment_contract_status_change

Webhook Body
{
"data": {
"assignment_contract_key": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"status": "denied",
"external_id": "Contrato número 550",
"denial_reason": "Documentação do cedente insuficiente"
},
"webhook_type": "assignment_contract.assignment_contract_status_change",
"webhook_datetime": "2025-01-22T20:30:23Z"
}
字段描述
data.assignment_contract_key合同的 key。
data.status合同的新状态。见枚举值。
data.external_id合同申请中发送的 external_id,或 null。
data.denial_reason管理人填写的拒绝原因。非 denied 状态时为 null。
data.assignment_contract_new_status仅当 status 为 signed 时返回,值为 contract_signed。

合同已签署的示例:

Webhook Body
{
"data": {
"assignment_contract_key": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"status": "signed",
"external_id": "Contrato número 550",
"denial_reason": null,
"assignment_contract_new_status": "contract_signed"
},
"webhook_type": "assignment_contract.assignment_contract_status_change",
"webhook_datetime": "2025-01-22T20:30:23Z"
}

触发该 webhook 的状态:

状态时机
pending_manager_approval由顾问提出的合同等待管理人决定。
pending_assignor_registry_release转让方的注册仍在审查中。
pending_signature_submission模板要求手动发送签署。
sending_to_signature合同正在发送至 CertifiQI。
pending_signature可供各方签署。
waiting_escrow_data / pending_escrow_activationescrow 账户相关步骤(仅限带 escrow 账户的模板)。
signed所有文件均已签署。产品开始启用。
suspended合同已暂停;产品变为 inactive。重新启用后回到 signed。
denied管理人拒绝了该合同。
canceled合同已取消。

产品已启用​

webhook_type:assignment_contract.product_status_change

在合同签署后、某个产品的转让流程配置完成时发送。assignment_configuration_key 即通过此 webhook 获得,用于在基金与转让方之间转让资产。包含多个产品的合同会为每个产品各生成一个 webhook。

Webhook Body
{
"data": {
"product_key": "57efbd9f-0917-4c79-9a43-bc8f1039fc78",
"assignment_configuration_key": "372f0449-4043-4523-9f0f-dff70c65b9c9",
"status": "active",
"product_new_status": "active"
},
"webhook_type": "assignment_contract.product_status_change",
"webhook_datetime": "2025-01-22T20:30:23Z"
}
字段描述
data.product_key产品的 key。如需了解其所属合同,请在合同查询中查询该合同。
data.assignment_configuration_key为该产品创建的转让配置的 key。
data.status / data.product_new_status在此 webhook 中始终为 active。