跳到主要内容

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" : "结算单"
}
});

请求参数​

名称类型必须说明
settlementObject否结算单
settlement.idString否结算单号
settlement.payerObject否付款方
settlement.payer.targetTypeString否帐户类型
由调用方根据分账方身份类型定义,例如:COMPANY,PARTNER,CHANNEL等
settlement.payer.targetIdString否targetType下的帐户标识
settlement.payer.targetNameString否帐户名
settlement.payeeObject否收款方
settlement.payee.targetTypeString否帐户类型
由调用方根据分账方身份类型定义,例如:COMPANY,PARTNER,CHANNEL等
settlement.payee.targetIdString否targetType下的帐户标识
settlement.payee.targetNameString否帐户名
settlement.dateFromString否线下支付单起始时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
settlement.dateToString否线下支付单结束时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
settlement.offlinePaymentIdsString[]否线下支付单ID列表
ID列表为空时,必须指定时间范围;不为空时,时间范围无效
settlement.payMethodString否支付方式
默认为现金支付
  • CASH - 现金支付
  • TRANSFER - 财付通转账到零钱
  • settlement.payTimeString否实际支付时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
    settlement.payRemarkString否支付说明
    settlement.totalAmountNumber否总金额
    settlement.countNumber否总笔数
    settlement.failedCountNumber否财付通支付异常笔数
    settlement.extraPropsObject否扩展属性
    settlement.crDateString否创建时间
    settlement.tenantIdString否租户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
    }

    返回属性​

    名称类型说明
    idString结算单号
    payerObject付款方
    payer.targetTypeString帐户类型
    由调用方根据分账方身份类型定义,例如:COMPANY,PARTNER,CHANNEL等
    payer.targetIdStringtargetType下的帐户标识
    payer.targetNameString帐户名
    payeeObject收款方
    payee.targetTypeString帐户类型
    由调用方根据分账方身份类型定义,例如:COMPANY,PARTNER,CHANNEL等
    payee.targetIdStringtargetType下的帐户标识
    payee.targetNameString帐户名
    dateFromString线下支付单起始时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
    dateToString线下支付单结束时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
    payMethodString支付方式
    默认为现金支付
  • CASH - 现金支付
  • TRANSFER - 财付通转账到零钱
  • payTimeString实际支付时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
    payRemarkString支付说明
    totalAmountNumber总金额
    countNumber总笔数
    failedCountNumber财付通支付异常笔数
    extraPropsObject扩展属性
    crDateString创建时间
    tenantIdString租户ID

    下载结果模型定义