跳到主要内容

结束付款批次的插入

在批次中插入所有所需清算后，使用该端点表明插入已完成、可以开始处理。也可以整体废弃该批次。

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

各主机的 Base URL：环境（主机）。

我在流程中的哪一步？

这是清算流程的第 3 步。在此之前，您应已：

  1. 创建付款批次
  2. 插入清算

Request​

ENDPOINT
/settlement/fund_class/{fund_class_key}/payment_batch/{external_id}
MÉTODO
PUT

Path params​

参数类型描述
external_idstring创建批次时提供的 external_id。
Request Body
{
    "batch_status": "pending_payment"
}

请求体属性​

字段类型是否必填描述
batch_statusstring必填批次要更新到的状态。见下方枚举值。

batch_status 枚举值​

值描述
pending_payment结束插入并开始处理批次。仅当批次处于 pending_settlements_insertion，且至少有一笔 validated 或 pending_validation 的清算时接受。
discarded废弃整个批次。不会处理任何清算。批次处于 pending_settlements_insertion、pending_validation 或 pending_payment 时接受。

Response​

STATUS
200
Response Body
{
    "external_id": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
    "status": "pending_payment"
}

响应属性​

字段类型描述
external_idstring合作伙伴提供的批次外部 key。
statusstring批次的新状态。见下文。

返回的状态：

您发送的值返回的状态含义
pending_paymentpending_payment批次已关闭；等待付款确认。
pending_paymentpending_validation有清算正在由 QI Tech 审核。审核完成后，批次会自动进入 pending_payment。
discardedpending_discard 或 pending_discard_on_cash_account废弃处理中。最终状态 discarded 通过批次 webhook 发送。

后续步骤​

关闭批次后，处理会自动开始。可通过 webhook 或批次查询跟踪结果：

  1. 付款批次 webhook——批次已付款、已完成或已废弃时发送通知。
  2. 清算 webhook——每笔清算处理后单独发送通知。

错误​

状态码代码触发条件
404SET000005该 fund_class_key 不存在。
403SET000028该基金不属于您的角色（基金的管理人、关联的顾问或相关的转让方）。
404SET000010URL 中指定的批次在该基金中不存在。
400SET000026batch_status 不是 pending_payment 或 discarded。
400SET000049对已处于 pending_payment、paid 或 completed 的批次请求关闭。
400SET000016对不处于 pending_settlements_insertion 的批次请求关闭（例如处于 pending_validation 或废弃中）。
400SET000017批次中没有任何 validated 或 pending_validation 的清算。
400SET000069对已处于最终状态（paid、completed 或 discarded）的批次请求废弃。

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