跳到主要内容

pay.offline-payments.settlements

查询结算单列表

  • 请求路由: pay.offline-payments.settlements
  • 交互模型: Request Stream
  • 访问限制: 无

请求​

RSocket.rs({
"route" : "pay.offline-payments.settlements",
"args" : {
"search" : {
"kind" : 1,
"payer" : {
"targetType" : "PLATFORM",
"targetId" : "PLATFORM"
},
"payee" : {
"targetType" : "COMPANY",
"targetId" : "CN1014"
},
"dateFrom" : "2024-02-01T00:00:00+08:00",
"dateTo" : "2024-03-01T00:00:00+08:00"
}
}
});

请求参数​

名称类型必须说明
searchObject否查询条件
search.keywordString否模糊匹配关键字
search.payerObject否付款方
search.payer.targetTypeString否帐户类型
由调用方根据分账方身份类型定义,例如:COMPANY,PARTNER,CHANNEL等
search.payer.targetIdString否targetType下的帐户标识
search.payer.targetNameString否帐户名
search.payeeObject否收款方
search.payee.targetTypeString否帐户类型
由调用方根据分账方身份类型定义,例如:COMPANY,PARTNER,CHANNEL等
search.payee.targetIdString否targetType下的帐户标识
search.payee.targetNameString否帐户名
search.payTimeFromString否支付时间起始,kind = 0 时无效
时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
search.payTimeToString否支付时间结束,kind = 0 时无效
时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
search.crDateFromString否kind = 1 时为结算单创建时间起始,其他为线下支付单创建时间起始
时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
search.crDateToString否kind = 1 时为结算单创建时间结束,其他为线下支付单创建结束
时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
search.kindNumber否查询类型 0:未结算; 1:已结算; 2:实时结算
pgObject否分页参数
pg.pageNumber否页码,首页从0开始
pg.sizeNumber否每页记录,默认为10
pg.sortString[]否排序字段清单,默认为升序,需要指定降序时在字段名后面添加desc并用分号隔开。
例如:["id", "crDate;desc"]

返回​

结算单列表

[
{
"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

    下载结果模型定义