转换短链接
更新时间:2025.03.21该接口主要用于扫码原生支付模式一中的二维码链接转成短链接(weixin://wxpay/s/XXXXXX),减小二维码数据量,提升扫描速度和精确度。
接口说明
适用对象: 直连模式 机构模式
请求URL: https://apihk.mch.weixin.qq.com/tools/shorturl
请求方式: POST
是否需要证书: 否
输入参数
参数名 | 变量名 | 类型 | 必填 | 描述 |
---|---|---|---|---|
公众账号ID | appid | string(32) | 是 | 微信分配的公众账号ID |
商户号 | mch_id | string(32) | 是 | 微信支付分配的商户号 |
子商户公众账号ID | sub_appid | string(32) | 否 | 微信分配的子商户公众账号ID,如需在支付完成后获取sub_openid则此参数必传。 |
子商户号 | sub_mch_id | string(32) | 是 | 微信支付分配的子商户号 |
URL链接 | long_url | string(512) | 是 | 需要转换的URL,签名用原串,传输需URL encode |
随机字符串 | nonce_str | string(32) | 是 | 随机字符串,不长于32位。推荐随机数生成算法 |
签名 | sign | string(64) | 是 | 签名,详见签名生成算法 |
签名类型 | sign_type | string(32) | 否 | 签名类型,目前支持HMAC-SHA256和MD5,默认为MD5 |
举例如下:
注:参数值用XML转义即可,CDATA标签用于说明数据不被XML解析器解析。
返回结果
字段名 | 变量名 | 类型 | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | return_code | string(16) | 是 | SUCCESS/FAIL |
返回信息 | return_msg | string(128) | 否 | 返回信息,如非空,为错误原因 |
以下字段在return_code为SUCCESS的时候有返回
字段名 | 变量名 | 类型 | 必填 | 描述 |
---|---|---|---|---|
公众账号ID | appid | string(32) | 是 | 调用接口提交的公众账号ID |
商户号 | mch_id | string(32) | 是 | 调用接口提交的商户号 |
子商户公众账号ID | sub_appid | string(32) | 否 | 微信分配的子商户公众账号ID |
子商户号 | sub_mch_id | string(32) | 是 | 微信支付分配的子商户号 |
随机字符串 | nonce_str | string(32) | 是 | 微信返回的随机字符串 |
签名 | sign | string(64) | 是 | 微信返回的签名,详见签名算法 |
业务结果 | result_code | string(16) | 是 | SUCCESS/FAIL |
错误代码 | err_code | string(32) | 否 | 详细见错误列表 |
URL链接 | long_url | string(512) | 是 | 需要转换的URL,签名用原串,传输需URL encode |
举例如下:
错误码
名称 | 描述 | 原因 | 解决方案 |
---|---|---|---|
INVALID_REQUEST | 参数错误 | 参数格式有误或者未按规则上传 | 订单重入时,要求参数值与原请求一致,请确认参数问题 |
NOAUTH | 商户无此接口权限 | 商户未开通此接口权限 | 请商户前往申请此接口权限 |
NOTENOUGH | 余额不足 | 用户账号余额不足 | 用户账号余额不足,请用户充值或更换支付卡后再支付 |
ORDERPAID | 商户订单已支付 | 商户订单已支付,无需重复操作 | 商户订单已支付,无需更多操作 |
ORDERCLOSED | 订单已关闭 | 当前订单已关闭,无法支付 | 当前订单已关闭,请重新下单 |
SYSTEMERROR | 系统错误 | 系统超时 | 系统异常,请用相同参数重新调用 |
APPID_NOT_EXIST | APPID不存在 | 参数中缺少APPID | 请检查APPID是否正确 |
MCHID_NOT_EXIST | MCHID不存在 | 参数中缺少MCHID | 请检查MCHID是否正确 |
APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | appid和mch_id不匹配 | 请确认appid和mch_id是否匹配 |
LACK_PARAMS | 缺少参数 | 缺少必要的请求参数 | 请检查参数是否齐全 |
OUT_TRADE_NO_USED | 商户订单号重复 | 同一笔交易不能多次提交 | 请核实商户订单号是否重复提交 |
SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |
REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
POST_DATA_EMPTY | post数据为空 | post数据不能为空 | 请检查post数据是否为空 |
NOT_UTF8 | 编码格式错误 | 未使用指定编码格式 | 请使用UTF-8编码格式 |