无收银台模式预下单取消支付渠道

更新时间：2024-08-21 17:57:28

1.接口说明

该接口适用于开发者对接无收银台支付预下单之后，后面对该笔支付单的支付方式做修改使用。

具体场景介绍：

用户第一次在下单页面选择支付方式后，由于未知情况未完成支付；后面再从待支付订单列表等场景重新支付该笔订单。

因为之前的支付方式已经在预下单里标记过，但二次从待支付列表用户可能调整支付方式，此时需要把之前用户选择的支付方式取消掉，重新走收银台页面让用户选择，用户支付时会拉起收银台支付。

2、接口定义

2.1、基本信息

名称	内容
HTTP URL	https://open.kuaishou.com/openapi/mp/developer/epay/cancel_channel
HTTP Method	POST
Scope	需要具有小程序担保支付权限(scope.ks.epay)

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/cancel_channel?app_id=ks707065143182458884&access_token=ChFvYXV0aC5hY2Nlc3NUb2tlbhJQumJ4agm3wT4YzPvK7wEfSGVQiVDsnMk-2GqsV8vOKtJiUfl1NAGk4RreGEalNtnyczCzXzQTr-GJJsoKHGDdzRVlwkkOJx8s7mRo_d5_XpMaEkM6eJkoPbfUa_qSANYID35L6iIgb8uJWABERgoGQzYUR7lIgHlt5qRgcTmKYEYwIm5M9lEoDzAB' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sign": "5f4273e97d6c38bff8f17514e576ebfb",
    "out_order_no": "1699605608467demo1234",
}'

2.5、响应

返回值为 JSON 形式，其中包括如下字段：

字段名	类型	说明
result	number	状态码 1-业务处理成功
error_msg	string	错误提示信息，常见错误处理可参考附录常见问题章节
order_info	json string	拉起收银台的 orderInfo

示例如下（仅供参考）：

{
    "result":1,
    "error_msg":"错误信息提示",
    "order_info":{
        "order_no": "121072611585202788127",
        "order_info_token": "ChJrc01wUGF5Lm9yZGVyVG9rZW4SULxOUORbNX1NAzmbs3vCE8Fo8FN8EW90EM7iReQujs85RbgDNVDPqxJoGly_jX7Zv9kwTiXsrFuSgwrR-ufuZexCYejepc-C0swHGhJtqssdzyq4aMsYYWjhyloiIOZOjlvg2cPW6VJsOmt6c4Tz2qSsZoAhTeKIZAXM13SRKAUwAQ"
    }
}

错误码

当 result 不为 1 时，说明请求错误。错误码见附录 (opens new window)。