INSS 贷款转移 + 再融资手册
另请参阅
注意！
QI Tech 的 webhooks 不应以严格方式进行映射。 我们 API 返回的 webhook payload 中可能会包含额外字段。
重新发送 Webhooks
您可以按照以下文档中的详细说明查询并重新发送 webhooks：重新发送 Webhooks。
要启动 INSS 贷款转移 + 再融资流程，首先需要收集福利数据以检查资格，以及福利支付账户数据。第 1 和第 2 条描述了查询特定受益人福利列表的程序以及查询福利数据的程序。
1 - 通过合作方正式授权书查询福利列表：
1.1. 福利持有人是授权书的签署人。
请求
- ENDPOINT/social_security/benefits_request
- MÉTODOPOST
Payload：
payload.json
{
"document_number": "16514548091",
"authorization_term": {
"document_number": "16514548091",
"signature": {
"signer": {
"name": "Nome Devedor",
"phone": {
"number": "887577622",
"area_code": "19",
"country_code": "55"
},
"document_number": "16514548091"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "2023-12-05T21:04:06",
"ip_address": "200.223.171.82",
"fingerprint": {
"lat": "-44.00524157713981",
"long": "-19.807649431219804",
"name": "Nome Cliente",
"model": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1",
"localeHashValue": "hash cliente"
},
"third_party_additional_data": {},
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"signed_object": {
"document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b"
}
}
}
}
1.2. 福利持有人不是授权书的签署人（有法定代理人）。
注意
由于本例中授权书的签署人是法定代理人，填写 signer 对象的数据为法定代理人的数据。
请求
- ENDPOINT/social_security/benefits_request
- MÉTODOPOST
Payload：
payload.json
{
"document_number": "16514548091",
"authorization_term": {
"document_number": "16514548091",
"legal_representative_document_number": "70957091060",
"signature": {
"signer": {
"name": "Nome Representante legal",
"phone": {
"number": "887577622",
"area_code": "19",
"country_code": "55"
},
"document_number": "70957091060"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "2023-12-05T21:04:06",
"ip_address": "200.223.171.82",
"fingerprint": {
"lat": "-44.00524157713981",
"long": "-19.807649431219804",
"name": "Nome Cliente",
"model": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1",
"localeHashValue": "hash cliente"
},
"third_party_additional_data": {},
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"signed_object": {
"document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b"
}
}
}
}
注意
在有法定代理人的情况下，需要在 "legal_representative_document_number" 字段中填写法定代理人的 CPF，且 "signer" 对象中的数据应填写法定代理人的数据。
"document_key"：使用 /upload 端点返回的 GUID
信息
除了在 "authorization_term.signed_object.document_key" 对象中提供签名 PDF 文档的键之外，也可以通过 "authorization_term.signed_object.raw_text" 对象发送授权书的纯文本内容。
响应
- MÉTODOPOST
- ENDPOINTsocial_security/benefits_request
body.json
{
"benefits_request_key": "c9d2aa83-006b-4753-92ad-64411a7aa700",
"document_number": "18028522041",
"status": "pending_authorization",
"authorization_term": {
"authorization_term_key": "5a7b6489-8a47-4b61-a85a-6986b058fda6",
"status": "signed"
},
"status_events": [
{
"status": "pending_authorization",
"event_date": "2023-12-22T16:12:50"
}
]
}
福利列表查询成功时：
Webhook
- WEBHOOK_TYPEsocial_security_benefits_request
- STATUSSuccess
Body：
body.json
{
"webhook": {
"key": "54cddd0f-b976-4266-91ea-90279bfb49a1",
"data": [
{
"grant_date": [
"2010-10-18"
],
"benefit_number": 2052711150,
"benefit_status": "elegible"
}
],
"status": "success",
"webhook_type": "social_security_benefits_request",
"event_datetime": "2023-12-22T13:20:44"
}
}
| 字段 | 描述 | 值 |
|---|---|---|
| benefit_number | 福利编号 | - |
| benefit_status | 福利状态 | 枚举值 |
福利列表查询失败时：
Webhook
- WEBHOOK_TYPEsocial_security_benefits_request
- STATUSFailure
Body：
body.json
{
"webhook": {
"key": "0020653e-c3b0-4606-af31-2ea4a577a5ce",
"data": {
"enumerator": "inexistent_beneficiary",
"description": "no beneficiary found"
},
"status": "failure",
"webhook_type": "social_security_benefits_request",
"event_datetime": "2023-12-22T15:46:31"
}
}
失败 Webhook 中的字段详情
| 字段 | 描述 | 值 |
|---|---|---|
| enumerator | Dataprev 代码的映射返回值 | 枚举值 |
在 Sandbox 中模拟福利查询的成功和失败场景：
场景模拟基于操作中填写的 CPF 的第一位数字。
11.1. 对于以数字 1 开头的 CPF，将通过 Webhook 返回异步成功响应。
11.2. 对于其他 CPF，将根据输入的 CPF 的第一位数字返回异步错误响应，如下表所示。
| CPF 开头 | 枚举值 | 描述 |
|---|---|---|
| 2 | inexistent_beneficiary | no beneficiary found |
注意
所有第一位数字没有映射场景的 CPF 将收到一个包含未映射测试场景标准错误的 webhook。
| 枚举值 | 描述 |
|---|---|
| mock_error | Informed document number is not a valid mock on test environment |
2 - 查询福利数据
2.1. 使用之前提交的授权书查询福利数据。
请求
- MÉTODOPOST
- ENDPOINT/social_security/balance_request
Payload：
payload.json
{
"document_number": "16514548091",
"benefit_number": 2052711150
}
响应
- MÉTODOPOST
- ENDPOINT/social_security/balance_request
Body：
body.json
{
"balance_request_key": "ffda1935-9cad-47df-b848-cd33c96024e4",
"document_number": "16514548091",
"status": "pending_authorization",
"authorization_term": {
"authorization_term_key": "19196811-366f-4422-a729-4d0aa552449b",
"status": "allowed"
},
"status_events": [
{
"status": "pending_authorization",
"event_date": "2023-12-22T16:18:18"
}
]
}
2.2. 随授权书一同提交进行福利数据查询。
请求
- MÉTODOPOST
- ENDPOINT/social_security/balance_request
Payload：
payload.json
{
"document_number": "14950479032",
"benefit_number": 22255220,
"authorization_term": {
"document_number": "14950479032",
"legal_representative_document_number": "32866210050", // CPF do representante legal (caso aplicável)
"signature": {
"signer": {
"name": "Nome Cliente",
"phone": {
"number": "887577622",
"area_code": "19",
"country_code": "55"
},
"document_number": "14950479032"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "2023-12-05T21:04:06",
"ip_address": "200.223.171.82",
"fingerprint": {
"lat": "-44.00524157713981",
"long": "-19.807649431219804",
"name": "Nome Cliente",
"model": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1",
"localeHashValue": "hash cliente"
},
"third_party_additional_data": {},
"session_id": "b75c7ac2-3be3-41b6-b769-4d982a5824a2"
},
"signed_object": {
"document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b"
}
}
}
}
注意
在有法定代理人的情况下，需要在 "legal_representative_document_number" 字段中填写法定代理人的 CPF，且 "signer" 对象中的数据应填写法定代理人的数据。
响应
-
MÉTODOPOST
-
ENDPOINT/social_security/balance_request
-
Body：
body.json
{
"balance_request_key": "ffda1935-9cad-47df-b848-cd33c96024e4",
"document_number": "14950479032",
"status": "pending_authorization",
"authorization_term": {
"authorization_term_key": "19196811-366f-4422-a729-4d0aa552449b",
"status": "signed"
},
"status_events": [
{
"status": "pending_authorization",
"event_date": "2023-12-22T16:18:18"
}
]
}
福利数据查询成功时
Webhook
- WEBHOOK_TYPE/social_security/balance_request
- STATUSSuccess
Body：
body.json
{
"webhook": {
"key": "ffda1935-9cad-47df-b848-cd33c96024e4",
"data": {
"name": "IVOLANDO MIRANDA",
"state": "SP",
"alimony": "not_payer",
"birth_date": "07021961",
"grant_date": "2022-09-02",
"credit_type": "checking_account",
"block_type": "not_blocked",
"benefit_card": {
"limit": 2083.2,
"balance": 0
},
"benefit_number": "22255220",
"benefit_status": "elegible",
"payroll_card": {
"limit": 2083.2,
"balance": 0
},
"assistance_type": "retirement_by_age",
"document_number": "14950479032",
"benefit_end_date": "2020-12-01",
"consigned_credit": {
"balance": 1000
},
"benefit_situation": "active",
"max_total_balance": 2000,
"used_total_balance": 1000,
"politically_exposed": {
"type": "politically_exposed_level_1",
"is_politically_exposed": true
},
"has_power_of_attorney": false,
"available_total_balance": 1000,
"has_judicial_concession": false,
"number_of_portabilities": 0,
"disbursement_bank_account": {
"bank_code": "341",
"account_digit": "6",
"account_branch": "0155",
"account_number": "000059923"
},
"has_entity_representation": false,
"social_benefit_max_balance": 2000,
"social_benefit_used_balance": 1000,
"benefit_quota_expiration_date": null,
"number_of_active_reservations": 0,
"number_of_suspended_reservations": 0,
"number_of_refinanced_reservations": 0,
"number_of_active_suspended_reservations": 3
},
"status": "success",
"webhook_type": "social_security_balance_request",
"event_datetime": "2023-12-22T16:18:21"
}
}
成功 Webhook 中的字段详情
| 字段 | 描述 | 值 |
|---|---|---|
| assistance_type | 福利类型 | 枚举值 |
| benefit_status | 福利状态 | 枚举值 |
| has_entity_representation | 是否有代理实体（不允许背书） | True 或 False |
| alimony_code | 赡养费分类器 | not_payer, payer, benefit |
| has_judicial_concession | 通过临时禁令批准的福利 | True 或 False |
| has_power_of_attorney | 是否有代理人？ | True 或 False |
| credit_type | 信贷类型 - 福利领取方式 | Magnetic_card, checking_account |
| benefit_situation | 福利状态 | 枚举值 |
| used_total_balance | 用于贷款背书、转移预留、再融资、变更、RMC 和 RCC 的已占用总金额 | 数值 |
| max_total_balance | 相应福利类型可占用的金额上限 | 数值 |
| available_total_balance | 可用于贷款的总金额（所有模式之和，即 max_total_balance 与 used_total_balance 之差） | 数值 |
| benefit_quota_expiration_date | 福利终止日期。该信息仅适用于部分死亡养恤金。 | 字符串或空值 |
| block_type | 福利锁定类型 | 枚举值 |
| politically_exposed.type | 政治敏感人士 | 枚举值 |
| is_politically_exposed | 政治敏感人士 | True 或 False |
福利列表查询失败时
Webhook
- WEBHOOK_TYPE/social_security/balance_request
- STATUSFailure
Body:
body.json
{
"webhook": {
"key": "37a14593-b934-457c-8cf6-e51f184b1f1c",
"data": {
"enumerator": "inexistent_beneficiary",
"description": "no beneficiary found"
},
"status": "failure",
"webhook_type": "social_security_balance_request",
"event_datetime": "2023-12-22T16:22:29"
}
}
失败 Webhook 中的字段详情
| 字段 | 描述 | 值 |
|---|---|---|
| enumerator | Dataprev 代码的映射返回值 | 枚举值 |
在 Sandbox 中模拟福利数据查询的成功和失败场景：
场景模拟基于操作中填写的 CPF 的第一位数字。
11.1. 对于以数字 1 开头的 CPF，将通过 Webhook 返回异步成功响应。
11.2. 对于其他 CPF，将根据输入的 CPF 的第一位数字返回异步错误响应，如下表所示。
| CPF 开头 | 枚举值 | 描述 |
|---|---|---|
| 2 | inexistent_beneficiary | no beneficiary found |
Atenção
所有未映射到第一位数字场景的 CPF，将收到一个包含未映射测试场景标准错误的 webhook。
| Enumerador | Descrição |
|---|---|
| mock_error | Informed document number is not a valid mock on test environment |
3 - 录入提案：
注意
要使转移和再融资的背书申请成功创建，需要事先对福利进行有效的数据查询。 为此，只需按照 2 - 查询福利数据 中的步骤操作。
因缺乏有效福利数据查询导致的背书失败
如果在发出背书请求之前未成功进行福利数据查询，背书请求的状态将变为等待合作方操作，并以以下格式发送 webhook 以通知此事：
WEBHOOK_TYPE
social_security_success_balance_request_not_foundSTATUS
Pending requester actionWebhook Body
{
"webhook": {
"key": "\<DEBT-KEY\>",
"data": {
"enumerator": "success_balance_request_not_found",
"description": "Success balance request not found for the specified benefit number"
},
"status": "pending_requester_action",
"webhook_type": "social_security_success_balance_request_not_found",
"event_datetime": "2024-02-26T21:36:22"
}
}
要继续操作，需执行以下步骤：
- 按照第 2 条 - 查询福利数据 中的步骤查询相关福利数据；
- 按以下格式发送请求以告知查询已完成。
ENDPOINT
/social_security/reservation/external_key/DEBT-KEY/validate_reservationMÉTODO
POST重要
此请求不仅确认存在有效的福利数据查询，还验证用于创建背书的信息是否正确，从而允许流程继续。
3.1. 录入含再融资的转移提案： 此录入方式用于执行信贷合同的转移，最终向债务人释放更多资金。转移后释放的金额称为"找零"。转移提案和再融资提案可以 在同一个请求中生成。
提案录入时需发送以下信息：
-
信贷借款人的注册数据。
-
法定代理人的注册数据（如适用）。
-
转移操作的财务数据，始终需提供期数以及利率或分期面值之一。
-
再融资操作的财务数据（用于结清转移操作并释放找零的操作），以及用于支付找零的银行账户数据（如福利数据查询中返回的账户）。
-
负责提案发起的信贷代理，也称为'pastinha'。
-
未偿余额、原始合同编号和原始债权人的 ISPB。由于再融资操作没有固定的放款日期，放款日期的变化会影响操作金额，因此需要说明是利率（"monthly_interest_rate"）固定还是向客户释放的金额（"disbursed_amount"）固定。
如果提案针对文盲客户，委托人和证人的数据必须在提案创建 payload 的 additional_data 字段中发送。但需要事先与 QI Tech 确认将使用哪些信息和格式
3.1.1. 录入固定利率的含再融资转移提案： 以下是固定操作利率的提案录入示例：
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Payload：
- Sem Registro na C3
- Com Registro na C3
Request Body
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"credit_agent": {
"document_number": "87237271016",
"name": "Agente de credito"
},
"borrower": {
"person_type": "natural",
"name": "Marilene da Silva",
"mother_name": "Maria Mariane",
"birth_date": "1990-05-06",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "20676928013",
"document_identification_number": "381803326",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "912828135"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Águas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [
{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "20676928013",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}
],
"collaterals": [
{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "22255220",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}
],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "300523588BF"
},
"refinancing_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"installment_face_value": 100,
"number_of_installments": 10
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "000059923",
"ispb": "341",
"bank_code": "341",
"branch_number": "0155"
},
"contract_number": "200523588BF"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "558472",
"last_due_balance": 997.87
},
"additional_data": {}
}
Request Body
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"credit_agent": {
"document_number": "87237271016",
"name": "Agente de credito"
},
"borrower": {
"person_type": "natural",
"name": "Marilene da Silva",
"mother_name": "Maria Mariane",
"gender": "female",
"birth_date": "1990-05-06",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "20676928013",
"document_identification_number": "381803326",
"document_identification_date": "2019-01-28",
"document_identification_type": "rg",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "912828135"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Águas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [
{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "20676928013",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}
],
"collaterals": [
{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "22255220",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}
],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "300523588PF"
},
"refinancing_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"installment_face_value": 100,
"number_of_installments": 10
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "000059923",
"ispb": "341",
"bank_code": "341",
"branch_number": "0155"
},
"contract_number": "200523588PK"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "558472",
"last_due_balance": 997.87
},
"additional_data": {}
}
里约格兰德州的宽限期
根据 DATAPREV 通知，来自里约格兰德州的福利在 2024 年 6 月 28 日之后生成的新再融资合同中可有最多 6 个月的宽限期。 为此，需要在上述 payload 的 "collateral_data" 中添加一个名为 "number_of_grace_periods" 的字段。该字段将包含所需宽限月数的值，如以下示例所示：
"collaterals": [
{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "22255220",
"state": "RS",
"number_of_grace_periods": 3,
"subcorban_document_number": "12123456000101"
}
}
]
Atenção
"related_parties" 列表仅应在有法定代理人的操作时发送。 发送时，必须包含法定代理人的注册数据，且 "role_type" 字段应发送值："issuer_legal_representative"。
信息
在 "origin_contract.ispb" 字段中填写原始债权机构的 ISPB。 ISPB 是机构 CNPJ 的基础部分。要获取 CTC - CIP（信贷转移中心）每个参与机构的完整 ISPB 列表，只需使用 CTC 参与者查询端点（索引）：
3.1.2. 录入固定释放金额的含再融资转移提案：
以下是固定向客户释放金额的提案录入示例：
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Payload：
- Sem Registro na C3
- Com Registro na C3
Request Body
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"credit_agent": {
"document_number": "87237271016",
"name": "Agente de credito"
},
"borrower": {
"person_type": "natural",
"name": "Elaine Isadora da Cruz",
"mother_name": "Maria Mariane",
"birth_date": "1990-05-06",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "90406718261",
"document_identification_number": "381803326",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "996363253"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Aguas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "45102538004",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}],
"collaterals": [{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "12345678",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "3635259610"
},
"refinancing_credit_operation": {
"financial": {
"disbursed_amount": 1000,
"installment_face_value": 110,
"number_of_installments": 10
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"bank_code": "033",
"branch_number": "0001"
},
"contract_number": "3635259632"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "5584745",
"last_due_balance": 800
},
"additional_data": {}
}
Request Body
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"credit_agent": {
"document_number": "87237271016",
"name": "Agente de credito"
},
"borrower": {
"person_type": "natural",
"name": "Elaine Isadora da Cruz",
"mother_name": "Maria Mariane",
"birth_date": "1990-05-06",
"gender": "female",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "90406718261",
"document_identification_number": "381803326",
"document_identification_type": "rg",
"document_identification_date": "2019-01-28",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "996363253"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Aguas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "45102538004",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}],
"collaterals": [{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "12345678",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "3635259611"
},
"refinancing_credit_operation": {
"financial": {
"disbursed_amount": 1000,
"installment_face_value": 110,
"number_of_installments": 10
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"bank_code": "033",
"branch_number": "0001"
},
"contract_number": "3635259663"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "5584745",
"last_due_balance": 800
},
"additional_data": {}
}
3.1.3. 响应
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Body：
body.json
{
"borrower": {
"individual_document_number": "90406718261",
"name": "Elaine Isadora da Cruz",
"related_party_key": "d7f84a9d-28ba-4355-8e5e-a436ff4c3c2d",
"role_type": "issuer"
},
"portability_credit_operation": {
"collateral_is_constituted": false,
"contract_number": "3635259611",
"credit_operation_key": "235ce3a5-eea1-4b13-9335-3de577318f8b",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.17295,
"cet": 0.0134,
"contract_fee_amount": 0.0,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": 0.0,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 800.0,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 800.0,
"installment_number": 1,
"pre_fixed_amount": 21.977846031814607,
"principal_amortization_amount": 65.21215396818539,
"total_amount": 87.19,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 734.7878460318146,
"installment_number": 2,
"pre_fixed_amount": 9.373907348762184,
"principal_amortization_amount": 77.81609265123781,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 656.9717533805768,
"installment_number": 3,
"pre_fixed_amount": 8.963122696164149,
"principal_amortization_amount": 78.22687730383585,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 578.744876076741,
"installment_number": 4,
"pre_fixed_amount": 7.639487642788938,
"principal_amortization_amount": 79.55051235721106,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 33,
"due_date": "2024-06-24",
"due_principal": 499.19436371952986,
"installment_number": 5,
"pre_fixed_amount": 7.253119731550034,
"principal_amortization_amount": 79.93688026844997,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-07-22",
"calendar_days": 28,
"due_date": "2024-07-22",
"due_principal": 419.2574834510799,
"installment_number": 6,
"pre_fixed_amount": 5.163027422441386,
"principal_amortization_amount": 82.02697257755861,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 337.2305108735213,
"installment_number": 7,
"pre_fixed_amount": 4.600865151805861,
"principal_amortization_amount": 82.58913484819413,
"total_amount": 87.19,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 32,
"due_date": "2024-09-23",
"due_principal": 254.64137602532716,
"installment_number": 8,
"pre_fixed_amount": 3.586947657335553,
"principal_amortization_amount": 83.60305234266444,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-10-22",
"calendar_days": 29,
"due_date": "2024-10-22",
"due_principal": 171.0383236826627,
"installment_number": 9,
"pre_fixed_amount": 2.18198682510524,
"principal_amortization_amount": 85.00801317489476,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 86.03031050776795,
"installment_number": 10,
"pre_fixed_amount": 1.1637189988799015,
"principal_amortization_amount": 86.0262810011201,
"total_amount": 87.19,
"workdays": 22
}
],
"issue_amount": 800.0,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17042118,
"daily_rate": 0.00043722,
"interest_base": "calendar_days",
"monthly_rate": 0.0132
},
"total_iof": 0.0
}
],
"document_key": "c4cedeaf-23bf-450d-9fba-5ec6b5d45afb",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/c4cedeaf-23bf-450d-9fba-5ec6b5d45afb/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-3635259611.pdf",
"final_disbursement_amount": 0.0
},
"proposal_key": "2f7e320c-2a35-4e78-bfd7-a298b28a7497",
"proposal_number": "17032782193414588",
"proposal_status": "pending_submission",
"refinancing_credit_operation": {
"collateral_is_constituted": false,
"contract_number": "3635259663",
"credit_operation_key": "f73ba4d2-cd0a-4405-a47e-a51f325a9756",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [
{
"account_branch": "0001",
"account_digit": "1",
"account_number": "00001",
"bank_code": "033"
}
],
"disbursement_options": [
{
"annual_cet": 0.193423,
"cet": 0.0148,
"contract_fee_amount": 1.03,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": 1.03,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 1000.0,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 1005.24,
"installment_number": 1,
"pre_fixed_amount": 28.92478321729087,
"principal_amortization_amount": 81.07521678270913,
"total_amount": 110.0,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 924.1647832172908,
"installment_number": 2,
"pre_fixed_amount": 12.344286518064438,
"principal_amortization_amount": 97.65571348193556,
"total_amount": 110.0,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 826.5090697353553,
"installment_number": 3,
"pre_fixed_amount": 11.806660138520433,
"principal_amortization_amount": 98.19333986147957,
"total_amount": 110.0,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 728.3157298738757,
"installment_number": 4,
"pre_fixed_amount": 10.06605046134725,
"principal_amortization_amount": 99.93394953865275,
"total_amount": 110.0,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 33,
"due_date": "2024-06-24",
"due_principal": 628.381780335223,
"installment_number": 5,
"pre_fixed_amount": 9.559924513271145,
"principal_amortization_amount": 100.44007548672886,
"total_amount": 110.0,
"workdays": 22
},
{
"business_due_date": "2024-07-22",
"calendar_days": 28,
"due_date": "2024-07-22",
"due_principal": 527.9417048484942,
"installment_number": 6,
"pre_fixed_amount": 6.807113809566991,
"principal_amortization_amount": 103.19288619043301,
"total_amount": 110.0,
"workdays": 20
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 424.7488186580611,
"installment_number": 7,
"pre_fixed_amount": 6.067525608326975,
"principal_amortization_amount": 103.93247439167303,
"total_amount": 110.0,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 32,
"due_date": "2024-09-23",
"due_principal": 320.8163442663881,
"installment_number": 8,
"pre_fixed_amount": 4.731771911001933,
"principal_amortization_amount": 105.26822808899807,
"total_amount": 110.0,
"workdays": 22
},
{
"business_due_date": "2024-10-22",
"calendar_days": 29,
"due_date": "2024-10-22",
"due_principal": 215.54811617739003,
"installment_number": 9,
"pre_fixed_amount": 2.87912691853476,
"principal_amortization_amount": 107.12087308146523,
"total_amount": 110.0,
"workdays": 21
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 108.4272430959248,
"installment_number": 10,
"pre_fixed_amount": 1.5688802916587754,
"principal_amortization_amount": 108.43111970834123,
"total_amount": 110.0,
"workdays": 22
}
],
"issue_amount": 1005.24,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17905959,
"daily_rate": 0.00045765,
"interest_base": "calendar_days",
"monthly_rate": 0.01382107
},
"total_iof": 4.21
}
],
"document_key": "f4dfb505-3cec-4a97-9b16-dadc39bb4c7e",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/f4dfb505-3cec-4a97-9b16-dadc39bb4c7e/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-3635259663.pdf",
"final_disbursement_amount": 200.0
},
"related_party_list": [
{
"individual_document_number": "45102538004",
"name": "Nome Representante Legal",
"related_party_key": "632fa6c5-40e8-4e76-862e-e10951ed8bff",
"role_type": "issuer_legal_representative"
}
]
}
以下是提案录入响应中返回的部分字段的定义和描述：
[A]: “portability_credit_operation.disbursement_options.iof_amount”：在转移操作中，IOF 始终为零。
[B]: “portability_credit_operation.disbursement_options.disbursed_issue_amount”：等于原始合同的未偿余额。
[C]: “portability_credit_operation.disbursement_options.issue_amount”：为转移操作的金额。
Relação
[C] = [A] + [B]
[D]: “refinancing_credit_operation.disbursement_options.iof_amount”：再融资操作（找零）的 IOF 金额。
[E]: “refinancing_credit_operation.disbursement_options.disbursed_issue_amount”：用于结清转移操作未偿余额的金额。
Relação
[E] = [C]
[F]: "refinancing_credit_operation.disbursement_options.final_disbursement_amount"：释放给客户（找零）的金额，发送至在提案录入时指定的放款账户（应为福利数据查询时返回的账户信息）。
[G]: “refinancing_credit_operation.disbursement_options.issue_amount”：再融资金额。
Relação
[G] = [F] + [E] + [D]
“portability_credit_operation.disbursement_options.collateral_constituted“ 和 “refinancing_credit_operation.disbursement_options.collateral_constituted“ 字段表示客户的边际额度是否已在 Dataprev 中背书。转移的背书流程将在原始合同结清资金发送至原始债权机构后启动（第 6.4. 条）。再融资的背书流程在合作方决定继续再融资操作时启动（第 7.1.1. 和 7.2. 条）。
3.2. 录入转移提案：
转移提案（纯转移）的录入方式与第 3.1.1 条所述类似，但发送时不含 "refinancing_credit_operation" 对象。
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Body:
body.json
{
"proposal_type": "inss",
"purchaser_document_number": "32402502000135",
"credit_agent": {
"document_number": "87237271016",
"name": "Agente de credito"
},
"borrower": {
"person_type": "natural",
"name": "Elaine Isadora da Cruz",
"mother_name": "Maria Mariane",
"birth_date": "1990-05-06",
"gender": "female",
"profession": "Desenvolvedora",
"nationality": "Brasileira",
"marital_status": "single",
"is_pep": false,
"individual_document_number": "90406718261",
"document_identification_number": "381803326",
"document_identification_type": "rg",
"document_identification_date": "2019-01-28",
"email": "elaineisadoradacruz@hotmal.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "996363253"
},
"address": {
"street": "Passagem Mariana",
"state": "PA",
"city": "Ananindeua",
"neighborhood": "Aguas Lindas",
"number": "660",
"postal_code": "67118003",
"complement": "complemento"
},
"document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
"document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a",
"selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076"
},
"related_parties": [{
"name": "Nome Representante Legal",
"email": "email@email.com.br",
"birth_date": "2000-12-12",
"is_pep": false,
"mother_name": "maria",
"phone": {
"number": "991294043",
"area_code": "11",
"country_code": "055"
},
"address": {
"street": "Avenida das Castanheiras",
"state": "SP",
"city": "Brasília",
"neighborhood": "bairro",
"number": "12",
"postal_code": "71900100",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"individual_document_number": "45102538004",
"document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650",
"document_identification_type": "rg",
"document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b",
"document_identification_number": "123456789",
"selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1"
}],
"collaterals": [{
"collateral_type": "social_security",
"collateral_data": {
"benefit_number": "12345678",
"state": "SP",
"subcorban_document_number": "12123456000101"
}
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
},
"contract_number": "1020252636"
},
"origin_contract": {
"ispb": "60746948",
"contract_number": "558474520",
"last_due_balance": 800
},
"additional_data": {}
}
Response
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal
Payload：
payload.json
{
"borrower": {
"individual_document_number": "90406718261",
"name": "Elaine Isadora da Cruz",
"related_party_key": "f9fbaa93-4d57-494f-b60f-dcba8cb64a45",
"role_type": "issuer"
},
"portability_credit_operation": {
"collateral_is_constituted": false,
"contract_number": "1020252636",
"credit_operation_key": "1cd34a63-5a61-49a3-90a5-7a515ee98932",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.17295,
"cet": 0.0134,
"contract_fee_amount": 0.0,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": 0.0,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 800.0,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 800.0,
"installment_number": 1,
"pre_fixed_amount": 21.977846031814607,
"principal_amortization_amount": 65.21215396818539,
"total_amount": 87.19,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 734.7878460318146,
"installment_number": 2,
"pre_fixed_amount": 9.373907348762184,
"principal_amortization_amount": 77.81609265123781,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 656.9717533805768,
"installment_number": 3,
"pre_fixed_amount": 8.963122696164149,
"principal_amortization_amount": 78.22687730383585,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 578.744876076741,
"installment_number": 4,
"pre_fixed_amount": 7.639487642788938,
"principal_amortization_amount": 79.55051235721106,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 33,
"due_date": "2024-06-24",
"due_principal": 499.19436371952986,
"installment_number": 5,
"pre_fixed_amount": 7.253119731550034,
"principal_amortization_amount": 79.93688026844997,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-07-22",
"calendar_days": 28,
"due_date": "2024-07-22",
"due_principal": 419.2574834510799,
"installment_number": 6,
"pre_fixed_amount": 5.163027422441386,
"principal_amortization_amount": 82.02697257755861,
"total_amount": 87.19,
"workdays": 20
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 337.2305108735213,
"installment_number": 7,
"pre_fixed_amount": 4.600865151805861,
"principal_amortization_amount": 82.58913484819413,
"total_amount": 87.19,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 32,
"due_date": "2024-09-23",
"due_principal": 254.64137602532716,
"installment_number": 8,
"pre_fixed_amount": 3.586947657335553,
"principal_amortization_amount": 83.60305234266444,
"total_amount": 87.19,
"workdays": 22
},
{
"business_due_date": "2024-10-22",
"calendar_days": 29,
"due_date": "2024-10-22",
"due_principal": 171.0383236826627,
"installment_number": 9,
"pre_fixed_amount": 2.18198682510524,
"principal_amortization_amount": 85.00801317489476,
"total_amount": 87.19,
"workdays": 21
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 86.03031050776795,
"installment_number": 10,
"pre_fixed_amount": 1.1637189988799015,
"principal_amortization_amount": 86.0262810011201,
"total_amount": 87.19,
"workdays": 22
}
],
"issue_amount": 800.0,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17042118,
"daily_rate": 0.00043722,
"interest_base": "calendar_days",
"monthly_rate": 0.0132
},
"total_iof": 0.0
}
],
"document_key": "2f9ac920-a5e8-4386-b049-dc971e1fc20b",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/2f9ac920-a5e8-4386-b049-dc971e1fc20b/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-1020252636.pdf",
"final_disbursement_amount": 0.0
},
"proposal_key": "9661aef8-e897-4405-a44f-ca8a43d9cee3",
"proposal_number": "17032785232138245",
"proposal_status": "pending_submission",
"related_party_list": [
{
"individual_document_number": "45102538004",
"name": "Nome Representante Legal",
"related_party_key": "c8166f37-b496-455a-96e7-f75e24f084a1",
"role_type": "issuer_legal_representative"
}
]
}
3.3. 恢复提案数据：
- MÉTODOGET
- STATUS/v2/credit_transfer/proposal/PROPOSAL-KEY ou REQUESTER_CONTROL_KEY
Path Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
proposal_key | string | 提案标识键 | - |
requester_control_key | string | 客户标识键，用于在超时或重复操作时检索提案数据，替代 proposal_key 发送 | - |
Response:
response.json
{
"borrower": {
"address": {
"city": "SAO PAULO",
"complement": "Moradia",
"neighborhood": "CENTRO",
"number": "10",
"postal_code": "01153000",
"state": "SP",
"street": "RUA CENTRAL"
},
"birth_date": "1976-05-25",
"document_identification_number": "306385466",
"email": "ivanete@windowslive.com",
"individual_document_number": "25500337874",
"is_pep": false,
"marital_status": "single",
"mother_name": "EDITE MARIA DANTAS",
"name": "IVANETE SATURNINO DE SOUZA",
"nationality": "Brasleira",
"person_type": "natural",
"phone": {
"area_code": "11",
"country_code": "055",
"number": "985814768"
},
"profession": "Aposentado",
"related_party_key": "511d7186-3c17-4f35-8887-c4aefaf270be",
"role_type": "issuer"
},
"collaterals": [
{
"collateral_data": {
"benefit_number": 2045043317,
"state": "SP"
},
"collateral_type": "social_security"
}
],
"origin_operation": {
"contract_date": "2025-06-02",
"contract_number": "0123489618691",
"financial_institution_code_number": "237",
"installment_number": 84,
"ispb_number": "60746948",
"last_due_balance": 17879.22,
"opened_installment_number": 67,
"overdue_installment_number": 0
},
"portability_credit_operation": {
"collateral_is_constituted": false,
"contract_number": "CTC0000024971",
"credit_operation_key": "e5bfbd28-0144-4eaa-b7f1-d0efb0b6b155",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.2321,
"cet": 0.0175,
"contract_fee_amount": 0,
"contract_fees": [],
"disbursed_issue_amount": 17879.22,
"disbursement_date": "2025-06-02",
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"final_disbursement_amount": 17879.22,
"installments": [
{
"business_due_date": "2025-07-03",
"calendar_days": 30,
"due_date": "2025-07-02",
"due_principal": 17879.22,
"installment_number": 1,
"pre_fixed_amount": 309.31052471,
"principal_amortization_amount": 146.66947529,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2025-08-05",
"calendar_days": 31,
"due_date": "2025-08-02",
"due_principal": 17732.55052471,
"installment_number": 2,
"pre_fixed_amount": 317.08981019,
"principal_amortization_amount": 138.89018981,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2025-09-03",
"calendar_days": 31,
"due_date": "2025-09-02",
"due_principal": 17593.6603349,
"installment_number": 3,
"pre_fixed_amount": 314.60620447,
"principal_amortization_amount": 141.37379553,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2025-10-03",
"calendar_days": 30,
"due_date": "2025-10-02",
"due_principal": 17452.28653937,
"installment_number": 4,
"pre_fixed_amount": 301.92457539,
"principal_amortization_amount": 154.05542461,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2025-11-04",
"calendar_days": 31,
"due_date": "2025-11-02",
"due_principal": 17298.23111476,
"installment_number": 5,
"pre_fixed_amount": 309.3234001,
"principal_amortization_amount": 146.6565999,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2025-12-03",
"calendar_days": 30,
"due_date": "2025-12-02",
"due_principal": 17151.57451486,
"installment_number": 6,
"pre_fixed_amount": 296.72225705,
"principal_amortization_amount": 159.25774295,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2026-01-05",
"calendar_days": 31,
"due_date": "2026-01-02",
"due_principal": 16992.31677191,
"installment_number": 7,
"pre_fixed_amount": 303.85310294,
"principal_amortization_amount": 152.12689706,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2026-02-03",
"calendar_days": 31,
"due_date": "2026-02-02",
"due_principal": 16840.18987485,
"installment_number": 8,
"pre_fixed_amount": 301.13280115,
"principal_amortization_amount": 154.84719885,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2026-03-03",
"calendar_days": 28,
"due_date": "2026-03-02",
"due_principal": 16685.342676,
"installment_number": 9,
"pre_fixed_amount": 269.25826857,
"principal_amortization_amount": 186.72173143,
"total_amount": 455.98,
"workdays": 18
},
{
"business_due_date": "2026-04-06",
"calendar_days": 31,
"due_date": "2026-04-02",
"due_principal": 16498.62094457,
"installment_number": 10,
"pre_fixed_amount": 295.024936,
"principal_amortization_amount": 160.955064,
"total_amount": 455.98,
"workdays": 23
},
{
"business_due_date": "2026-05-05",
"calendar_days": 30,
"due_date": "2026-05-02",
"due_principal": 16337.66588057,
"installment_number": 11,
"pre_fixed_amount": 282.64163683,
"principal_amortization_amount": 173.33836317,
"total_amount": 455.98,
"workdays": 18
},
{
"business_due_date": "2026-06-03",
"calendar_days": 31,
"due_date": "2026-06-02",
"due_principal": 16164.3275174,
"installment_number": 12,
"pre_fixed_amount": 289.0471699,
"principal_amortization_amount": 166.9328301,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2026-07-03",
"calendar_days": 30,
"due_date": "2026-07-02",
"due_principal": 15997.3946873,
"installment_number": 13,
"pre_fixed_amount": 276.75494483,
"principal_amortization_amount": 179.22505517,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2026-08-04",
"calendar_days": 31,
"due_date": "2026-08-02",
"due_principal": 15818.16963213,
"installment_number": 14,
"pre_fixed_amount": 282.85724601,
"principal_amortization_amount": 173.12275399,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2026-09-03",
"calendar_days": 31,
"due_date": "2026-09-02",
"due_principal": 15645.04687814,
"installment_number": 15,
"pre_fixed_amount": 279.76150064,
"principal_amortization_amount": 176.21849936,
"total_amount": 455.98,
"workdays": 23
},
{
"business_due_date": "2026-10-05",
"calendar_days": 30,
"due_date": "2026-10-02",
"due_principal": 15468.82837878,
"installment_number": 16,
"pre_fixed_amount": 267.61074714,
"principal_amortization_amount": 188.36925286,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2026-11-04",
"calendar_days": 31,
"due_date": "2026-11-02",
"due_principal": 15280.45912592,
"installment_number": 17,
"pre_fixed_amount": 273.24201767,
"principal_amortization_amount": 182.73798233,
"total_amount": 455.98,
"workdays": 19
},
{
"business_due_date": "2026-12-03",
"calendar_days": 30,
"due_date": "2026-12-02",
"due_principal": 15097.72114359,
"installment_number": 18,
"pre_fixed_amount": 261.19059158,
"principal_amortization_amount": 194.78940842,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2027-01-05",
"calendar_days": 31,
"due_date": "2027-01-02",
"due_principal": 14902.93173517,
"installment_number": 19,
"pre_fixed_amount": 266.49115076,
"principal_amortization_amount": 189.48884924,
"total_amount": 455.98,
"workdays": 20
},
{
"business_due_date": "2027-02-03",
"calendar_days": 31,
"due_date": "2027-02-02",
"due_principal": 14713.44288593,
"installment_number": 20,
"pre_fixed_amount": 263.10275025,
"principal_amortization_amount": 192.87724975,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2027-03-03",
"calendar_days": 28,
"due_date": "2027-03-02",
"due_principal": 14520.56563618,
"installment_number": 21,
"pre_fixed_amount": 234.32436707,
"principal_amortization_amount": 221.65563293,
"total_amount": 455.98,
"workdays": 18
},
{
"business_due_date": "2027-04-05",
"calendar_days": 31,
"due_date": "2027-04-02",
"due_principal": 14298.91000325,
"installment_number": 22,
"pre_fixed_amount": 255.69015876,
"principal_amortization_amount": 200.28984124,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2027-05-04",
"calendar_days": 30,
"due_date": "2027-05-02",
"due_principal": 14098.62016201,
"installment_number": 23,
"pre_fixed_amount": 243.90614356,
"principal_amortization_amount": 212.07385644,
"total_amount": 455.98,
"workdays": 19
},
{
"business_due_date": "2027-06-03",
"calendar_days": 31,
"due_date": "2027-06-02",
"due_principal": 13886.54630557,
"installment_number": 24,
"pre_fixed_amount": 248.31635619,
"principal_amortization_amount": 207.66364381,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2027-07-05",
"calendar_days": 30,
"due_date": "2027-07-02",
"due_principal": 13678.88266176,
"installment_number": 25,
"pre_fixed_amount": 236.64468436,
"principal_amortization_amount": 219.33531564,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2027-08-03",
"calendar_days": 31,
"due_date": "2027-08-02",
"due_principal": 13459.54734612,
"installment_number": 26,
"pre_fixed_amount": 240.68084889,
"principal_amortization_amount": 215.29915111,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2027-09-03",
"calendar_days": 31,
"due_date": "2027-09-02",
"due_principal": 13244.24819501,
"installment_number": 27,
"pre_fixed_amount": 236.83091388,
"principal_amortization_amount": 219.14908612,
"total_amount": 455.98,
"workdays": 23
},
{
"business_due_date": "2027-10-05",
"calendar_days": 30,
"due_date": "2027-10-02",
"due_principal": 13025.09910889,
"installment_number": 28,
"pre_fixed_amount": 225.33422821,
"principal_amortization_amount": 230.64577179,
"total_amount": 455.98,
"workdays": 20
},
{
"business_due_date": "2027-11-04",
"calendar_days": 31,
"due_date": "2027-11-02",
"due_principal": 12794.4533371,
"installment_number": 29,
"pre_fixed_amount": 228.78777503,
"principal_amortization_amount": 227.19222497,
"total_amount": 455.98,
"workdays": 20
},
{
"business_due_date": "2027-12-03",
"calendar_days": 30,
"due_date": "2027-12-02",
"due_principal": 12567.26111213,
"installment_number": 30,
"pre_fixed_amount": 217.41363039,
"principal_amortization_amount": 238.56636961,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2028-01-04",
"calendar_days": 31,
"due_date": "2028-01-02",
"due_principal": 12328.69474252,
"installment_number": 31,
"pre_fixed_amount": 220.45917593,
"principal_amortization_amount": 235.52082407,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2028-02-03",
"calendar_days": 31,
"due_date": "2028-02-02",
"due_principal": 12093.17391845,
"installment_number": 32,
"pre_fixed_amount": 216.24764114,
"principal_amortization_amount": 239.73235886,
"total_amount": 455.98,
"workdays": 23
},
{
"business_due_date": "2028-03-03",
"calendar_days": 29,
"due_date": "2028-03-02",
"due_principal": 11853.44155959,
"installment_number": 33,
"pre_fixed_amount": 198.17224791,
"principal_amortization_amount": 257.80775209,
"total_amount": 455.98,
"workdays": 19
},
{
"business_due_date": "2028-04-04",
"calendar_days": 31,
"due_date": "2028-04-02",
"due_principal": 11595.6338075,
"installment_number": 34,
"pre_fixed_amount": 207.35073152,
"principal_amortization_amount": 248.62926848,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2028-05-03",
"calendar_days": 30,
"due_date": "2028-05-02",
"due_principal": 11347.00453902,
"installment_number": 35,
"pre_fixed_amount": 196.3031904,
"principal_amortization_amount": 259.6768096,
"total_amount": 455.98,
"workdays": 19
},
{
"business_due_date": "2028-06-05",
"calendar_days": 31,
"due_date": "2028-06-02",
"due_principal": 11087.32772942,
"installment_number": 36,
"pre_fixed_amount": 198.2613071,
"principal_amortization_amount": 257.7186929,
"total_amount": 455.98,
"workdays": 23
},
{
"business_due_date": "2028-07-04",
"calendar_days": 30,
"due_date": "2028-07-02",
"due_principal": 10829.60903652,
"installment_number": 37,
"pre_fixed_amount": 187.35224766,
"principal_amortization_amount": 268.62775234,
"total_amount": 455.98,
"workdays": 19
},
{
"business_due_date": "2028-08-03",
"calendar_days": 31,
"due_date": "2028-08-02",
"due_principal": 10560.98128418,
"installment_number": 38,
"pre_fixed_amount": 188.84928855,
"principal_amortization_amount": 267.13071145,
"total_amount": 455.98,
"workdays": 23
},
{
"business_due_date": "2028-09-05",
"calendar_days": 31,
"due_date": "2028-09-02",
"due_principal": 10293.85057273,
"installment_number": 39,
"pre_fixed_amount": 184.07251228,
"principal_amortization_amount": 271.90748772,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2028-10-03",
"calendar_days": 30,
"due_date": "2028-10-02",
"due_principal": 10021.94308501,
"installment_number": 40,
"pre_fixed_amount": 173.37962586,
"principal_amortization_amount": 282.60037414,
"total_amount": 455.98,
"workdays": 20
},
{
"business_due_date": "2028-11-06",
"calendar_days": 31,
"due_date": "2028-11-02",
"due_principal": 9739.34271087,
"installment_number": 41,
"pre_fixed_amount": 174.15691709,
"principal_amortization_amount": 281.82308291,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2028-12-05",
"calendar_days": 30,
"due_date": "2028-12-02",
"due_principal": 9457.51962796,
"installment_number": 42,
"pre_fixed_amount": 163.61509946,
"principal_amortization_amount": 292.36490054,
"total_amount": 455.98,
"workdays": 19
},
{
"business_due_date": "2029-01-03",
"calendar_days": 31,
"due_date": "2029-01-02",
"due_principal": 9165.15472742,
"installment_number": 43,
"pre_fixed_amount": 163.88940603,
"principal_amortization_amount": 292.09059397,
"total_amount": 455.98,
"workdays": 20
},
{
"business_due_date": "2029-02-05",
"calendar_days": 31,
"due_date": "2029-02-02",
"due_principal": 8873.06413345,
"installment_number": 44,
"pre_fixed_amount": 158.66630229,
"principal_amortization_amount": 297.31369771,
"total_amount": 455.98,
"workdays": 23
},
{
"business_due_date": "2029-03-05",
"calendar_days": 28,
"due_date": "2029-03-02",
"due_principal": 8575.75043574,
"installment_number": 45,
"pre_fixed_amount": 138.39042799,
"principal_amortization_amount": 317.58957201,
"total_amount": 455.98,
"workdays": 18
},
{
"business_due_date": "2029-04-03",
"calendar_days": 31,
"due_date": "2029-04-02",
"due_principal": 8258.16086373,
"installment_number": 46,
"pre_fixed_amount": 147.67072888,
"principal_amortization_amount": 308.30927112,
"total_amount": 455.98,
"workdays": 20
},
{
"business_due_date": "2029-05-03",
"calendar_days": 30,
"due_date": "2029-05-02",
"due_principal": 7949.85159261,
"installment_number": 47,
"pre_fixed_amount": 137.53244087,
"principal_amortization_amount": 318.44755913,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2029-06-05",
"calendar_days": 31,
"due_date": "2029-06-02",
"due_principal": 7631.40403348,
"installment_number": 48,
"pre_fixed_amount": 136.46319254,
"principal_amortization_amount": 319.51680746,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2029-07-03",
"calendar_days": 30,
"due_date": "2029-07-02",
"due_principal": 7311.88722602,
"installment_number": 49,
"pre_fixed_amount": 126.49565666,
"principal_amortization_amount": 329.48434334,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2029-08-03",
"calendar_days": 31,
"due_date": "2029-08-02",
"due_principal": 6982.40288268,
"installment_number": 50,
"pre_fixed_amount": 124.85788785,
"principal_amortization_amount": 331.12211215,
"total_amount": 455.98,
"workdays": 23
},
{
"business_due_date": "2029-09-04",
"calendar_days": 31,
"due_date": "2029-09-02",
"due_principal": 6651.28077053,
"installment_number": 51,
"pre_fixed_amount": 118.93683055,
"principal_amortization_amount": 337.04316945,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2029-10-03",
"calendar_days": 30,
"due_date": "2029-10-02",
"due_principal": 6314.23760108,
"installment_number": 52,
"pre_fixed_amount": 109.23631711,
"principal_amortization_amount": 346.74368289,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2029-11-06",
"calendar_days": 31,
"due_date": "2029-11-02",
"due_principal": 5967.49391819,
"installment_number": 53,
"pre_fixed_amount": 106.70949513,
"principal_amortization_amount": 349.27050487,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2029-12-04",
"calendar_days": 30,
"due_date": "2029-12-02",
"due_principal": 5618.22341332,
"installment_number": 54,
"pre_fixed_amount": 97.19527093,
"principal_amortization_amount": 358.78472907,
"total_amount": 455.98,
"workdays": 18
},
{
"business_due_date": "2030-01-03",
"calendar_days": 31,
"due_date": "2030-01-02",
"due_principal": 5259.43868425,
"installment_number": 55,
"pre_fixed_amount": 94.04819751,
"principal_amortization_amount": 361.93180249,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2030-02-05",
"calendar_days": 31,
"due_date": "2030-02-02",
"due_principal": 4897.50688176,
"installment_number": 56,
"pre_fixed_amount": 87.57620769,
"principal_amortization_amount": 368.40379231,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2030-03-07",
"calendar_days": 28,
"due_date": "2030-03-02",
"due_principal": 4529.10308945,
"installment_number": 57,
"pre_fixed_amount": 73.08800782,
"principal_amortization_amount": 382.89199218,
"total_amount": 455.98,
"workdays": 20
},
{
"business_due_date": "2030-04-03",
"calendar_days": 31,
"due_date": "2030-04-02",
"due_principal": 4146.21109727,
"installment_number": 58,
"pre_fixed_amount": 74.14169146,
"principal_amortization_amount": 381.83830854,
"total_amount": 455.98,
"workdays": 20
},
{
"business_due_date": "2030-05-03",
"calendar_days": 30,
"due_date": "2030-05-02",
"due_principal": 3764.37278873,
"installment_number": 59,
"pre_fixed_amount": 65.12365318,
"principal_amortization_amount": 390.85634682,
"total_amount": 455.98,
"workdays": 20
},
{
"business_due_date": "2030-06-04",
"calendar_days": 31,
"due_date": "2030-06-02",
"due_principal": 3373.51644191,
"installment_number": 60,
"pre_fixed_amount": 60.32452504,
"principal_amortization_amount": 395.65547496,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2030-07-03",
"calendar_days": 30,
"due_date": "2030-07-02",
"due_principal": 2977.86096695,
"installment_number": 61,
"pre_fixed_amount": 51.51699784,
"principal_amortization_amount": 404.46300216,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2030-08-05",
"calendar_days": 31,
"due_date": "2030-08-02",
"due_principal": 2573.39796479,
"installment_number": 62,
"pre_fixed_amount": 46.0169715,
"principal_amortization_amount": 409.9630285,
"total_amount": 455.98,
"workdays": 23
},
{
"business_due_date": "2030-09-03",
"calendar_days": 31,
"due_date": "2030-09-02",
"due_principal": 2163.43493629,
"installment_number": 63,
"pre_fixed_amount": 38.68609721,
"principal_amortization_amount": 417.29390279,
"total_amount": 455.98,
"workdays": 21
},
{
"business_due_date": "2030-10-03",
"calendar_days": 30,
"due_date": "2030-10-02",
"due_principal": 1746.1410335,
"installment_number": 64,
"pre_fixed_amount": 30.20824171,
"principal_amortization_amount": 425.77175829,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2030-11-05",
"calendar_days": 31,
"due_date": "2030-11-02",
"due_principal": 1320.36927521,
"installment_number": 65,
"pre_fixed_amount": 23.61057098,
"principal_amortization_amount": 432.36942902,
"total_amount": 455.98,
"workdays": 22
},
{
"business_due_date": "2030-12-03",
"calendar_days": 30,
"due_date": "2030-12-02",
"due_principal": 887.99984619,
"installment_number": 66,
"pre_fixed_amount": 15.36239827,
"principal_amortization_amount": 440.61760173,
"total_amount": 455.98,
"workdays": 19
},
{
"business_due_date": "2031-01-03",
"calendar_days": 31,
"due_date": "2031-01-02",
"due_principal": 447.38224446,
"installment_number": 67,
"pre_fixed_amount": 8.59775554,
"principal_amortization_amount": 447.38224446,
"total_amount": 455.98,
"workdays": 21
}
],
"issue_amount": 17879.22,
"number_of_installments": 67,
"prefixed_interest_rate": {
"annual_rate": 0.2285378296,
"daily_rate": 0.0005718988,
"interest_base": "calendar_days",
"monthly_rate": 0.0173
},
"total_iof": 0
}
],
"document_key": "f85d9799-e29f-4133-80c3-3e95f16f2a54",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/f85d9799-e29f-4133-80c3-3e95f16f2a54/MMRIOLTDA-IVANETESATURNINODESOUZA-CCB-CTC0000024971.pdf",
"final_disbursement_amount": 17879.22
},
"proposal_key": "1e1d3f4d-21aa-4b6f-8515-6d978dc2afa5",
"proposal_number": "17488903030996687",
"proposal_status": "pending_submission",
"refinancing_credit_operation": {
"collateral_is_constituted": false,
"contract_number": "CTC0000024972",
"credit_operation_key": "7cc4d931-34d5-4b03-b04b-9ae4b6721f45",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [
{
"account_branch": "1261",
"account_digit": "1",
"account_number": "000062293",
"bank_code": "237"
}
],
"disbursement_options": [
{
"annual_cet": 0.2517,
"cet": 0.0189,
"contract_fee_amount": 0,
"contract_fees": [],
"disbursed_issue_amount": 20373.27,
"disbursement_date": "2025-06-02",
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"final_disbursement_amount": 2494.05,
"installments": [
{
"business_due_date": "2025-07-03",
"calendar_days": 30,
"due_date": "2025-07-02",
"due_principal": 20458.57,
"installment_number": 1,
"pre_fixed_amount": 378.48354031,
"principal_amortization_amount": 82.99645969,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2025-08-05",
"calendar_days": 31,
"due_date": "2025-08-02",
"due_principal": 20375.57354031,
"installment_number": 2,
"pre_fixed_amount": 389.63243305,
"principal_amortization_amount": 71.84756695,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2025-09-03",
"calendar_days": 31,
"due_date": "2025-09-02",
"due_principal": 20303.72597336,
"installment_number": 3,
"pre_fixed_amount": 388.25852609,
"principal_amortization_amount": 73.22147391,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2025-10-03",
"calendar_days": 30,
"due_date": "2025-10-02",
"due_principal": 20230.50449945,
"installment_number": 4,
"pre_fixed_amount": 374.2643286,
"principal_amortization_amount": 87.2156714,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2025-11-04",
"calendar_days": 31,
"due_date": "2025-11-02",
"due_principal": 20143.28882805,
"installment_number": 5,
"pre_fixed_amount": 385.19056262,
"principal_amortization_amount": 76.28943738,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2025-12-03",
"calendar_days": 30,
"due_date": "2025-12-02",
"due_principal": 20066.99939067,
"installment_number": 6,
"pre_fixed_amount": 371.23948413,
"principal_amortization_amount": 90.24051587,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2026-01-05",
"calendar_days": 31,
"due_date": "2026-01-02",
"due_principal": 19976.7588748,
"installment_number": 7,
"pre_fixed_amount": 382.00608928,
"principal_amortization_amount": 79.47391072,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2026-02-03",
"calendar_days": 31,
"due_date": "2026-02-02",
"due_principal": 19897.28496408,
"installment_number": 8,
"pre_fixed_amount": 380.48634736,
"principal_amortization_amount": 80.99365264,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2026-03-03",
"calendar_days": 28,
"due_date": "2026-03-02",
"due_principal": 19816.29131144,
"installment_number": 9,
"pre_fixed_amount": 341.95166774,
"principal_amortization_amount": 119.52833226,
"total_amount": 461.48,
"workdays": 18
},
{
"business_due_date": "2026-04-06",
"calendar_days": 31,
"due_date": "2026-04-02",
"due_principal": 19696.76297918,
"installment_number": 10,
"pre_fixed_amount": 376.65186051,
"principal_amortization_amount": 84.82813949,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2026-05-05",
"calendar_days": 30,
"due_date": "2026-05-02",
"due_principal": 19611.93483969,
"installment_number": 11,
"pre_fixed_amount": 362.82079004,
"principal_amortization_amount": 98.65920996,
"total_amount": 461.48,
"workdays": 18
},
{
"business_due_date": "2026-06-03",
"calendar_days": 31,
"due_date": "2026-06-02",
"due_principal": 19513.27562973,
"installment_number": 12,
"pre_fixed_amount": 373.14311891,
"principal_amortization_amount": 88.33688109,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2026-07-03",
"calendar_days": 30,
"due_date": "2026-07-02",
"due_principal": 19424.93874864,
"installment_number": 13,
"pre_fixed_amount": 359.3613624,
"principal_amortization_amount": 102.1186376,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2026-08-04",
"calendar_days": 31,
"due_date": "2026-08-02",
"due_principal": 19322.82011104,
"installment_number": 14,
"pre_fixed_amount": 369.50112832,
"principal_amortization_amount": 91.97887168,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2026-09-03",
"calendar_days": 31,
"due_date": "2026-09-02",
"due_principal": 19230.84123936,
"installment_number": 15,
"pre_fixed_amount": 367.74225996,
"principal_amortization_amount": 93.73774004,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2026-10-05",
"calendar_days": 30,
"due_date": "2026-10-02",
"due_principal": 19137.10349932,
"installment_number": 16,
"pre_fixed_amount": 354.03641035,
"principal_amortization_amount": 107.44358965,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2026-11-04",
"calendar_days": 31,
"due_date": "2026-11-02",
"due_principal": 19029.65990967,
"installment_number": 17,
"pre_fixed_amount": 363.89516477,
"principal_amortization_amount": 97.58483523,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2026-12-03",
"calendar_days": 30,
"due_date": "2026-12-02",
"due_principal": 18932.07507444,
"installment_number": 18,
"pre_fixed_amount": 350.24338454,
"principal_amortization_amount": 111.23661546,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2027-01-05",
"calendar_days": 31,
"due_date": "2027-01-02",
"due_principal": 18820.83845898,
"installment_number": 19,
"pre_fixed_amount": 359.90197117,
"principal_amortization_amount": 101.57802883,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2027-02-03",
"calendar_days": 31,
"due_date": "2027-02-02",
"due_principal": 18719.26043015,
"installment_number": 20,
"pre_fixed_amount": 357.95954268,
"principal_amortization_amount": 103.52045732,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2027-03-03",
"calendar_days": 28,
"due_date": "2027-03-02",
"due_principal": 18615.73997283,
"installment_number": 21,
"pre_fixed_amount": 321.23484813,
"principal_amortization_amount": 140.24515187,
"total_amount": 461.48,
"workdays": 18
},
{
"business_due_date": "2027-04-05",
"calendar_days": 31,
"due_date": "2027-04-02",
"due_principal": 18475.49482096,
"installment_number": 22,
"pre_fixed_amount": 353.2981285,
"principal_amortization_amount": 108.1818715,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2027-05-04",
"calendar_days": 30,
"due_date": "2027-05-02",
"due_principal": 18367.31294946,
"installment_number": 23,
"pre_fixed_amount": 339.79528536,
"principal_amortization_amount": 121.68471464,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2027-06-03",
"calendar_days": 31,
"due_date": "2027-06-02",
"due_principal": 18245.62823482,
"installment_number": 24,
"pre_fixed_amount": 348.90249875,
"principal_amortization_amount": 112.57750125,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2027-07-05",
"calendar_days": 30,
"due_date": "2027-07-02",
"due_principal": 18133.05073357,
"installment_number": 25,
"pre_fixed_amount": 335.46143442,
"principal_amortization_amount": 126.01856558,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2027-08-03",
"calendar_days": 31,
"due_date": "2027-08-02",
"due_principal": 18007.03216799,
"installment_number": 26,
"pre_fixed_amount": 344.33993928,
"principal_amortization_amount": 117.14006072,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2027-09-03",
"calendar_days": 31,
"due_date": "2027-09-02",
"due_principal": 17889.89210727,
"installment_number": 27,
"pre_fixed_amount": 342.09992543,
"principal_amortization_amount": 119.38007457,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2027-10-05",
"calendar_days": 30,
"due_date": "2027-10-02",
"due_principal": 17770.5120327,
"installment_number": 28,
"pre_fixed_amount": 328.75446853,
"principal_amortization_amount": 132.72553147,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2027-11-04",
"calendar_days": 31,
"due_date": "2027-11-02",
"due_principal": 17637.78650123,
"installment_number": 29,
"pre_fixed_amount": 337.27902945,
"principal_amortization_amount": 124.20097055,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2027-12-03",
"calendar_days": 30,
"due_date": "2027-12-02",
"due_principal": 17513.58553068,
"installment_number": 30,
"pre_fixed_amount": 324.0013283,
"principal_amortization_amount": 137.4786717,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2028-01-04",
"calendar_days": 31,
"due_date": "2028-01-02",
"due_principal": 17376.10685898,
"installment_number": 31,
"pre_fixed_amount": 332.27505371,
"principal_amortization_amount": 129.20494629,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2028-02-03",
"calendar_days": 31,
"due_date": "2028-02-02",
"due_principal": 17246.90191269,
"installment_number": 32,
"pre_fixed_amount": 329.80432878,
"principal_amortization_amount": 131.67567122,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2028-03-03",
"calendar_days": 29,
"due_date": "2028-03-02",
"due_principal": 17115.22624147,
"installment_number": 33,
"pre_fixed_amount": 305.98351411,
"principal_amortization_amount": 155.49648589,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2028-04-04",
"calendar_days": 31,
"due_date": "2028-04-02",
"due_principal": 16959.72975558,
"installment_number": 34,
"pre_fixed_amount": 324.31287176,
"principal_amortization_amount": 137.16712824,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2028-05-03",
"calendar_days": 30,
"due_date": "2028-05-02",
"due_principal": 16822.56262734,
"installment_number": 35,
"pre_fixed_amount": 311.21740475,
"principal_amortization_amount": 150.26259525,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2028-06-05",
"calendar_days": 31,
"due_date": "2028-06-02",
"due_principal": 16672.30003209,
"installment_number": 36,
"pre_fixed_amount": 318.81648942,
"principal_amortization_amount": 142.66351058,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2028-07-04",
"calendar_days": 30,
"due_date": "2028-07-02",
"due_principal": 16529.63652151,
"installment_number": 37,
"pre_fixed_amount": 305.79827186,
"principal_amortization_amount": 155.68172814,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2028-08-03",
"calendar_days": 31,
"due_date": "2028-08-02",
"due_principal": 16373.95479337,
"installment_number": 38,
"pre_fixed_amount": 313.11137486,
"principal_amortization_amount": 148.36862514,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2028-09-05",
"calendar_days": 31,
"due_date": "2028-09-02",
"due_principal": 16225.58616823,
"installment_number": 39,
"pre_fixed_amount": 310.27419199,
"principal_amortization_amount": 151.20580801,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2028-10-03",
"calendar_days": 30,
"due_date": "2028-10-02",
"due_principal": 16074.38036022,
"installment_number": 40,
"pre_fixed_amount": 297.37603298,
"principal_amortization_amount": 164.10396702,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2028-11-06",
"calendar_days": 31,
"due_date": "2028-11-02",
"due_principal": 15910.2763932,
"installment_number": 41,
"pre_fixed_amount": 304.24467264,
"principal_amortization_amount": 157.23532736,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2028-12-05",
"calendar_days": 30,
"due_date": "2028-12-02",
"due_principal": 15753.04106584,
"installment_number": 42,
"pre_fixed_amount": 291.43125611,
"principal_amortization_amount": 170.04874389,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2029-01-03",
"calendar_days": 31,
"due_date": "2029-01-02",
"due_principal": 15582.99232195,
"installment_number": 43,
"pre_fixed_amount": 297.98617451,
"principal_amortization_amount": 163.49382549,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2029-02-05",
"calendar_days": 31,
"due_date": "2029-02-02",
"due_principal": 15419.49849646,
"installment_number": 44,
"pre_fixed_amount": 294.85975959,
"principal_amortization_amount": 166.62024041,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2029-03-05",
"calendar_days": 28,
"due_date": "2029-03-02",
"due_principal": 15252.87825605,
"installment_number": 45,
"pre_fixed_amount": 263.20501023,
"principal_amortization_amount": 198.27498977,
"total_amount": 461.48,
"workdays": 18
},
{
"business_due_date": "2029-04-03",
"calendar_days": 31,
"due_date": "2029-04-02",
"due_principal": 15054.60326628,
"installment_number": 46,
"pre_fixed_amount": 287.8820411,
"principal_amortization_amount": 173.5979589,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2029-05-03",
"calendar_days": 30,
"due_date": "2029-05-02",
"due_principal": 14881.00530738,
"installment_number": 47,
"pre_fixed_amount": 275.29859478,
"principal_amortization_amount": 186.18140522,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2029-06-05",
"calendar_days": 31,
"due_date": "2029-06-02",
"due_principal": 14694.82390216,
"installment_number": 48,
"pre_fixed_amount": 281.00215088,
"principal_amortization_amount": 180.47784912,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2029-07-03",
"calendar_days": 30,
"due_date": "2029-07-02",
"due_principal": 14514.34605304,
"installment_number": 49,
"pre_fixed_amount": 268.51539866,
"principal_amortization_amount": 192.96460134,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2029-08-03",
"calendar_days": 31,
"due_date": "2029-08-02",
"due_principal": 14321.3814517,
"installment_number": 50,
"pre_fixed_amount": 273.86098795,
"principal_amortization_amount": 187.61901205,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2029-09-04",
"calendar_days": 31,
"due_date": "2029-09-02",
"due_principal": 14133.76243965,
"installment_number": 51,
"pre_fixed_amount": 270.27323853,
"principal_amortization_amount": 191.20676147,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2029-10-03",
"calendar_days": 30,
"due_date": "2029-10-02",
"due_principal": 13942.55567818,
"installment_number": 52,
"pre_fixed_amount": 257.93727685,
"principal_amortization_amount": 203.54272315,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2029-11-06",
"calendar_days": 31,
"due_date": "2029-11-02",
"due_principal": 13739.01295503,
"installment_number": 53,
"pre_fixed_amount": 262.72463128,
"principal_amortization_amount": 198.75536872,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2029-12-04",
"calendar_days": 30,
"due_date": "2029-12-02",
"due_principal": 13540.25758631,
"installment_number": 54,
"pre_fixed_amount": 250.49476224,
"principal_amortization_amount": 210.98523776,
"total_amount": 461.48,
"workdays": 18
},
{
"business_due_date": "2030-01-03",
"calendar_days": 31,
"due_date": "2030-01-02",
"due_principal": 13329.27234855,
"installment_number": 55,
"pre_fixed_amount": 254.88935591,
"principal_amortization_amount": 206.59064409,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2030-02-05",
"calendar_days": 31,
"due_date": "2030-02-02",
"due_principal": 13122.68170446,
"installment_number": 56,
"pre_fixed_amount": 250.93882097,
"principal_amortization_amount": 210.54117903,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2030-03-07",
"calendar_days": 28,
"due_date": "2030-03-02",
"due_principal": 12912.14052543,
"installment_number": 57,
"pre_fixed_amount": 222.81303385,
"principal_amortization_amount": 238.66696615,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2030-04-03",
"calendar_days": 31,
"due_date": "2030-04-02",
"due_principal": 12673.47355928,
"installment_number": 58,
"pre_fixed_amount": 242.34882657,
"principal_amortization_amount": 219.13117343,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2030-05-03",
"calendar_days": 30,
"due_date": "2030-05-02",
"due_principal": 12454.34238585,
"installment_number": 59,
"pre_fixed_amount": 230.40533128,
"principal_amortization_amount": 231.07466872,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2030-06-04",
"calendar_days": 31,
"due_date": "2030-06-02",
"due_principal": 12223.26771713,
"installment_number": 60,
"pre_fixed_amount": 233.73975368,
"principal_amortization_amount": 227.74024632,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2030-07-03",
"calendar_days": 30,
"due_date": "2030-07-02",
"due_principal": 11995.52747081,
"installment_number": 61,
"pre_fixed_amount": 221.91725546,
"principal_amortization_amount": 239.56274454,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2030-08-05",
"calendar_days": 31,
"due_date": "2030-08-02",
"due_principal": 11755.96472627,
"installment_number": 62,
"pre_fixed_amount": 224.80374013,
"principal_amortization_amount": 236.67625987,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2030-09-03",
"calendar_days": 31,
"due_date": "2030-09-02",
"due_principal": 11519.2884664,
"installment_number": 63,
"pre_fixed_amount": 220.27789222,
"principal_amortization_amount": 241.20210778,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2030-10-03",
"calendar_days": 30,
"due_date": "2030-10-02",
"due_principal": 11278.08635862,
"installment_number": 64,
"pre_fixed_amount": 208.64459505,
"principal_amortization_amount": 252.83540495,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2030-11-05",
"calendar_days": 31,
"due_date": "2030-11-02",
"due_principal": 11025.25095367,
"installment_number": 65,
"pre_fixed_amount": 210.83064708,
"principal_amortization_amount": 250.64935292,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2030-12-03",
"calendar_days": 30,
"due_date": "2030-12-02",
"due_principal": 10774.60160075,
"installment_number": 66,
"pre_fixed_amount": 199.33012714,
"principal_amortization_amount": 262.14987286,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2031-01-03",
"calendar_days": 31,
"due_date": "2031-01-02",
"due_principal": 10512.45172789,
"installment_number": 67,
"pre_fixed_amount": 201.02463059,
"principal_amortization_amount": 260.45536941,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2031-02-04",
"calendar_days": 31,
"due_date": "2031-02-02",
"due_principal": 10251.99635848,
"installment_number": 68,
"pre_fixed_amount": 196.04406604,
"principal_amortization_amount": 265.43593396,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2031-03-04",
"calendar_days": 28,
"due_date": "2031-03-02",
"due_principal": 9986.56042452,
"installment_number": 69,
"pre_fixed_amount": 172.32896602,
"principal_amortization_amount": 289.15103398,
"total_amount": 461.48,
"workdays": 18
},
{
"business_due_date": "2031-04-03",
"calendar_days": 31,
"due_date": "2031-04-02",
"due_principal": 9697.40939054,
"installment_number": 70,
"pre_fixed_amount": 185.43896238,
"principal_amortization_amount": 276.04103762,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2031-05-05",
"calendar_days": 30,
"due_date": "2031-05-02",
"due_principal": 9421.36835292,
"installment_number": 71,
"pre_fixed_amount": 174.29531237,
"principal_amortization_amount": 287.18468763,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2031-06-03",
"calendar_days": 31,
"due_date": "2031-06-02",
"due_principal": 9134.18366529,
"installment_number": 72,
"pre_fixed_amount": 174.66866385,
"principal_amortization_amount": 286.81133615,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2031-07-03",
"calendar_days": 30,
"due_date": "2031-07-02",
"due_principal": 8847.37232914,
"installment_number": 73,
"pre_fixed_amount": 163.67638606,
"principal_amortization_amount": 297.80361394,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2031-08-05",
"calendar_days": 31,
"due_date": "2031-08-02",
"due_principal": 8549.5687152,
"installment_number": 74,
"pre_fixed_amount": 163.48934932,
"principal_amortization_amount": 297.99065068,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2031-09-03",
"calendar_days": 31,
"due_date": "2031-09-02",
"due_principal": 8251.57806452,
"installment_number": 75,
"pre_fixed_amount": 157.79101538,
"principal_amortization_amount": 303.68898462,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2031-10-03",
"calendar_days": 30,
"due_date": "2031-10-02",
"due_principal": 7947.8890799,
"installment_number": 76,
"pre_fixed_amount": 147.03594616,
"principal_amortization_amount": 314.44405384,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2031-11-04",
"calendar_days": 31,
"due_date": "2031-11-02",
"due_principal": 7633.44502606,
"installment_number": 77,
"pre_fixed_amount": 145.97075033,
"principal_amortization_amount": 315.50924967,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2031-12-03",
"calendar_days": 30,
"due_date": "2031-12-02",
"due_principal": 7317.93577639,
"installment_number": 78,
"pre_fixed_amount": 135.38181019,
"principal_amortization_amount": 326.09818981,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2032-01-05",
"calendar_days": 31,
"due_date": "2032-01-02",
"due_principal": 6991.83758658,
"installment_number": 79,
"pre_fixed_amount": 133.70159544,
"principal_amortization_amount": 327.77840456,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2032-02-03",
"calendar_days": 31,
"due_date": "2032-02-02",
"due_principal": 6664.05918202,
"installment_number": 80,
"pre_fixed_amount": 127.43364441,
"principal_amortization_amount": 334.04635559,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2032-03-03",
"calendar_days": 29,
"due_date": "2032-03-02",
"due_principal": 6330.01282643,
"installment_number": 81,
"pre_fixed_amount": 113.16704446,
"principal_amortization_amount": 348.31295554,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2032-04-05",
"calendar_days": 31,
"due_date": "2032-04-02",
"due_principal": 5981.69987089,
"installment_number": 82,
"pre_fixed_amount": 114.3852108,
"principal_amortization_amount": 347.0947892,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2032-05-04",
"calendar_days": 30,
"due_date": "2032-05-02",
"due_principal": 5634.60508169,
"installment_number": 83,
"pre_fixed_amount": 104.24019272,
"principal_amortization_amount": 357.23980728,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2032-06-03",
"calendar_days": 31,
"due_date": "2032-06-02",
"due_principal": 5277.36527441,
"installment_number": 84,
"pre_fixed_amount": 100.91655422,
"principal_amortization_amount": 360.56344578,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2032-07-05",
"calendar_days": 30,
"due_date": "2032-07-02",
"due_principal": 4916.80182863,
"installment_number": 85,
"pre_fixed_amount": 90.9608327,
"principal_amortization_amount": 370.5191673,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2032-08-03",
"calendar_days": 31,
"due_date": "2032-08-02",
"due_principal": 4546.28266133,
"installment_number": 86,
"pre_fixed_amount": 86.93640801,
"principal_amortization_amount": 374.54359199,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2032-09-03",
"calendar_days": 31,
"due_date": "2032-09-02",
"due_principal": 4171.73906934,
"installment_number": 87,
"pre_fixed_amount": 79.77418846,
"principal_amortization_amount": 381.70581154,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2032-10-05",
"calendar_days": 30,
"due_date": "2032-10-02",
"due_principal": 3790.0332578,
"installment_number": 88,
"pre_fixed_amount": 70.1156144,
"principal_amortization_amount": 391.3643856,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2032-11-04",
"calendar_days": 31,
"due_date": "2032-11-02",
"due_principal": 3398.6688722,
"installment_number": 89,
"pre_fixed_amount": 64.99113358,
"principal_amortization_amount": 396.48886642,
"total_amount": 461.48,
"workdays": 20
},
{
"business_due_date": "2032-12-03",
"calendar_days": 30,
"due_date": "2032-12-02",
"due_principal": 3002.18000578,
"installment_number": 90,
"pre_fixed_amount": 55.54032942,
"principal_amortization_amount": 405.93967058,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2033-01-04",
"calendar_days": 31,
"due_date": "2033-01-02",
"due_principal": 2596.2403352,
"installment_number": 91,
"pre_fixed_amount": 49.64667309,
"principal_amortization_amount": 411.83332691,
"total_amount": 461.48,
"workdays": 21
},
{
"business_due_date": "2033-02-03",
"calendar_days": 31,
"due_date": "2033-02-02",
"due_principal": 2184.40700829,
"installment_number": 92,
"pre_fixed_amount": 41.77137962,
"principal_amortization_amount": 419.70862038,
"total_amount": 461.48,
"workdays": 23
},
{
"business_due_date": "2033-03-03",
"calendar_days": 28,
"due_date": "2033-03-02",
"due_principal": 1764.69838791,
"installment_number": 93,
"pre_fixed_amount": 30.45179077,
"principal_amortization_amount": 431.02820923,
"total_amount": 461.48,
"workdays": 18
},
{
"business_due_date": "2033-04-05",
"calendar_days": 31,
"due_date": "2033-04-02",
"due_principal": 1333.67017868,
"installment_number": 94,
"pre_fixed_amount": 25.50314255,
"principal_amortization_amount": 435.97685745,
"total_amount": 461.48,
"workdays": 22
},
{
"business_due_date": "2033-05-03",
"calendar_days": 30,
"due_date": "2033-05-02",
"due_principal": 897.69332123,
"installment_number": 95,
"pre_fixed_amount": 16.60732624,
"principal_amortization_amount": 444.87267376,
"total_amount": 461.48,
"workdays": 19
},
{
"business_due_date": "2033-06-03",
"calendar_days": 31,
"due_date": "2033-06-02",
"due_principal": 452.82064747,
"installment_number": 96,
"pre_fixed_amount": 8.65935253,
"principal_amortization_amount": 452.82064747,
"total_amount": 461.48,
"workdays": 23
}
],
"issue_amount": 20458.57,
"number_of_installments": 96,
"prefixed_interest_rate": {
"annual_rate": 0.2460411933,
"daily_rate": 0.0006112186,
"interest_base": "calendar_days",
"monthly_rate": 0.0185
},
"total_iof": 85.3
}
],
"document_key": "60763cba-da54-4826-bf76-b8f3d26c6326",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/60763cba-da54-4826-bf76-b8f3d26c6326/MMRIOLTDA-A-CCB-CTC0000024972.pdf",
"final_disbursement_amount": 2494.05
},
"requester_control_key": "0e856d23-0746-4444-a71a-2957a64c869a"
}
信息
对于纯转移提案数据的恢复，"refinancing_credit_operation" 对象将不会被返回。
带新 CCB 签名的再融资数据更正：
在再融资尚未被接受之前，可以更正再融资操作的财务数据和银行数据。
ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operationMÉTODO
PUTRequest Body
{
"financial": {
"interest_type": "pre_price_days",
"first_due_date": "2024-06-10",
"fine_configuration": {
"monthly_rate": 0.01,
"interest_base": "calendar_days",
"contract_fine_rate": 0.02
},
"credit_operation_type": "ccb",
"monthly_interest_rate": 0.0167,
"installment_face_value": 410,
"limit_days_to_disburse": 7,
"number_of_installments": 84
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"bank_code": "033",
"branch_number": "0001"
}
}
Response:
response.json
{
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"contract_number": "00000002",
"document_key": "\<DOCUMENT-KEY da CCB de Refinanciamento\>",
"document_url": "\<URL da CCB de Refinanciamento\>",
"credit_operation_status": "issued",
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"digitable_line": null,
"due_date": "2021-08-08",
"due_interest": 0,
"due_principal": 997.87,
"fine_amount": null,
"has_interest": true,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2021-09-08",
"due_interest": 0,
"due_principal": 690.8886500498395,
"fine_amount": null,
"has_interest": true,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"tax_amount": 0,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 50,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 997.87,
"final_disbursement_amount": 100,
"issue_amount": 1147.87,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}],
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"ispb": "00000000",
"branch_number": "0001"
}
}
警告
再融资操作键、文档键、文档 URL、related_party_key 和借款人 related_party_key 将在此操作后更改，需要重新签署 CCB。
再融资数据更正：
可以重新计算再融资操作的分期金额而无需生成新的 CCB。新金额将根据录入时提供的利率，应用于当前未偿余额来计算。
ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation/recalculateMÉTODO
PUTRequest Body
{
"financial": {
"interest_type": "pre_price_days",
"first_due_date": "2024-06-10",
"fine_configuration": {
"monthly_rate": 0.01,
"interest_base": "calendar_days",
"contract_fine_rate": 0.02
},
"credit_operation_type": "ccb",
"monthly_interest_rate": 0.0167,
"installment_face_value": 410,
"limit_days_to_disburse": 7,
"number_of_installments": 84
},
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"bank_code": "033",
"branch_number": "0001"
}
}
Response:
response.json
{
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"contract_number": "00000002",
"document_key": "\<DOCUMENT-KEY da CCB de Refinanciamento\>",
"document_url": "\<URL da CCB de Refinanciamento\>",
"credit_operation_status": "issued",
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"digitable_line": null,
"due_date": "2021-08-08",
"due_interest": 0,
"due_principal": 997.87,
"fine_amount": null,
"has_interest": true,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2021-09-08",
"due_interest": 0,
"due_principal": 690.8886500498395,
"fine_amount": null,
"has_interest": true,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"tax_amount": 0,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 50,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 997.87,
"final_disbursement_amount": 100,
"issue_amount": 1147.87,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}],
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"ispb": "00000000",
"branch_number": "0001"
}
}
转移和再融资数据更正：
可以更正银行数据、福利编号和姓名，直到转移合同状态变为 "pending_response" 之前。
ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY/collateralMÉTODO
PATCHRequest Body
- Dados Bancários
- Número do Benefício
- Nome
- Nome da Mãe
{
"disbursement_bank_account": {
"bank_code": "123",
"account_digit": "1",
"account_branch": "1234",
"account_number": "5678",
"document_number": "12345678901"
}
}
{
"benefit_number": 1234567890
}
{
"name": "Nome do Beneficiário"
}
{
"mother_name": "Nome da Mãe do Beneficiário"
}
在沙盒中模拟背书的成功和失败场景：
场景模拟基于操作中提供的 CPF 第一位数字。
11.1. 对于以数字 1 开头的 CPF，将通过 Webhook 返回异步成功响应。
11.2. 对于其他 CPF，将根据输入的 CPF 第一位数字，按照下表返回异步错误响应。
11.3. 操作为 "cancel" 的错误将收到包含操 作最终结果的 webhook。
| Início do cpf | Enumerador | Descrição | Ação |
|---|---|---|---|
| 2 | invalid_disbursement_account | Invalid disbursemente bank account | cancel |
| 3 | operation_not_allowed_IR | Operation not allowed due to operation deadline greatter than benefit termination | cancel |
Atenção
所有未映射到第一位数字场景的 CPF，将收到一个包含未映射测试场景标准错误的 webhook。
| Enumerador | Descrição |
|---|---|
| mock_error | Informed document number is not a valid mock on test environment |
4 - 文件上传
根据 INSS 第 138 号规范性指令，必须发送合同的补充数据。
文件必须通过文件上传端点发送。
| Validações | Valores |
|---|---|
| Formato | JPEG |
| Tamanho mínimo | 250 x 250 px |
| Tamanho máximo | 2 MB |
Atenção
不符合最小或最大文件大小规则的合同，将无法背书，相应的错误信息将通过 webhook 发送。
如果验证未通过，当合作方在收到未偿余额后继续处理提案时，将返回以下错误：
- Formato inválido
- Tamanho inválido
{
"title": "Invalid document format",
"description": "The document: document_identification_back should be in JPEG format.",
"translation": "O documento: document_identification_back deve estar no formato JPEG.",
"code": "SSC000061"
}
{
"title": "Invalid document size",
"description": "The document: document_identification_back should have at least 250x250px.",
"translation": "O documento: document_identification_back deve ter no mínimo 250x250px.",
"code": "SSC000060"
}
文件上传后，所上传文件的键值必须在创建提案的 payload 中（在 borrower 字段内）或在对应法定代理人的 related_parties* 对象内（"role_type": "issuer_legal_representative"）填写：
{
"document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41",
"document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431",
"selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c"
}
或者，在提案创建后，可通过以下端点告知：
ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY/related_party/RELATED-PARTY-KEY/attached_documentMÉTODO
POSTRequest Body
{
"document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41",
"document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431",
"selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c"
}
Informação
related_party_key 在债务创建响应的 borrower 对象中返回，用于将文件关联到相关人员（借款人或法定代理人）。
5 - 模拟转移和/或再融资提案：
Atenção
对于涉及再融资后找零的提案，需要预先计算找零金额，该金额至少应为所有分期金额现值之和与原始债务余额之差的 5%。可以通过使用第 5 条中描述的模拟路由来确定找零金额。
STATUS
400Response Body
{
"title": "Bad Request",
"code": "CT000118",
"description": "The final disbursement amount is less than 5% of the sum of refinancing installment minus the sum of portability installment. The minimum final disbursement amount allowed is 500.00. Calculated final disbursement amount: 400.00.",
"translation": "O valor do troco é menor que 5% da soma do valor das parcelas do refinanciamento menos o valor soma das parcelas da portabilidade. O valor mínimo do troco permitido é de 500.00. Valor calculado do troco: 400.00."
}
5.1. 带再融资的转移模拟： 在录入带再融资的转移提案之前，可以模拟操作的财务条件。
5.1.1. 带再融资的转移模拟 - 固定利率： 与提案录入（3.1.1）类似，可以通过固定转移合同利率进行模拟。
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Request:
body.json
{
"borrower": {
"person_type": "natural"
},
"collaterals": [{
"collateral_type": "social_security"
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"number_of_installments": 10
}
},
"refinancing_credit_operation": {
"financial": {
"days_to_accrual": 0,
"monthly_interest_rate": 0.0132,
"installment_face_value": 100,
"number_of_installments": 10
}
},
"origin_contract": {
"last_due_balance": 997.87
}
}
信息
上述 payload 描述了执行模拟所需的最低数据。
Response
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload：
response.json
{
"borrower": {
"individual_document_number": "98765432100",
"related_party_key": "fa55dca3-3147-45d2-bb8d-941f2d7191da",
"role_type": "issuer"
},
"portability_credit_operation": {
"credit_operation_key": "a66675e6-bdc2-4468-8420-2889d5cec0a8",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.173044,
"cet": 0.0134,
"contract_fee_amount": 0.0,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": 0.0,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 997.87,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 997.87,
"installment_number": 1,
"pre_fixed_amount": 27.413791524708554,
"principal_amortization_amount": 81.34620847529145,
"total_amount": 108.76,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 916.5237915247086,
"installment_number": 2,
"pre_fixed_amount": 11.692366920719124,
"principal_amortization_amount": 97.06763307928088,
"total_amount": 108.76,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 819.4561584454277,
"installment_number": 3,
"pre_fixed_amount": 11.179911547915339,
"principal_amortization_amount": 97.58008845208467,
"total_amount": 108.76,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 721.876069993343,
"installment_number": 4,
"pre_fixed_amount": 9.5288330736045,
"principal_amortization_amount": 99.2311669263955,
"total_amount": 108.76,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 33,
"due_date": "2024-06-24",
"due_principal": 622.6449030669476,
"installment_number": 5,
"pre_fixed_amount": 9.046812945831448,
"principal_amortization_amount": 99.71318705416856,
"total_amount": 108.76,
"workdays": 22
},
{
"business_due_date": "2024-07-22",
"calendar_days": 28,
"due_date": "2024-07-22",
"due_principal": 522.9317160127789,
"installment_number": 6,
"pre_fixed_amount": 6.439743824282488,
"principal_amortization_amount": 102.32025617571752,
"total_amount": 108.76,
"workdays": 20
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 420.61145983706143,
"installment_number": 7,
"pre_fixed_amount": 5.738438681013405,
"principal_amortization_amount": 103.0215613189866,
"total_amount": 108.76,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 32,
"due_date": "2024-09-23",
"due_principal": 317.58989851807485,
"installment_number": 8,
"pre_fixed_amount": 4.473657660291388,
"principal_amortization_amount": 104.28634233970861,
"total_amount": 108.76,
"workdays": 22
},
{
"business_due_date": "2024-10-22",
"calendar_days": 29,
"due_date": "2024-10-22",
"due_principal": 213.30355617836625,
"installment_number": 9,
"pre_fixed_amount": 2.721176981322744,
"principal_amortization_amount": 106.03882301867725,
"total_amount": 108.76,
"workdays": 21
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 107.26473315968899,
"installment_number": 10,
"pre_fixed_amount": 1.4934220715493307,
"principal_amortization_amount": 107.26657792845067,
"total_amount": 108.76,
"workdays": 22
}
],
"issue_amount": 997.87,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17042118,
"daily_rate": 0.00043722,
"interest_base": "calendar_days",
"monthly_rate": 0.0132
},
"total_iof": 0.0
}
],
"final_disbursement_amount": 0.0
},
"proposal_key": "28a925f6-570e-4724-9132-3bd42f267c4f",
"proposal_number": "17032788499215403",
"proposal_status": "pending_submission",
"refinancing_credit_operation": {
"credit_operation_key": "aaf9abe0-2b8a-4688-8e09-413e1bd5285e",
"credit_operation_status": "waiting_signature",
"disbursement_accounts": [],
"disbursement_options": [
{
"annual_cet": 0.172031,
"cet": 0.0133,
"contract_fee_amount": -0.4,
"contract_fees": [
{
"amount": 0.5,
"amount_type": "percentage",
"fee_amount": -0.4,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 918.04,
"disbursement_date": "2023-12-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"installments": [
{
"business_due_date": "2024-02-22",
"calendar_days": 62,
"due_date": "2024-02-22",
"due_principal": 917.64,
"installment_number": 1,
"pre_fixed_amount": 25.2095730147,
"principal_amortization_amount": 74.7904269853,
"total_amount": 100.0,
"workdays": 40
},
{
"business_due_date": "2024-03-22",
"calendar_days": 29,
"due_date": "2024-03-22",
"due_principal": 842.8495730147,
"installment_number": 2,
"pre_fixed_amount": 10.7524369787,
"principal_amortization_amount": 89.2475630213,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-04-22",
"calendar_days": 31,
"due_date": "2024-04-22",
"due_principal": 753.6020099934,
"installment_number": 3,
"pre_fixed_amount": 10.2814172859,
"principal_amortization_amount": 89.7185827141,
"total_amount": 100.0,
"workdays": 20
},
{
"business_due_date": "2024-05-22",
"calendar_days": 30,
"due_date": "2024-05-22",
"due_principal": 663.8834272793,
"installment_number": 4,
"pre_fixed_amount": 8.7632941742,
"principal_amortization_amount": 91.2367058258,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-06-24",
"calendar_days": 31,
"due_date": "2024-06-22",
"due_principal": 572.6467214535,
"installment_number": 5,
"pre_fixed_amount": 7.8126464787,
"principal_amortization_amount": 92.1873535213,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-07-22",
"calendar_days": 30,
"due_date": "2024-07-22",
"due_principal": 480.4593679322,
"installment_number": 6,
"pre_fixed_amount": 6.3420966342,
"principal_amortization_amount": 93.6579033658,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-08-22",
"calendar_days": 31,
"due_date": "2024-08-22",
"due_principal": 386.8014645664,
"installment_number": 7,
"pre_fixed_amount": 5.2771618926,
"principal_amortization_amount": 94.7228381074,
"total_amount": 100.0,
"workdays": 23
},
{
"business_due_date": "2024-09-23",
"calendar_days": 31,
"due_date": "2024-09-22",
"due_principal": 292.078626459,
"installment_number": 8,
"pre_fixed_amount": 3.9848593609,
"principal_amortization_amount": 96.0151406391,
"total_amount": 100.0,
"workdays": 21
},
{
"business_due_date": "2024-10-22",
"calendar_days": 30,
"due_date": "2024-10-22",
"due_principal": 196.0634858199,
"installment_number": 9,
"pre_fixed_amount": 2.5880710578,
"principal_amortization_amount": 97.4119289422,
"total_amount": 100.0,
"workdays": 22
},
{
"business_due_date": "2024-11-22",
"calendar_days": 31,
"due_date": "2024-11-22",
"due_principal": 98.6515568777,
"installment_number": 10,
"pre_fixed_amount": 1.3459361963,
"principal_amortization_amount": 98.6540638037,
"total_amount": 100.0,
"workdays": 22
}
],
"issue_amount": 917.64,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.17042118,
"daily_rate": 0.00043722,
"interest_base": "calendar_days",
"monthly_rate": 0.0132
},
"total_iof": 0.0
}
],
"final_disbursement_amount": -79.83
}
}
5.1.2. 带再融资的转移模拟 - 固定释放金额： 与提案录入（3.1.2）类似，可以通过固定向客户释放的金额进行模拟：
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload：
payload.json
{
"borrower": {
"person_type": "natural"
},
"collaterals": [{
"collateral_type": "social_security"
}],
"portability_credit_operation": {
"financial": {
"installment_face_value": 100,
"number_of_installments": 10
}
},
"refinancing_credit_operation": {
"financial": {
"days_to_accrual": 0,
"disbursed_amount": 1000,
"installment_face_value": 100,
"number_of_installments": 10
}
},
"origin_contract": {
"last_due_balance": 997.87
}
}
Response
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload：
payload.json
{
"portability_credit_operation": {
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"due_date": "2021-08-08",
"due_principal": 997.87,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"due_date": "2021-09-08",
"due_principal": 690.89,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 0,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 1000,
"issue_amount": 1000,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}]
},
"refinancing_credit_operation": {
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"due_date": "2021-08-08",
"due_principal": 997.87,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"due_date": "2021-09-08",
"due_principal": 690.89,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 0,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 1000,
"issue_amount": 1000,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}]
}
}
5.2. 转移模拟： 也可以模拟无再融资的转移提案（纯转移）的财务条件，无需采集客户注册数据。
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload：
payload.json
{
"borrower": {
"person_type": "natural"
},
"collaterals": [{
"collateral_type": "social_security"
}],
"portability_credit_operation": {
"financial": {
"monthly_interest_rate": 0.0132,
"installment_face_value": 100,
"number_of_installments": 10
}
},
"origin_contract": {
"last_due_balance": 997.87
}
}
Response
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal_simulation
Payload：
payload.json
{
"portability_credit_operation": {
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"due_date": "2021-08-08",
"due_principal": 997.87,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"bank_slip_key": null,
"digitable_line": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"due_date": "2021-09-08",
"due_principal": 690.89,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 0,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 1000,
"issue_amount": 1000,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}]
}
}
6 - 提案正式化：
注意
对于涉及再融资后找零的提案，需要预先计算找零金额，根据合同条件，该金额至少应为所有再融资分期金额之和减去所有转移分期金额之和的 5%。否则，请求将收到以下错误：
STATUS
400Response Body
{
"title": "Bad Request",
"code": "CT000118",
"description": "The final disbursement amount is less than 5% of the sum of refinancing installment minus the sum of portability installment. The minimum final disbursement amount allowed is 500.00. Calculated final disbursement amount: 400.00.",
"translation": "O valor do troco é menor que 5% da soma do valor das parcelas do refinanciamento menos o valor soma das parcelas da portabilidade. O valor mínimo do troco permitido é de 500.00. Valor calculado do troco: 400.00."
}
要正式化转移和/或再融资（找零）操作，必须发送提案录入时生成的合同签署证明。
签署 payload 中必须包含第 4 条中发送的文件相关必填字段。必填字段如下：ip_address 和 signature_datetime。
6.1. 合作方需发起以下调用以签署转移操作：
Request
- MÉTODOPOST
- STATUS/v2/credit_transfer/proposal/PROPOSAL-KEY/portability_credit_operation/signature
Payload：
payload.json
{
"type": "pdf-signature",
"biometry_analysis_reference": "SERPRO",
"signature_datetime": "2023-12-22T15:01:32.482Z",
"signed_pdf_path": "https://termos-originacao.s3.amazonaws.com/5cd2a7f9",
"ip_address": "179.145.48.219",
"similarity_score": "0.9750000000000001"
}
Enumeradores Biometry Analysis Reference
| Enumerador | Descrição |
|---|---|
| serpro | 当 similarity_score 通过查询 SERPRO 数据库返回时使用 。 |
| tse | 当 similarity_score 通过查询 TSE 数据库返回时使用。 |
| not_found | 当面部生物识别在任何数据库（SERPRO 或 TSE）中均未找到时使用。 |
签署完成将以异步方式通知：
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.credit_operation",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "portability",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"document_key": "\<GUID DO DOCUMENTO NA QI\>",
"signed_document_url": "\<LINK DO URL DO PDF ASSINADO\>",
"credit_operation_status": "signed"
}
}
6.2. 合作方需发起以下调用以签署再融资操作（找零）：
Request
- MÉTODOPOST
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation/signature
Payload：
payload.json
{
"type": "pdf-signature",
"signed_pdf_path": "https://termos-originacao.s3.amazonaws.com/5cd2a7f9",
"ip_address": "192.168.0.0",
"signature_datetime": "2020-03-20T14:28:23.382748Z",
"similarity_score": "0.98",
"biometry_analysis_reference": "serpro"
}
签署完成将以异步方式通知：
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.credit_operation",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "refinancing",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"document_key": "\<GUID DO DOCUMENTO NA QI\>",
"signed_document_url": "\<LINK DO URL DO PDF ASSINADO\>",
"credit_operation_status": "signed"
}
}
7 - 转移提案状态机：
转移提案的状态反映了 CIP 信贷转移中心（CTC）内信贷转移流程所涉及的各个阶段。 以下是转移提案中每个状态的流程说明：
7.1. pending_response: 录入后的提案状态。在此状态下，提案已被 QI 成功接收并发送至 CTC - CIP。
6.1.1 rejected: 如果提案录入被 CTC - CIP 拒绝，将发送包含拒绝原因的 webhook：
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSrejected
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "rejected",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"error": {
"code": "ECTC0023",
"reason": "Contrato com portabilidade em andamento"
}
}
}
7.1.1 rejected reasons: 如果提案录入被 CTC - CIP 拒绝，将发送包含拒绝原因的 webhook：
| reason | description | external_code |
|---|---|---|
| portability_in_progress | 转移进行中的合同 | ECTC0023 |
| portability_finished | 所指定合同的转移已完成 | ECTC0028 |
| portability_in_expiration_progress | 不允许转移。合同转移因未完成转移而处于"到期流程"状态 | ECTC0085 |
| unexpected_error | Erro inesperado | ECTC9999 |
| portability_payment_rejected | Pagamento de portabilidade rejeitado. | |
| divergent_due_balance | Saldo devedor final deve ser menor que saldo devedor devolvido pela cip. |
7.2. pending_acceptance： CTC - CIP 发送/接受后的提案状态。提案此时正在等待原始债权银行的未偿余额响应。此时将发送包含 CTC - CIP 转移编号的 webhook：
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSpending_acceptance
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "pending_acceptance",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"portability_number": "202211230000246536429",
"inclusion_date": "2022-11-24",
"due_balance_expected_return_date": "2022-12-01"
}
}
信息
"portability_number" 是 CTC - CIP 内的转移编号，是提案机构和原始债权机构用于识别转移操作的编号。
一旦原始债权银行响应转移申请，将发送以下 webhook 并通知未偿余额。
7.2.1. accepted： 当原始债权银行返回未偿余额且不保留信贷时的提案状态。将发送包含未偿余额信息的 webhook。 原始债权银行在收到转移提案后，有最多 5 个工作日向承接银行（QI Tech）发送响应。
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSaccepted
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "accepted",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"final_due_balance": 1000,
"portability_number": "202211230000246536429",
"original_contract": {
"origin_contract_number": "5584745",
"origin_ispb_number": "60746948",
"origin_document_number": "90406718261",
"origin_operation_type": "0202",
"installment_face_value": 1000,
"total_iof": 1,
"first_due_date": "2021-05-31",
"last_due_date": "2022-05-31",
"interest": 1,
"cet": 1,
"installment_number": 12,
"amortization": 1,
"final_due_balance": 1000,
"final_due_date": "2021-08-31",
"contract_date": "2021-04-31"
}
}
}
收到原始债权机构返回的未偿余额信息后，合作方必须在 5 个工作日内明确表示是否接受该余额。如果合作方选择接受，则进行如下调用：
信息
原始债权机构发送未偿余额的截止时间为 10:00。
收到未偿余额后，如果合作方决定继续推进提案，必须在 5 个工作日内接受该余额。接受时，合作方必须在 payload 中提供财务条件和放款账户。
Request
- MÉTODOPATCH
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY
Payload：
payload.json
{
"status":"accepted_by_requester"
}
Atenção
对于涉及再融资后找零的提案，根据合同的新条件，找零金额至少应为所有再融资分期金额之和减去所有转移分期金额之和的 5%。
STATUS
400Response Body
{
"title": "Bad Request",
"code": "CT000118",
"description": "The final disbursement amount is less than 5% of the sum of refinancing installment minus the sum of portability installment. The minimum final disbursement amount allowed is 500.00. Calculated final disbursement amount: 400.00.",
"translation": "O valor do troco é menor que 5% da soma do valor das parcelas do refinanciamento menos o valor soma das parcelas da portabilidade. O valor mínimo do troco permitido é de 500.00. Valor calculado do troco: 400.00."
}
合作方可以在此调用中添加新的分期金额或新利率数据（如需更改）：
Request
- MÉTODOPATCH
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY
Payload：
payload.json
{
"status":"accepted_by_requester",
"financial": {
"installment_face_value": 100
}
}
Request
- MÉTODOPATCH
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY
Payload：
payload.json
{
"status":"accepted_by_requester",
"financial": {
"monthly_interest_rate": 0.01
}
}
附加可选字段
除 status 和 financial 字段外，提案接受端点还接受以下可选字段：
borrower.document_identification_type(string 或 null)：身份证件类型borrower.document_identification_number(string，最多 16 个字符)：身份证件号码borrower.gender(string 或 null)：借款人性别。可接受值："male"、"female"或nullcredit_agent(对象)：信贷代理人，含name（string，最多 100 个字符）和document_number（string，11 或 14 位数字）
Atenção!
如果分期金额超过总可用金额（原始合同分期金额 + 福利总可用边际）， 将返回以下错误：
{
"title": "Reservation amount greater than available total balance",
"description": "The installment face value: 54.4 is greater than the available total balance (origin installment face value + available total balance):30.4. Available total balance: -20.0.",
"translation": "O valor da parcela: 54.4 é maior que o valor total disponível (valor da parcela do contrato de origem + margem total disponível) : 30.4. Margem total diponível: -20.0.",
"code": "SSC000059"
}
收到此错误后，可以重新调用接口，修改分期金额以适配总可用金额。
如果在未偿余额接受截止时间前未调整分期金额，则需要重新录入提案。
如果合作方决定不继续推进转移提案，则必须发起以下调用以告知放弃转移：
Request
- MÉTODODELETE
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY
向 CTC - CIP 发送转移提案取消后，将发送提案取消 webhook：
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUScanceled
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_status": "canceled",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12"
}
信息
未偿余额接受截止时间为 16:30。 无法恢复状态为 "canceled" 的提案。如果提案处于此状态，需要重新录入。
7.2.2. retained： 当原始债权银行保留信贷时的提案状态，将发送包含保留信息的 webhook。原始债权银行在收到转移提案后，有最多 2 个工作日发送信贷保留响应。
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSretained
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "retained",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"retained_reason": {
"reason": "issuer_retention",
"description": "Retenção do Cliente"
}
}
}
提案 webhook 字段详情
| 字段 | 描述 | 值 |
|---|---|---|
| reason | 提案保留原因列表 | 枚举值 |
7.3. accepted_by_requester： 经合作方批准后，提案进入 QI 内部结算流程。
7.4. settlement_sent： 完成 QI 内部转移提案结算流程后，用于支付未偿余额的资金将发送至原始债权方，并向合作方触发以下 webhook：
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSsettlement_sent
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL KEY\>",
"proposal_status": "settlement_sent",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"receipt": {
"amount": 1000,
"timestamp": "2022-09-14 11:55:31",
"description": "237 0001 1000093 1000093-3 59588111000103 - BCO BRADESCO S.A.",
"ted_receipt_document_key": "a34e84a2-1628-4f23-8c11-2b2f4656ced1",
"ted_receipt_url": "https://qitech.com.br/",
"transaction_key": "ed3e84a2-1628-4f23-8c11-2b2f4656cedf",
"origin": {
"account_key": "ed3e84a2-1628-4f23-8c11-2b2f4656cedf",
"bank_code": "329",
"branch": "0001",
"branch_digit": null,
"account_number": "1000361",
"account_digit": "3",
"type": "checking_account",
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"document": "32402502000135"
},
"destination": {
"bank_code": "237",
"branch": "0001",
"branch_digit": null,
"account_number": "1000093",
"account_digit": "3",
"type": "checking_account",
"name": "BCO BRADESCO S.A.",
"document": "59588111000103",
"purpose": "Saída Liquidação de Portabilidade"
}
}
}
}
此时将在 Dataprev 中启动转移操作的背书流程。背书流程将与以下步骤并行进行（第 7.5.、7.5.1. 和 7.5.2. 条）。
7.5. pending_settlement_confirmation： 在 QI 收到 CTC - CIP 的资金转移确认信息后，将触发此 webhook，提案将转为此状态。
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSpending_settlement_confirmation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "pending_settlement_confirmation",
"event_datetime": "2022-11-24T15:42:12"
}
信息
原始债权机构将合同结清确认发送至 CTC - CIP，随后由 CTC - CIP 转发至 QI Tech。
O SLA 转移结清确认的 SLA 为 2 个工作日，从发送合同未偿余额支付资金起算。
7.5.1. paid： 一旦 QI 收到 CTC - CIP 的合同结清确认，提案将转为 "paid" 状态，并向合作方发送 webhook。
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSpaid
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "paid",
"event_datetime": "2022-11-24T15:42:12"
}
在此阶段，如果转移操作的背书已完成，合同将以 "paid" 状态结束；否则，合同将先转为 "pending_collateral_averbation" 状态，等待背书完成后再变为 "paid"。
7.5.1.1. 转移操作背书通知将通过以下 webhook 发送：
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.collateral
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.collateral",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "portability",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"collateral_type": "social_security",
"collateral_constituted": true,
"collateral_data": {
"reservation_method": "portability",
}
}
}
data.collateral_data.reservation_method: [portability, new_credit ]
7.5.2. rejected: 如果原始债权银行拒绝接受合同结清，发送用于结清合同未偿余额的资金将被退还给 QI Tech，提案将转为 "rejected" 状态。
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSrejected
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "\<PROPOSAL-KEY\>",
"proposal_status": "rejected",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"error": {
"code": "QCTC0001",
"reason": "Pagamento de portabilidade rejeitado."
}
}
}
如果在此阶段转移操作已在 Dataprev 中背书，再融资操作（找零）将可以启动（第 8 条中描述的流程）。
信息
无法恢复状态为 "rejected" 的提案。始终需要重新录入。
8 - 再融资操作（找零）状态机：
8.1 当转移操作付款完成时，合作方可以选择是否继续推进再融资操作（找零）。
Enumeradores credit_operation_status
| Enumerador | Descrição |
|---|---|
| waiting_signature | Operação aguardando assinatura |
| signed | Operação assinada |
| issued | Operação emitida |
| disbursed | Operação desembolsada |
| settled | Operação liquidada |
| canceled | Operação cancelada |
| canceled_permanently | Operação cancelada permanentemente |
8.1.1. 要继续推进再融资（找零），合作方需发起以下调用并传递 'Financial' 和 'Disbursement Bank Accounts' 字段：
*此外，可以传递 'purchaser_document_number' 字段以更改操作的受让方。
Request
- MÉTODOPOST
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation/acceptance
Request Body
{
"financial": {
"installment_face_value": 379.87,
"monthly_interest_rate": 0.0166,
"number_of_installments": 84,
"limit_days_to_disburse": 7,
"disbursement_date": "2024-07-02",
"rebates": [
{
"rebate_bank_account": {
"bank_code": "329",
"account_digit": "9",
"document_number": "18533555000164",
"name": "Teste Ltda",
"account_number": "4290002",
"branch_number": "0001"
},
"amount_type": "percentage",
"fee_type": "spread",
"amount": 9.5
},
{
"amount": 20,
"rebate_bank_account": {
"name": "Teste Ltda",
"document_number": "18533555000164",
"account_digit": "0",
"account_number": "4290001",
"branch_number": "0001",
"bank_code": "329"
},
"amount_type": "percentage",
"fee_type": "insurance_premium"
}
]
},
"disbursement_bank_accounts": [
{
"document_number": "92093764000197",
"branch_number": "0001",
"name": "TESTE LTDA",
"percentage_receivable": 100,
"account_number": "120012",
"account_digit": "3",
"bank_code": "329"
}
],
"purchaser_document_number": "28534595027164"
}
Response:
Response
{
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"contract_number": "00000002",
"document_key": "\<DOCUMENT-KEY da CCB de Refinanciamento\>",
"document_url": "\<URL da CCB de Refinanciamento\>",
"credit_operation_status": "issued",
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_options": [{
"installments": [{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-08-09",
"calendar_days": 53,
"digitable_line": null,
"due_date": "2021-08-08",
"due_interest": 0,
"due_principal": 997.87,
"fine_amount": null,
"has_interest": true,
"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
"installment_number": 1,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 54.84865004983954,
"principal_amortization_amount": 306.98134995016045,
"total_amount": 361.83,
"workdays": 37
},
{
"additional_costs": [],
"bank_slip_key": null,
"business_due_date": "2021-09-08",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2021-09-08",
"due_interest": 0,
"due_principal": 690.8886500498395,
"fine_amount": null,
"has_interest": true,
"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
"installment_number": 2,
"installment_status": "created",
"installment_type": "principal",
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 21.964874249804833,
"principal_amortization_amount": 339.86512575019515,
"tax_amount": 0,
"total_amount": 361.83,
"workdays": 22
}
],
"prefixed_interest_rate": {
"annual_rate": 0.44556431,
"daily_rate": 0.00564312,
"monthly_rate": 0.0556431,
"interest_base": "calendar_days_365"
},
"iof_amount": 50,
"external_contract_fee_amount": 0,
"external_contract_fees": [],
"contract_fee_amount": 0,
"contract_fees": [],
"number_of_installments": 2,
"disbursed_issue_amount": 997.87,
"final_disbursement_amount": 100,
"issue_amount": 1147.87,
"disbursement_date": "2021-05-31",
"cet": 1.212,
"annual_cet": 32.122
}],
"disbursement_bank_account": {
"account_digit": "1",
"account_number": "00001",
"ispb": "00000000",
"branch_number": "0001"
}
}
8.1.2. 如果合作方选择不继续推进再融资操作（找零），需发起以下调用以拒绝再融资提案：
Request
- MÉTODODELETE
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation
8.2. 再融资背书（找零）： 一旦合作方选择继续推进再融资操作，可分配边际背书流程将启动。一旦 INSS 可分配边际背书完成，合作方将收到以下 webhook：
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.collateral
Body
{
"webhook_type": "credit_transfer.proposal.collateral",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "refinancing",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"collateral_type": "social_security",
"collateral_constituted": true
}
}
8.3. 再融资放款（找零）：
一旦 INSS 可分配边际完成背书，再融资操作将自动放款。
8.3.1. 如果找零放款成功，将向合作方发送以下 webhook：
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.credit_operation",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_status": "disbursed",
"credit_operation_type": "refinancing",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"ted_receipt_list": [{
"fee": 0,
"url": "https://qitech.com.br/",
"amount": 500,
"origin": {
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"type": "payment_account",
"branch": "0001",
"document": "32402502000135",
"bank_code": "329",
"account_key": "871059bd-4014-41ad-82b4-28275ff0e67b",
"branch_digit": null,
"account_digit": "5",
"account_branch": "0001",
"account_number": "00002"
},
"timestamp": "2022-09-28T13:00:47",
"description": "DESCRIPTION",
"destination": {
"name": "Elaine Isadora da Cruz",
"type": "checking_account",
"bank_code": "033",
"branch": "0001",
"purpose": "Crédito PIX em Conta",
"document_number": "90406718261",
"bank_ispb": "90400888",
"branch_digit": null,
"account_digit": "1",
"account_number": "00001"
},
"end_to_end_id": null,
"transaction_key": "871059bd-4014-41ad-82b4-28275ff0e67b",
"origin_transaction_key": null
}]
}
}
8.3.2. 如果放款失败，合作方将收到以下 webhook：
7.3.2.1. 放款账户失败 webhook
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.credit_operation",
"proposal_key": "60fbbfe2-eb52-4825-9ed5-f169a58b9999",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_status": "canceled",
"credit_operation_type": "refinancing",
"credit_operation_key": "1a1a44df-29b6-431c-89af-53657d906333",
"pix_refusal": {
"reason_enumerator": "invalid_document_number",
"reason": "CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino."
},
"cancel_reason": "pix_refusal"
}
}
7.3.2.2. 再融资操作放款失败 webhook
Webhook
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
Body:
body.json
{
"webhook": {
"data": {
"cancel_reason": "Agência ou Conta Destinatária do Crédito Inválida",
"credit_operation_key": "1a1a44df-29b6-431c-89af-53657d906333",
"credit_operation_type": "refinancing",
"credit_operation_status": "canceled",
"cancel_reason_enumerator": "agencia_conta_invalida"
},
"proposal_key": "60fbbfe2-eb52-4825-9ed5-f169a58b9999",
"webhook_type": "credit_transfer.proposal.credit_operation",
"event_datetime": "2023-12-22T10:15:25"
}
}
8.3.3. 操作放款失败时，可以更改银行数据后重新尝试放款：
Request
- MÉTODOPATCH
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation
Payload：
payload.json
{
"disbursement_date": "2022-11-04",
"disbursement_bank_account": {
"account_branch": "1232",
"account_digit": "4",
"account_number": "412412412",
"account_type": "checking_account",
"document_number": "14950479032",
"ispb": "17298092",
"name": "Maria da Silva"
}
}
9 - 查询 CTC - CIP 参与者列表：
Request
- MÉTODOGET
- ENDPOINT/v2/credit_transfer/participants
Response:
response.json
[
{
"name": "\<NOME DO BANCO\>",
"bank_code": "\<CÓDIGO DO BANCO\>",
"ispb": "\<BASE DO CNPJ DO BANCO\>"
}
]
10 - 获取最后一次请求的响应
last response 是一种简单直观的方式，用于映射 QI 与 Dataprev 之间通信的响应，可以了解该请求的发送时间及获得的返回结果（通过已列举的枚举值）。
每个枚举值都有详细描述和 Dataprev 参考代码。以下是此端点枚举值的详细信息。
成功情况
Request - Credit Transfer
ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY/CREDIT-OPERATION-TYPE/collateralMÉTODO
GETPATH PARAMETERS credit-operation-type
| Enumerador | Descrição |
|---|---|
| refinancing_credit_operation | 再融资操作 |
| portability_credit_operation | 转移操作 |
Response
Response Body
{
"collateral_data":{
"benefit_number":1976703155,
"state":"PI",
"last_response":{
"success":[
{
"enumerator":"succesfully_included",
"reservation_method":"portability"
}
]
},
"last_response_event_datetime":"2023-05-22T19:13:02Z",
"status":"reserved"
},
"collateral_constituted":true,
"collateral_type":"social_security"
}
请求返回字段详情
| 字段 | 描述 | 值 |
|---|---|---|
| enumerator | Retorno mapeado do código Dataprev | Enumeradores |
| reservation_method | Método de averbação da reserva | portability, new_credit, refinancing |
错误情况
Request
ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY/CREDIT-OPERATION-TYPE/collateralMÉTODO
GETResponse
Response Body
{
"collateral_constituted": false,
"collateral_type": "type",
"updated_at": "2023-05-24 19:13:02",
"collateral_data": {
"state": "SP",
"benefit_number": 1976703155,
"status": "pending_reservation",
"last_response": {
"errors": [
{
"enumerator": "benefit_blocked_by_tbm",
"reservation_method" : "portability"
},
{
"enumerator": "benefit_blocked_by_tbm",
"reservation_method" : "new_credit"
}
]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z"
}
}
失败 webhook 字段详情
| 字段 | 描述 | 值 |
|---|---|---|
| enumerator | Retorno mapeado do código Dataprev | Enumeradores |
| reservation_method | Método de averbação da reserva | portability, new_credit, refinancing |
11 - 最后一次背书尝试的响应 Webhook
如果操作背书失败，将进入重试流程，并发送以下 webhook（详细说明了 Dataprev 返回的错误）。
- Webhook 转移
- Webhook refinanciamento
WEBHOOK_TYPE
credit_transfer.proposal.credit_operation
{
"webhook_type": "credit_transfer.proposal.collateral",
"proposal_key": "\<PROPOSAL-KEY\>",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_type": "portability",
"credit_operation_key": "\<CREDIT-OPERATION-KEY\>",
"collateral_type": "social_security",
"collateral_constituted": false,
"collateral_data": {
"status": "pending_reservation",
"last_response": {
"errors": [{
"enumerator": "consignable_margin_excceded"
}]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z",
"reservation_method": "new_credit",
}
}
}
WEBHOOK_TYPE
credit_operation.collateral
{
"webhook_type": "credit_operation.collateral",
"key": "\<CREDIT-OPERATION-KEY\>",
"event_time": "2022-11-24T15:42:12",
"data": {
"collateral_type": "social_security",
"collateral_constituted": false,
"collateral_data": {
"status": "pending_reservation",
"last_response": {
"errors": [{
"enumerator": "consignable_margin_excceded"
}]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z",
"reservation_method": "refinancing",
}
}
}
失败 webhook 字段详情
| 字段 | 描述 | 值 |
|---|---|---|
| enumerator | Retorno mapeado do código Dataprev | Enumeradores |
| reservation_method | Método de averbação da reserva | portability, new_credit, refinancing |
12 - 查询原始转移数据
可以查询原始银行的转移数据，例如福利编号、开始日期、合同 CET（有效总成本）等信息。
Request
- MÉTODOPOST
- ENDPOINT/social_security/reservation/external_key/CREDIT-OPERATION-KEY/portability_origin_contract
Payload：
payload.json
{
"request_type":"portability_number",
"portability_number": "202402070000298096242"
}
Response
- MÉTODOPOST
- ENDPOINT/social_security/reservation/external_key/CREDIT-OPERATION-KEY/portability_origin_contract
Body:
body.json
{
"origin_contract_request_key": "9bb68c89-4b88-400d-9359-99ad8d42a69e",
"status": "pending_search",
"status_events": [
{
"status": "pending_search"
}
]
}
福利编号查询成功时
Webhook
- WEBHOOK_TYPEsocial_security_portability_origin_contract_request
- STATUSSuccess
Body:
body.json
{
"webhook": {
"key": "25e93655-4713-488b-8800-7ac4fddf745f",
"data": {
"portability_number": 9223372036854776000,
"portability_status": "open",
"benefit_number": 1544326820,
"portability_start_date": "2024-02-22",
"deleted_contracts": [
{
"origin_bank": {
"bank_code": 752,
"name": "CETELEM-BNP"
},
"contract_number": "22-844817807/20",
"last_installment_paid": 84,
"exclusion_date": "22022024",
"period_amount": 165.73
}
]
},
"status": "success",
"webhook_type": "social_security_portability_origin_contract_request",
"event_datetime": "2024-02-26T21:36:22"
}
}
福利编号查询失败时
Webhook
- WEBHOOK_TYPEsocial_security_portability_origin_contract_request
- STATUSFailure
Body:
body.json
{
"webhook": {
"key": "522b5d7d-2dfc-4e92-99b7-d4df3d97edb2",
"data": {
"enumerator": "invalid_bank_code",
"description": "Invalid bank code"
},
"status": "failure",
"webhook_type": "social_security_portability_origin_contract_request",
"event_datetime": "2024-02-26T21:36:22"
}
}
13. 降低分期金额
此端点允许降低信贷转移合同的分期金额。仅当原始合同中还有剩余分期且合同状态为 "disbursed" 时才有效。
Request
- MÉTODOPUT
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY/portability_credit_operation
Payload：
payload.json
{
"installment_face_value": 382.18
}
Response sucesso - HTTP 200
Body:
body.json
{
"credit_operation_key": "7aa77bca-c724-4c1a-bfae-9b1b7bd81ab2",
"contract_number": "0000000007/WO",
"document_key": "045a8f35-6170-4112-8d83-29a753d0c78e",
"document_url": "http://teste.com",
"signed_url": "signed_url_test",
"credit_operation_status": "waiting_signature",
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
},
"disbursement_accounts": [
{
"account_digit": "3",
"account_branch": "0001",
"account_number": "94134",
"ispb": "32402502",
"name": "Wilker Teste",
"document_number": "37197645832"
}
],
"disbursement_options": [
{
"prefixed_interest_rate": {
"annual_rate": 3.0,
"daily_rate": 0.00385824,
"interest_base": "calendar_days",
"monthly_rate": 0.12246205
},
"total_iof": 7.03,
"external_contract_fee_amount": 0.0,
"external_contract_fees": [],
"contract_fee_amount": 0.0,
"number_of_installments": 3,
"contract_fees": [],
"disbursed_issue_amount": 1000.0,
"issue_amount": 1007.03,
"disbursement_date": "2022-08-24",
"cet": 12.6,
"annual_cet": 315.3944,
"installments": [
{
"business_due_date": "2022-08-30",
"calendar_days": 5,
"due_date": "2022-08-29",
"due_principal": 1007.03,
"installment_number": 1,
"pre_fixed_amount": 84.43554587915118,
"principal_amortization_amount": 297.73445412084885,
"total_amount": 382.17,
"workdays": 3
},
{
"business_due_date": "2022-09-30",
"calendar_days": 31,
"due_date": "2022-09-29",
"due_principal": 709.2955458791512,
"installment_number": 2,
"pre_fixed_amount": 47.97894031795043,
"principal_amortization_amount": 334.19105968204957,
"total_amount": 382.17,
"workdays": 22
},
{
"business_due_date": "2022-11-01",
"calendar_days": 32,
"due_date": "2022-10-31",
"due_principal": 375.1044861971016,
"installment_number": 3,
"pre_fixed_amount": 7.055513802898396,
"principal_amortization_amount": 375.1044861971016,
"total_amount": 382.16,
"workdays": 21
}
],
"final_disbursement_amount": 997.87
}
],
"final_disbursement_amount": 997.87,
"collateral_is_constituted": false
}
14. 枚举值映射
Enumeradores Retention Reason
| Enumerador | Descrição |
|---|---|
| issuer_retention | 客户保留 |
| different_from_original | 提案条件与原始合同不符 |
| issuer_lawsuit | 客户存在诉讼 |
| insurance_in_progress | 保险理赔进行中 |
| collateral_in_execution | 担保执行中 |
| contract_not_found | 合同未找到 |
| invalid_contract_type | 合同类型无效 |
| portability_in_progress | 转移进行中 |
| assigned_contract | 已转让合同 |
| issuer_document_number_invalid | CPF 不属于该合同 |
| unrelated_issuer_document_number | 提供的 CPF 不是持有人的 |
| different_from_original | Condições da proposta divergentes do contrato original |
| issuer_lawsuit | Cliente com ação judicial |
| assigned_without_co_obligation | 无共同义务的转让合同 |
| insurance_in_progress | Indenização de seguro em andamento |
| collateral_in_execution | Garantia em Execução |
| fgts_in_use | FGTS AMORTIZAR 使用中 |
| fgts_funding | FGTS funding |
| portability_not_requested | 客户未申请转移 |
| wrong_original_financial_institution | 原始债权机构错误 |
Dataprev 背书错误返回表
| Dataprev 代码 | 枚举值 | 描述 | QI 操作 |
|---|---|---|---|
| HW | consignable_margin_excceded | Exceeded consignable margin | Teimosinha |
| IT | benefit_blocked_by_tbm | Benefit blocked due to benefit transfer | Teimosinha |
| IE | benefit_blocked_by_beneficiary | Benefit blocked by beneficiary | Teimosinha |
| AN | invalid_disbursement_account | Invalid disbursement bank account | Teimosinha |
| HX | reservation_already_included | Reservation already included | 确认背书 |
| IF | benefit_blocked_by_granting_process | Benefit blocked during granting process | Teimosinha |
| AV | processing_payroll | Operation couldn`t be done during processing payroll period | Teimosinha |
| OF | invalid_cbc | Invalid cbc | Teimosinha |
| IA | first_name_mismatch | First name mismatch benefit owner or legal representative | Teimosinha |
| OS | legal_representative_document_number_mismatch | Document number mismatch legal representative | Teimosinha |
| AY | invalid_state | Invalid state | Teimosinha |
| HZ | operation_not_allowed_on_this_reservation_status | Operation couldn`t be done with current reservation status | Teimosinha |
| AP | invalid_contract_date | Accrual, end or start contract date is invalid | Teimosinha |
| GA | required_fields_missing | Required fields are missing | Teimosinha |
| BC | cbc_missing | CBC is missing | Teimosinha |
| NC | contract_number_missing | Contract number is missing | Teimosinha |
| NB | benefit_number_missing | Benefit number is missing | Teimosinha |
| CA | invalid_bank_code | Invalid bank code | Teimosinha |
| HR | exceeded_number_of_allowed_contracts | Amount of contracts is above the limit | Teimosinha |
| PV | invalid_image_format | Image with wrong format | Teimosinha |
| IR | operation_not_allowed_IR | Operation date is greater than benefit expiration | Teimosinha |
| PK | wrong_bank_code_destination | Portability number was found with wrong bank code destination | Teimosinha |
| PH | wrong_benefit_number_on_portability | Portability number was found with wrong benefit number | Teimosinha |
| PI | invalid_contract_total_amount | Reservation contract total amount should be greater than Dataprev reference amount | Teimosinha |
注意！
合同的所有利率和金额在创建预留时进行验证。
当合同长时间未背书时会出现 "invalid_contract_total_amount" 错误，这将影响先前确定的金额。
背书成功返回表
| Dataprev 代码 | 枚举值 | 描述 |
|---|---|---|
| BD | successfully_included | Inclusion has been successfully done |
| BF | successfully_removed | Removal has been successfully done |
| BR | successfully_reactivated | Reactivation has been successfully done |
| BS | successfully_suspended | Suspension has been successfully done |
余额查询错误返回表
| 代码 | 枚举值 | 描述 |
|---|---|---|
| CR | not_found_legal_representative | no legal representative for the beneficiary |
| CD | inexistent_beneficiary | no beneficiary found |
| AS | benefity_without_legal_representative | beneficiary does not have a legal representative |
| BI | inexistent_benefit | no benefit found |
| D1 | inconsistent_balance_benefit_data | The balance benefit data registered is either inconsistent, null or incomplete. |
福利查询错误返回表
| 代码 | 枚举值 | 描述 |
|---|---|---|
| CR | not_found_legal_representative | no legal representative for the beneficiary |
| CD | inexistent_beneficiary | no beneficiary found |
| AS | benefity_without_legal_representative | beneficiary does not have a legal representative |
福利状况表
| Items |
|---|
| active |
| excluded |
| terminated |
| suspended |
| suspended_by_CONPAG |
| terminated_by_SISOBI |
| receiving_monthly_recover_6_months |
| receiving_monthly_recover_18_months |
| suspended_by_name_error |
| suspended_by_credentialed_payer |
| suspended_by_inspection |
| suspended_by_audit |
| terminated_by_inspection |
| terminated_by_audit |
| receiving_monthly_recover_6_months_inspection |
| receiving_monthly_recover_18_months_inspection |
| suspended_by_SISOBI |
| canceled_by_audit |
福利状态表
| 枚举值 | 描述 |
|---|---|
| Elegible | 符合贷款资格 |
| Inelegible | 福利不符合贷款资格 |
| Blocked | 福利符合资格，但贷款被封锁 |
封锁类型表
| 枚举值 | 描述 |
|---|---|
| 0 | 无封锁 |
| 1 | 被被保险人封锁 |
| 2 | 因 TBM 被封锁 |
| 3 | 在授权时被封锁 |
政治敏感人士类型表
| 枚举值 | 描述 |
|---|---|
| 0 | 非政治敏感人士 |
| 1 | 政治敏感人士 - 第 1 级 |
福利类型表
| 代码 | 福利 |
|---|---|
| 1 | pension_by_death_rural_worker |
| 2 | pension_by_death_accident_rural_worker |
| 3 | pension_by_death_rural_employer |
| 4 | retirement_invalidity_rural_emploee |
| 5 | retirement_invalidity_accident_rural_worker |
| 6 | retirement_invalidity_rural_employer |
| 7 | retirement_by_eldness_rural_worker |
| 8 | retirement_by_age_rural_employer |
| 9 | complement_by_work_accident_rural_worker |
| 11 | support_invalidity_rural_worker |
| 12 | support_by_age_rural_worker |
| 13 | aid_sickness_rural_worker |
| 15 | aid_time_off_rural_worker |
| 16 | aid_federal |
| 17 | international_agreement |
| 18 | inclusion_benefit |
| 19 | pension_student_law7004 |
| 20 | pension_by_death_diplomat |
| 21 | pension_by_death |
| 22 | pension_by_death_statute |
| 23 | pension_by_death_veteran |
| 24 | pension_special_institutional_act |
| 25 | aid_time_off |
| 26 | pension_by_death_special_law593 |
| 27 | pension_by_death_federal_emploee |
| 28 | pension_by_death_general_regime_law20465 |
| 29 | pension_by_death_marine_veteran |
| 30 | monthly_income_lifetime_invalidity |
| 31 | aid_sickness |
| 32 | retirement_invalidity_social_security |
| 33 | retirement_invalidity_aeronautic |
| 34 | retirement_invalidity_marine_law1756 |
| 35 | aid_sickness_veteran |
| 36 | aid_social_security_accident |
| 37 | retirement_capin_extra_emploee |
| 38 | retirement_federal_extra_emploee |
| 39 | aid_invalidity_student_law7004 |
| 40 | monthly_income_lifetime_by_age_upper70_law6179 |
| 41 | retirement_by_age |
| 42 | retirement_by_contribution_time |
| 43 | retirement_by_time_of_service_veteran |
| 44 | retirement_special_aeronautic |
| 45 | retirement_by_time_of_service_journalist |
| 46 | retirement_special |
| 47 | allowance_25 |
| 48 | allowance_20 |
| 49 | retirement_ordinary |
| 50 | aid_sickness_extinct_basic_plan |
| 51 | retirement_invalidity_extinct_basic_plan |
| 52 | retirement_by_age_extinct_basic_plan |
| 53 | aid_time_off_extinct_basic_plan |
| 54 | pension_indemnity_federal |
| 55 | pension_by_death_extinct_basic_plan |
| 56 | pension_lifetime_syndrome_thalidomide |
| 57 | retirement_by_teacher_labor_time |
| 58 | retirement_anisty |
| 59 | pension_by_death_amnesty |
| 60 | indemnity |
| 61 | aid_birth |
| 62 | aid_funeral |
| 63 | aid_funeral_rural_worker |
| 64 | aid_funeral_rural_employer |
| 65 | savings_special_autarchy |
| 67 | savings_mandatory_ipase_law5128 |
| 68 | savings_special_retirement_ps_affiliated_upper60 |
| 69 | savings_student_law7004 |
| 70 | restitution |
| 71 | monthly_income |
| 72 | retirement_by_time_of_service_law1756 |
| 73 | monthly_income_family_statute |
| 74 | complement_pension_federal |
| 75 | complement_retirement_federal |
| 76 | monthly_income_statute |
| 77 | monthly_income_sinpas_family_statute |
| 78 | retirement_by_age_law1756 |
| 79 | advantage |
| 80 | monthly_income_maternity |
| 81 | compulsory_retirement |
| 82 | retirement_by_time_of_service_sasse |
| 83 | retirement_invalidity_ex_sasse |
| 84 | pension_by_death_sasse |
| 85 | pension_lifetime_rubber_tapper_law7986 |
| 86 | pension_lifetime_rubber_tapper_dependent_law7986 |
| 87 | continuous_aid_physical_disabilities |
| 88 | continuous_aid_eldness |
| 89 | pension_special_hemodialysis_victim_caruaru |
| 90 | medic_assistency_work_accident |
| 91 | aid_sickness_by_work_accident |
| 92 | retirement_invalidity_work_accident |
| 93 | pension_by_death_work_accident |
| 94 | aid_work_accident |
| 95 | aid_additional_work_accident |
| 96 | pension_special_leprosy_law11520 |
| 97 | savings_by_death_work_accident |
| 98 | aid_longshoreman |
| 99 | time_off_15 |
15. 场景模拟
转移
15.1. 未偿余额申请
转移操作签名后，如果客户配置为手动发送，提案将创建为状态 "pending_submission"，只有在调用以下路由后，才会发起未偿余额申请。 如果配置为自动发送，提案将创建为状态 "pending_response"，即已在等待余额响应，无需调用此路由。
Request
- ENDPOINT/v2/credit_transfer/proposal/PROPOSAL-KEY
- MÉTODOPATCH
Payload：
payload.json
{
"status": "pending_response"
}
15.2. CTC 批准
提案必须处于 "pending_response" 状态。
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "proposal_creation_accepted"
}
15.3. CTC 拒绝
提案必须处于 "pending_response" 状态。
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "proposal_creation_refused"
}
15.4. 原始银行发送未偿余额
必须先发送 CTC 批准调用（15.2）。提案必须处于 "pending_acceptance" 状态。 调用此路由后，将收到 webhook 通知当前债务未偿余额；如要继续操作，需调用第（7.2.1）条中的路由
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "proposal_approval",
"due_balance": 9000, // Opcional, se não informado será enviado o valor usado na criação da proposta
"installment_face_value": 300, // Opcional, se não informado será enviado o valor usado na criação da proposta
"installment_number": 40, // Opcional, se não informado será enviado o valor usado na criação da proposta
"opened_installment_number": 35, // Opcional, se não informado será enviado igual ao installment_number
"overdue_installment_number": 5 // Opcional, se não informado será enviado 0
}
15.5. 原始银行保留
必须先发送 CTC 批准调用（15.2）。提案必须处于 "pending_acceptance" 状态
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "proposal_retention"
}
15.6. 原始银行退款
只能在提案被接受且转移操作已放款后发送。提案必须处于 "settlement_sent"、"pending_settlement_confirmation" 或 "paid" 状态。
Request
- ENDPOINT/mock/credit_transfer/str
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "payment_rejected"
}
15.7. CTC 付款确认
提案必须已被接受且转移操作已放款。状态必须为 "settlement_sent"。
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "settlement_confirmation"
}
15.8. 原始银行付款确认
必须在 CTC 付款确认（15.7）之后调用。提案必须处于 "pending_settlement_confirmation" 状态。
Request
- ENDPOINT/mock/credit_transfer/ctc
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "payment_confirmation"
}
15.9. 担保背书
提案必须处于 "pending_settlement_confirmation" 或 "paid" 状态，且在 15.7 或 15.8 之后。
Request
- ENDPOINT/mock/credit_transfer/collateral
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"credit_operation_type": "portability",
"collateral_constituted": true
}
再融资
15.10. 担保背书
提案必须处于 "paid" 或 "pending_settlement_confirmation" 状态，且转移担保已被激活， 再融资必须已被接受。
Request
- ENDPOINT/mock/credit_transfer/collateral
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"credit_operation_type": "refinancing",
"collateral_constituted": true
}
15.11. 担保背书失败
提案必须处于 "paid" 或 "pending_settlement_confirmation" 状态，且转移担保已被激活， 再融资必须已被接受。
Request
- ENDPOINT/mock/credit_transfer/collateral
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"credit_operation_type": "refinancing",
"collateral_constituted": false
}
15.12. 放款失败
再融资操作必须已放款。
Request
- ENDPOINT/mock/credit_transfer/disbursement
- MÉTODOPOST
Payload：
payload.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"event_type": "disbursement_failed"
}
16. 在 QI 向合作方抵扣的转移操作中添加费用
要添加费用，操作必须已背书、已放款且未被转让。
ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY/portability_credit_operation/rebateMÉTODO
POSTRequest
payload.json
{
"amount": 20,
"rebate_bank_account": {
"name": "Teste Ltda",
"document_number": "18533555000164",
"account_digit": "0",
"account_number": "4290001",
"branch_number": "0001",
"bank_code": "329"
},
"amount_type": "percentage",
"fee_type": "spread"
}
Response
response.json
{}
17. 转移付款收据（STR00047）
转移 付款完成后，可以生成交易收据。
ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY/receipt_str0047MÉTODO
POSTRequest
payload.json
{}
Response
response.json
{
"proposal_key": "CHAVE DA PROPOSTA",
"receipt_url": "URL DO RECIBO",
"receipt_document_key": "CHAVE DO RECIBO"
}