应用场景
该接口主要用于 Native 支付模式一中的二维码链接转成短链接(weixin://wxpay/s/XXXXXX),减小二维码数据量,提升扫描速度和精确度。
接口地址
https://api.mch.weixin.qq.com/tools/shorturl
请求方式: POST
是否需要证书
否
请求参数
| 字段名 |
变量名 |
必填 |
类型 |
示例值 |
描述 |
| 公众账号 ID |
appid |
是 |
String(32) |
wx8888888888888888 |
微信分配的公众账号 ID(企业号 corpid 即为此 appId) |
| 商户号 |
mch_id |
是 |
String(32) |
1900000109 |
微信支付分配的商户号 |
| URL 链接 |
long_url |
是 |
String(512、 |
weixin://wxpay/bizpayurl?sign=XXXXX&appid=XXXXX&mch_id=XXXXX&product_id=XXXXXX&time_stamp=XXXXXX&nonce_str=XXXXX |
需要转换的 URL,签名用原串,传输需 URLencode |
| 随机字符串 |
nonce_str |
是 |
String(32) |
5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
随机字符串,不长于 32 位。推荐随机数生成算法 |
| 签名 |
sign |
是 |
String(32) |
C380BEC2BFD727A4B6845133519F3AD6 |
签名,详见签名生成算法 |
| 签名类型 |
sign_type |
否 |
String(32) |
HMAC-SHA256 |
签名类型,目前支持 HMAC-SHA256 和 MD5,默认为 MD5 |
返回结果
| 字段名 |
变量名 |
必填 |
类型 |
示例值 |
描述 |
| 返回状态码 |
return_code |
是 |
String(16) |
SUCCESS |
SUCCESS/FAIL 此字段是通信标识,非交易标识,交易是否成功需要查看 trade_state 来判断 |
| 返回信息 |
return_msg |
是 |
String(128) |
OK |
当 return_code 为 FAIL 时返回信息为错误原因 ,例如签名失败参数格式校验错误 |
以下字段在 return_code 为 SUCCESS 的时候有返回
| 字段名 |
变量名 |
必填 |
类型 |
示例值 |
描述 |
| 公众账号 ID |
appid |
是 |
String(32) |
wx8888888888888888 |
微信分配的公众账号 ID |
| 商户号 |
mch_id |
是 |
String(32) |
1900000109 |
微信支付分配的商户号 |
| 随机字符串 |
nonce_str |
是 |
String(32) |
5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
随机字符串,不长于 32 位。推荐随机数生成算法 |
| 签名 |
sign |
是 |
String(32) |
C380BEC2BFD727A4B6845133519F3AD6 |
签名,详见签名生成算法 |
| 业务结果 |
result_code |
是 |
String(16) |
SUCCESS |
SUCCESS/FAIL |
| 错误代码 |
err_code |
否 |
String(32) |
SYSTEMERROR |
SYSTEMERROR—系统错误 URLFORMATERROR—URL 格式错误 |
| URL 链接 |
short_url |
是 |
String(64) |
weixin://wxpay/s/XXXXXX |
转换后的 URL |
错误码
| 名称 |
描述 |
原因 |
解决方案 |
| SIGNERROR |
签名错误 |
参数签名结果不正确 |
请检查签名参数和方法是否都符合签名算法要求 |
| REQUIRE_POST_METHOD |
请使用 post 方法 |
未使用 post 传递参数 |
请检查请求参数是否通过 post 方法提交 |
| 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 |
缺少参数 |
缺少必要的请求参数 |
请检查参数是否齐全 |
| XML_FORMAT_ERROR |
XML 格式错误 |
XML 格式错误 |
请检查 XML 参数格式是否正确 |
| POST_DATA_EMPTY |
post 数据为空 |
post 数据不能为空 |
请检查 post 数据是否为空 |
| 有事情请找微信官方 谢谢! |
|
|
|