接口描述
项 | 值 |
url | https://pay.qcloud.com/cpay/scan_code_pay |
输入参数
参数名 | 必填 | 类型 | 说明 |
request_content | 是 | String | 请求内容，该 string 可以转为 json 结构，json 格式见本节 RequestContent。 |
authen_info | 是 | AuthenInfo | 认证信息，详见接口调用说明。 |
RequestContent 结构
一级参数名 | 二级参数名 | 三级参数名 | 必填 | 类型 | 说明 |
out_trade_no | - | 是 | String(32) | 由客户端生成的订单号，前缀必须是云支付订单前缀。 | |
| time_expire | - | 否 | Number(64) | 订单过期时间。 |
| total_fee | - | 是 | Number(32) | 订单总金额，单位：分。 |
| fee_type | - | 是 | String | 货币类型（目前只支持人民币，请填 CNY）。 |
| client_flow_id | - | 否 | String | 客户端流水号。 |
| body | - | 是 | String(128) | 商品或订单简要描述。 商品描述交易字段格式根据不同的应用场景按照以下格式： PC 网站：传入浏览器打开的网站主页 title 名-实际商品名称，例如：腾讯充值中心-QQ 会员充值。 公众号：传入公众号名称-实际商品名称，例如：腾讯形象店-image-QQ 公仔。 H5：应用在浏览器网页上的场景，传入浏览器打开的移动网页的主页 title 名-实际商品名称，例如：腾讯充值中心-QQ 会员充值。 线下门店：门店品牌名-城市分店名-实际商品名称，例如：image 形象店-深圳腾大-QQ 公仔。 App：需传入应用市场上的 App 名字-实际商品名称，天天爱消除-游戏充值。 |
| detail | - | 否 | String | 商品详细列表，由 json 转化而来，json 结构见公共数据结构 Detail。 |
| remark | - | 否 | String(127) | 支付备注信息。 |
| wxpay_pay_content_ext* | attach | 否 | String(127) | 附加数据，记录子商户自定义数据。 |
| | goods_tag | 否 | String(32) | 商品标记，代金券或立减优惠功能的参数。 |
| | product_id | 否 | String(32) | 商品 ID，子商户自定义。 |
| | limit_pay | 否 | String(32) | 定支付方式，目前只能是 no_credit，指定不能使用信用卡支付。 |
pay_mch_key | pay_platform | - | 是 | Number(32) | 第三方支付类型，详见枚举 PayPlatform。 |
| sub_pay_platform | - | 否 | Number(32) | 第三方支付子类型，详见枚举 SubPayPlatform。 |
| out_mch_id | - | 是 | String(32) | 服务商对外账号。 |
| out_sub_mch_id | - | 是 | String(32) | 子商户对外账号。 |
| out_shop_id | - | 是 | String(32) | 门店对外账号。 |
order_client | device_id | - | 是 | String(64) | 子商户自定义，终端设备号。 |
| staff_id | - | 否 | String(64) | 子商户自定义，店员 ID。 |
| terminal_type | - | 是 | Number(32) | 终端类型，1：Windows，2：Andriod，3：iOS，4：Linux，100：其他。 |
| sdk_version | - | 是 | String(10) | 云支付 SDK 版本号。 |
| spbill_create_ip | - | 是 | String(16) | 调用云支付 API 的机器 IP。 |
| machine_no | - | 是 | String(32) | 每个收银终端唯一码。 |
nonce_str | - | - | 是 | String(32) | 随机字符串。 |
*只有微信支付时才使用。
输出参数
参数名 | 必填 | 类型 | 说明 |
response_content | 是 | ResponseContent | 请求内容，详见本节 ResponseContent。 |
authen_info | 否 | AuthenInfo | 认证信息，详见接口调用说明。 |
ResponseContent 结构
参数名 | 必填 | 类型 | 说明 |
status | 是 | Status | 错误码，详见 Status。0：成功；非0：失败。 |
description | 否 | String(255) | 错误描述。 |
log_id | 是 | Number(32) | 消息 ID。 |
internal_status | 是 | Number(32) | 调试使用，调用者可以不予理会。 |
scan_code_pay | 否 | ScanPayResponse | authen_info 存在时必填。详见 ScanPayResponse。 |
ScanPayResponse 结构
参数名 | 必填 | 类型 | 说明 |
code_url | 是 | String | 二维码 url。 |
nonce_str | 是 | String(32) | 随机字符串。 |
示例
输入参数示例：
{"request_content": "{"nonce_str": "9f330667e18a48a7872e39878e1cd66f","pay_content": {"out_trade_no": "sz0100d9ueWXzz00320190826151533","wxpay_pay_content_ext": {"product_id": "product_id"},"total_fee": 16000,"fee_type": "CNY","body": "body"},"order_client": {"machine_no": "01-01-01-01-01-01","terminal_type": 2,"device_id": "zz003","staff_id": "zz003","sdk_version": "1.2","spbill_create_ip": "192.168.0.22","sub_terminal_type": 900},"pay_mch_key": {"out_mch_id": "sz01N6YTRV8JPIlb4AnB","out_shop_id": "sz01Kmw5JHJs278376ndk","pay_platform": 1,"out_sub_mch_id": "sz01jRnVDGfHKHI837nH"}}","authen_info": {"a": {"authen_code": "608BB7BD002E5A57F5EF501965EBD540B8039CB51916D1F3727F7A74DCADAE0B","authen_type": 1}}}
输出参数示例：
{"response_content": "{"status": 0,"description": "\\u64CD\\u4F5C\\u6210\\u529F\\u3002","log_id": 4049520517,"internal_status": 0,"scan_code_pay": {"code_url": "weixin:\\\\/\\\\/wxpay\\\\/bizpayurl?pr=3oi3IB6","nonce_str": "beM31vIaC1rgyDIX43fJxjhs77eKMrIf"}}","authen_info": {"a": {"authen_type": 1,"authen_code": "57946ECEED1554D7B95D6650B42701EA0DAB6292A3CC79D4E4C7C5F86EA1DDC1"}}}