pay.offline-payments.settlements.create
创建结算单
- 请求路由:
pay.offline-payments.settlements.create- 交互模型:
Request Response- 访问限制: 无
这个操作会根据提交的结算单信息筛选符合条件的所有待支付的线下支付单,然后将这些支付单进行批量支付,同时触发支付成功事件。 这个操作不可逆。
未找到匹配的任何线下支付单时,会抛出异常。
请求
RSocket.rr({
"route" : "pay.offline-payments.settlements.create",
"data" : {
"payer" : {
"targetType" : "PLATFORM",
"targetId" : "PLATFORM",
"targetName" : "平台"
},
"payee" : {
"targetType" : "COMPANY",
"targetId" : "CN1014",
"targetName" : "声波客运公司"
},
"dateFrom" : "2024-02-01T00:00:00+08:00",
"dateTo" : "2024-03-01T00:00:00+08:00",
"payTime" : "2024-09-01T10:00:00+08:00",
"payRemark" : "已通过银行转账支付到对公帐户。支付银行:中国银行,支付账号:6222 2222 2222 2222"
},
"args" : {
"settlement" : "结算单"
}
});
请求参数
| 名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
settlement | Object | 否 | 结算单 |
settlement.id | String | 否 | 结算单号 |
settlement.payer | Object | 否 | 付款方 |
settlement.payer.targetType | String | 否 | 帐户类型 由调用方根据分账方身份类型定义,例如:COMPANY,PARTNER,CHANNEL等 |
settlement.payer.targetId | String | 否 | targetType下的帐户标识 |
settlement.payer.targetName | String | 否 | 帐户名 |
settlement.payee | Object | 否 | 收款方 |
settlement.payee.targetType | String | 否 | 帐户类型 由调用方根据分账方身份类型定义,例如:COMPANY,PARTNER,CHANNEL等 |
settlement.payee.targetId | String | 否 | targetType下的帐户标识 |
settlement.payee.targetName | String | 否 | 帐户名 |
settlement.dateFrom | String | 否 | 线下支付单起始时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z |
settlement.dateTo | String | 否 | 线下支付单结束时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z |
settlement.offlinePaymentIds | String[] | 否 | 线下支付单ID列表 ID列表为空时,必须指定时间范围;不为空时,时间范围无效 |
settlement.payMethod | String | 否 | 支付方式 默认为现金支付 |
settlement.payTime | String | 否 | 实际支付时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z |
settlement.payRemark | String | 否 | 支付说明 |
settlement.totalAmount | Number | 否 | 总金额 |
settlement.count | Number | 否 | 总笔数 |
settlement.failedCount | Number | 否 | 财付通支付异常笔数 |
settlement.extraProps | Object | 否 | 扩展属性 |
settlement.crDate | String | 否 | 创建时间 |
settlement.tenantId | String | 否 | 租户ID |
返回
已创建的结算单
{
"id" : "STL202501071721105",
"payer" : {
"targetType" : "PLATFORM",
"targetId" : "PLATFORM",
"targetName" : "平台"
},
"payee" : {
"targetType" : "COMPANY",
"targetId" : "CN1014",
"targetName" : "声波客运公司"
},
"dateFrom" : "2024-02-01T00:00:00+08:00",
"dateTo" : "2024-03-01T00:00:00+08:00",
"payTime" : "2024-09-01T10:00:00+08:00",
"payRemark" : "已通过银行转账支付到对公帐户。经办人:XXX,支付银行:中国银行,支付账号:6222 2222 2222 2222",
"totalAmount" : 2820830,
"count" : 23
}
返回属性
| 名称 | 类型 | 说明 |
|---|---|---|
id | String | 结算单号 |
payer | Object | 付款方 |
payer.targetType | String | 帐户类型 由调用方根据分账方身 份类型定义,例如:COMPANY,PARTNER,CHANNEL等 |
payer.targetId | String | targetType下的帐户标识 |
payer.targetName | String | 帐户名 |
payee | Object | 收款方 |
payee.targetType | String | 帐户类型 由调用方根据分账方身份类型定义,例如:COMPANY,PARTNER,CHANNEL等 |
payee.targetId | String | targetType下的帐户标识 |
payee.targetName | String | 帐户名 |
dateFrom | String | 线下支付单起始时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z |
dateTo | String | 线下支付单结束时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z |
payMethod | String | 支付方式 默认为现金支付 |
payTime | String | 实际支付时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z |
payRemark | String | 支付说明 |
totalAmount | Number | 总金额 |
count | Number | 总笔数 |
failedCount | Number | 财付通支付异常笔数 |
extraProps | Object | 扩展属性 |
crDate | String | 创建时间 |
tenantId | String | 租户ID |