开发 服务端 担保支付(单次支付) 开放接口 订单信息查询能力
# 订单信息查询
更新时间：2024-08-21 18:07:22
# 1、接口说明
开发者在进行支付预下单，发起结算，发起退款后，平台都会生成相应的支付单，结算单和退款单，如下提供查询接口，查询订单的状态
# 2、支付单查询
# 2.1、基本信息
| 名称 | 内容 |
| HTTP URL | https://open.kuaishou.com/openapi/mp/developer/epay/query_order |
| HTTP Method | POST |
| 接口频次 | 30QPS(小程序app_id维度) |
# 2.2、请求头
| 名称 | 字段类型 | 内容 |
| Content-Type | String | 固定值: "application/json" |
# 2.3 入参
query param 参数
| 字段名 | 类型 | 是否必填 | 是否参与签名 | 说明 |
| app_id | string | 是 | 是 | 小程序 AppID |
| access_token | string | 是 | 否 | 拥有小程序支付权限的access token，获取方式见getAccessToken |
body json参数
| 字段名 | 类型 | 是否必填 | 是否参与签名 | 说明 |
| out_order_no | string[6,32] | 是 | 是 | 商户系统内部订单号，只能是数字、大小写字母_-*且在同一个商户号下唯一 示例值：1217752501201407033233368018 |
| sign | string | 是 | 否 | 开发者对核心字段签名, 签名方式见附录 |
# 2.4、请求示例
curl --location --request POST 'https://open.kuaishou.com/openapi/mp/developer/epay/query_order
?app_id=ks707065143182458884&access_token=ChFvYXV0aC5hY2Nlc3NUb2tlbhJQcXi6SorFfkg786OWTtGyvXf1Qz0wbN2pt4YlWHppV78IzJA92mwdcdRqegxMFRwBRTM6r5vVYzMFUlbqAfPpdYYKpRlywCtyzomu7d_mt44aEqr20o3-d0Tt4_ZJzk9p2G6vnyIg4o35UNBVgOdoJEObJmLLnr4IiN6SZO3G2saTmDnPtLEoDzAB' \
--header 'Content-Type: application/json' \
--data '{
"out_order_no":"1711619867139contractDemo",
"sign":"360a9add284bb4e2050673132418a356"
}'
# 2.4.1响应
返回值为 JSON 形式，其中包括如下字段：
| 字段名 | 类型 | 说明 |
| result | number | 状态码 1-业务处理成功 |
| error_msg | string | 错误提示信息，常见错误处理可参考附录常见问题章节 |
| payment_info | json string | 订单支付信息 |
示例如下（仅供参考）：
{
"result":1,
"error_msg":"错误提示信息",
"payment_info":{
"total_amount": 1200,
"pay_status": "PROCESSING", // PROCESSING-处理中|SUCCESS-成功|FAILED-失败|TIMEOUT-超时
"pay_time": 1712753202906,
"pay_channel": "WECHAT", // WECHAT-微信 | ALIPAY-支付宝
"out_order_no": "1637808229728demo",
"ks_order_no": "121112500031787702250",
"extra_info":"{"url":"","item_type":"VIDEO","item_id":"5239375269605736845","author_id":"123"}", // VIDEO-视频|LIVE-直播|UNKNOWN-其他，url只有视频存在
"enable_promotion": true,
"promotion_amount": 1,
"open_id":"5b748c61ef280130c0656638ebd4eaa6",
"order_status": 2
}
}
payment_info字段说明：
| 字段名 | 类型 | 说明 |
| total_amount | number | 预下单用户支付金额 |
| pay_status | string | 支付状态。 取值： PROCESSING - 处理中 SUCCESS - 成功 FAILED - 失败 TIMEOUT - 超时 |
| pay_time | number | 订单支付时间，单位为毫秒时间戳。 |
| pay_channel | string | 支付渠道。 取值： UNKNOWN - 未知 WECHAT - 微信 ALIPAY - 支付宝 APPLE_PAY - 苹果支付 (注：如果用户还未支付，这里返回的是UNKNOWN.） |
| out_order_no | string | 开发者下单单号 |
| ks_order_no | string | 快手小程序平台订单号 |
| extra_info | string | 订单来源信息，历史订单为"" |
| enable_promotion | boolean | 是否参与分销，true:分销，false:非分销 |
| promotion_amount | number | 预计达人分销金额，单位：分 |
| developer_promotion_amount | number | 预计服务商分销金额，单位：分 |
| open_id | string | 订单对应的用户open id |
| order_status | number | 开发者回传的订单同步状态，状态值说明见订单同步接口 |
extra_info说明及示例：
extra_info字段为订单信息的来源，以JSON字符串格式。开发者可通过该字段区分订单来源于直播场景或者短视频场景（其他场景返回为空）, 以及对应的视频作者和视频ID。
开发者需要解析字符串，从中获取字段具体信息，字段信息含义如下:
| 字段名 | 说明 |
| url | 视频/直播对应的链接：如为直播，返回为空；如为短视频，返回的是加密的视频ID，开发者可通过拼接http前缀，访问到具体视频。如短视频场景返回的URL为：3xqxmjkthzpckus；在该返回结果前拼接https://www.kuaishou.com/short-video/ 生成：https://www.kuaishou.com/short-video/3xqxmjkthzpckus （可直接访问到具体视频） |
| item_type | VIDEO=短视频 LIVE=直播 |
| item_id | 直播id或视频id |
| author_id | 快手ID（ 注意快手ID区别于快手号，但对于具体账号，均唯一 ) |
| trade_no | 用户侧支付页交易单号，具体获取方法可点击查看 |
示例：
直播
{"url":"","item_type":"LIVE","item_id":"PMbDd4e7u9o","author_id":"2282629641"}
视频
{"url":"3xqxmjkthzpckus","item_type":"VIDEO","item_id":"5217138756521753529","author_id":"1198084488"}
# 2.4.2错误码
当 result 不为 1 时，说明请求错误。错误码见附录。
# 3、结算单查询
# 3.1、基本信息
| 名称 | 内容 |
| HTTP URL | https://open.kuaishou.com/openapi/mp/developer/epay/query_settle |
| HTTP Method | POST |
| 接口频次 | 30QPS(小程序app_id维度) |
# 3.2、请求头
| 名称 | 字段类型 | 内容 |
| Content-Type | String | 固定值: "application/json" |
# 3.3、参数
query param参数
| 字段名 | 类型 | 是否必填 | 是否参与签名 | 说明 |
| app_id | string | 是 | 是 | 小程序 AppID |
| access_token | string | 是 | 否 | 拥有小程序支付权限的access token，获取方式见getAccessToken |
body json参数
| 字段名 | 类型 | 是否必填 | 是否参与签名 | 说明 |
| out_settle_no | string[6,32] | 是 | 是 | 开发者的结算单号 |
| sign | string | 是 | 否 | 开发者对核心字段签名, 签名方式见附录 |
# 3.3、请求示例
curl --location --request POST 'https://open.kuaishou.com/openapi/mp/developer/epay/query_settle
?app_id=ks707065143182458884&access_token=ChFvYXV0aC5hY2Nlc3NUb2tlbhJQcXi6SorFfkg786OWTtGyvXf1Qz0wbN2pt4YlWHppV78IzJA92mwdcdRqegxMFRwBRTM6r5vVYzMFUlbqAfPpdYYKpRlywCtyzomu7d_mt44aEqr20o3-d0Tt4_ZJzk9p2G6vnyIg4o35UNBVgOdoJEObJmLLnr4IiN6SZO3G2saTmDnPtLEoDzAB' \
--header 'Content-Type: application/json' \
--data '{
"out_settle_no":"1711619867139contractDemo",
"sign":"360a9add284bb4e2050673132418a356"
}'
# 3.3.1响应
返回值为 JSON 形式，其中包括如下字段：
| 字段名 | 类型 | 说明 |
| result | number | 状态码 1-业务处理成功。其他不成功，详细见错误码 |
| error_msg | string | 错误提示信息，常见错误处理可参考附录常见问题章节 |
| settle_info | json string | 结算信息 |
示例如下（仅供参考）：
{
"result":1,
"error_msg":"错误提示信息",
"settle_info":{
"settle_no":"234325456565",
"total_amount":3234, // 支付订单总金额
"settle_amount":234, // 结算后给商家的金额
"settle_status": "SETTLE_PROCESSING",
"ks_order_no": "121120711774457276553",
"ks_settle_no": "321120700415719078553"
"promotion_amount": 10,
"developer_promotion_amount": 20
}
}
复制
settle_info字段说明：
| 字段名 | 类型 | 说明 |
| settle_no | string | 开发者的结算单号 |
| total_amount | number | 支付订单的总金额，单位为分 |
| settle_amount | number | 结算后给商户的金额，单位为分 |
| settle_status | string | SETTLE_PROCESSING-处理中，SETTLE_SUCCESS-成功，SETTLE_FAILED-失败 |
| ks_order_no | string | 快手小程序平台订单号 |
| ks_settle_no | string | 快手小程序平台结算单号 |
| promotion_amount | number | 达人分销金额，单位为分 |
| developer_promotion_amount | number | 服务商分销金额，单位为分 |
# 3.3.2错误码
当 result 不为 1 时，说明请求错误。错误码见附录 (opens new window)。
# 4、退款单查询
# 4.1、基本信息
| 名称 | 内容 |
| HTTP URL | https://open.kuaishou.com/openapi/mp/developer/epay/query_refund |
| HTTP Method | POST |
| 接口频次 | 30QPS(小程序app_id维度) |
# 4.2、请求头
| 名称 | 字段类型 | 内容 |
| Content-Type | String | 固定值: "application/json" |
# 4.3、参数
query param入参
| 字段名 | 类型 | 是否必填 | 是否参与签名 | 说明 |
| app_id | string | 是 | 是 | 小程序 AppID |
| access_token | string | 是 | 否 | 拥有小程序支付权限的access token，获取方式见getAccessToken |
body json入参
| 字段名 | 类型 | 是否必填 | 是否参与签名 | 说明 |
| out_refund_no | string[6,32] | 是 | 是 | 开发者的退款单号 |
| sign | string | 是 | 否 | 开发者对核心字段签名, 签名方式见附录 |
# 4.4、请求示例
curl --location --request POST 'https://open.kuaishou.com/openapi/mp/developer/epay/query_refund
?app_id=ks707065143182458884&access_token=ChFvYXV0aC5hY2Nlc3NUb2tlbhJQcXi6SorFfkg786OWTtGyvXf1Qz0wbN2pt4YlWHppV78IzJA92mwdcdRqegxMFRwBRTM6r5vVYzMFUlbqAfPpdYYKpRlywCtyzomu7d_mt44aEqr20o3-d0Tt4_ZJzk9p2G6vnyIg4o35UNBVgOdoJEObJmLLnr4IiN6SZO3G2saTmDnPtLEoDzAB' \
--header 'Content-Type: application/json' \
--data '{
"out_refund_no":"1711619867139contractDemo",
"sign":"360a9add284bb4e2050673132418a356"
}'
# 4.4.1响应
返回值为 JSON 形式，其中包括如下字段：
| 字段名 | 类型 | 说明 |
| result | number | 状态码 1-业务处理成功。其他不成功，详细见错误码 |
| error_msg | string | 错误提示信息，常见错误处理可参考附录常见问题章节 |
| refund_info | json string | 退款信息 |
示例如下（仅供参考）：
{
"result":1,
"error_msg":"success",
"refund_info":{
"refund_no":"1660811124083refund",
"refund_amount":1,
"refund_status":"REFUND_SUCCESS",
"ks_order_no":"122081801105480677436",
"ks_refund_no":"222081811172813537436"
"ks_refund_type":"保证金账户退款",
"ks_refund_fail_reason":"账户异常",
"apply_refund_reason":"用户申请退款"
}
}
refund_info字段说明：
| 字段名 | 类型 | 说明 |
| refund_no | string | 小程序平台的退款单号 |
| refund_amount | number | 此次退款金额。单位为分 |
| refund_status | string | 退款状态： REFUND_PROCESSING - 处理中 REFUND_SUCCESS - 成功 REFUND_FAILED - 失败 |
| ks_order_no | string | 快手小程序平台订单号 |
| ks_refund_no | string | 快手小程序平台退款单号 |
| ks_refund_type | string | 退款账户说明，枚举值为： "结算前退款" "结算后退款" "保证金账户退款" |
| ks_refund_fail_reason | string | 退款失败原因 |
| apply_refund_reason | string | 订单发起退款的原因 |
# 4.4.2错误码
当 result 不为 1 时，说明请求错误。错误码见附录 (opens new window)。
上一篇：《结算能力》
下一篇：《账单查询能力》
仍有疑问? 前往社区提问