跳到主要内容

私人薪资抵押贷款手册 - 拍卖提案接收过滤器配置

简介​

通过拍卖发行操作的流程始于借款人在数字 CTPS 应用中申请贷款，QI Tech 定期查询所有申请，并针对每个请求开启内部提案拍卖，通过 webhook 通知合作伙伴。 本手册包含配置申请过滤器所需的端点，可控制操作目标群体。

修改过滤规则​

ENDPOINT
- /private_payroll_auction/requester_configuration/custom_data
MÉTODO
- PATCH

此请求中有两种可修改的字段类型：客户状态和客户过滤器。关于客户状态，可在活跃与非活跃之间切换，表示客户是否希望接收新的拍卖申请。

{
    "status": "active"
}

custom_data 字段包含实际的过滤器。其中必须发送所有过滤字段，如下例所示：

{
    "custom_data": {
        "disbursed_issue_amount": {"min": null, "max": null},
        "number_of_installments": {"min": 12, "max": 24},
        "consigned_credit_balance": {"min": null, "max": null},
        "days_since_employment": {"min": null},
        "age": {"min": null, "max": 60},
        "received_daily_proposals": {"max": null},
        "alert_preferences": {
          "default": "acknowledge",
          "leave":"acknowledge",
          "termination":"ignore"
        }
    }
}
注意

除 received_daily_proposals、days_since_employment 和 alert_preferences 外，每个字段必须包含 min 和 max 键。 注意：所有 custom data 字段都必须发送，即使不需要修改所有值。此外，所有 min/max 键的发送都是必填的，不需要使用该过滤器时传 'null'。

Body 示例​

{
    "status": "inactive",
    "custom_data": {
        "disbursed_issue_amount": {"min": 1000, "max": null},
        "number_of_installments": {"min": 12, "max": 24},
        "consigned_credit_balance": {"min": 200, "max": null},
        "days_since_employment": {"min": null},
        "age": {"min": null, "max": 60},
        "received_daily_proposals": {"max": 1000},
    }
}

Response​

STATUS
- 201 (Accepted)
Response Body: 配置已更新 
{
    "status": "active",
    "custom_data": {
        "disbursed_issue_amount": {"min": 1000, "max": null},
        "number_of_installments": {"min": 12, "max": 24},
        "consigned_credit_balance": {"min": 200, "max": null},
        "days_since_employment": {"min": null},
        "age": {"min": null, "max": 60},
        "received_daily_proposals": {"max": 1000},
    }
}

添加过滤 CNPJ​

对于只想接收特定 CNPJ 员工申请的客户，可以批量添加这些 CNPJ：

ENDPOINT
- /private_payroll_auction/requester_configuration/related_employer
MÉTODO
- POST
注意！

DATAPREV 只使用 CNPJ 的根号，因此根据雇主文件号进行过滤时，只需发送 CNPJ 的前 8 位数字。

Body​

{
  "employer_document_numbers": [
    "01234567",
    "12345678"
  ]
}

列表最多可包含 100 个 CNPJ。

Response​

STATUS
- 201
Response Body: 已添加 CNPJ
{
  "employer_document_numbers": [
    "01234567",
    "12345678"
  ]
}
备注

只有实际添加的 CNPJ 才会被返回。如果某个 CNPJ 已经注册，则不会出现在响应列表中。如果没有任何 CNPJ 被添加，将返回空列表。

删除过滤 CNPJ​

ENDPOINT
- /private_payroll_auction/requester_configuration/remove_related_employers
MÉTODO
- POST

Body​

{
  "employer_document_numbers": [
    "01234567",
    "12345678"
  ]
}

CNPJ 只需发送前 8 位数字，列表最多可包含 100 个 CNPJ。

Response​

STATUS
- 200
Response Body: 已删除 CNPJ 
{
    "employer_document_numbers": ["01234567", "12345678"]
}

查询过滤 CNPJ​

要查询为申请方注册为过滤器的 CNPJ，请使用以下支持分页的端点。

端点​

ENDPOINT
- /private_payroll_auction/requester_configuration/related_employers
MÉTODO
- GET

Query Params​

字段类型描述默认值
page_numberint当前页码1
page_rowsint每页记录数100

响应示例 - 200​

{
  "data": [
    {
      "employer_document_number": "01234567"
    },
    {
      "employer_document_number": "12345678"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 2,
    "rows_per_page": 2,
    "total_pages": 3,
    "total_rows": 6
  }
}

附件​

过滤规则修改 Payload 详情​

字段类型描述必填
statusstring客户新状态否
custom_datadict客户新过滤器否

客户状态​

状态描述
active客户希望接收拍卖中的新提案申请
inactive客户不希望接收新提案申请

Custom Data 参数​

字段类型描述必填
disbursed_issue_amountdict已发行合同金额（最小值和最大值）是
number_of_installmentsdict分期数（最小值和最大值）是
consigned_credit_balancedict薪资抵押信贷余额（最小值和最大值）是
days_since_employmentdict自雇佣关系开始以来的天数（最小值）是
agedict申请人年龄（最小值和最大值）是
received_daily_proposalsdict每日接收提案数量（最大值）是
alert_preferencesdict带有某些提醒的贷款申请过滤器，详情请参阅 alert_preferences 参数是

alert_preferences 参数​

字段类型描述必填枚举值
defaultstring默认行为，未配置特定行为时使用是ignore 表示不接收，acknowledge 表示接收
terminationstring带有解雇提醒的线索过滤器否ignore 表示不接收，acknowledge 表示接收
leavestring带有休假提醒的线索过滤器否ignore 表示不接收，acknowledge 表示接收

添加和删除过滤 CNPJ 的 Payload 详情​

字段类型描述必填
employer_document_numberstring 数组CNPJ 根号列表（每个 8 位数字）。必须包含 1 至 100 个条目是