接口描述
项 | 值 |
url | https://pay.qcloud.com/cpay/official_account_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）。 |
| 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[1] | 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) | 门店对外帐号。 |
| wxpay_pay_mch_key_ext[2] | app_id | 是 | String(32) | 微信分配给服务商的公众账号 ID。 |
| | sub_app_id | 否 | String(32) | 微信分配给子商户的公众账号 ID。 |
| | open_id | 是 | String(128) | 用户在服务商 app_id 下的唯一标识 |
| | sub_open_id | 否 | String(128) | 用户在子商户 app_id 下的唯一标识。 |
| alipay_pay_mch_key_ext[2] | user_id | 是 | String(32) | 用户支付宝 user_id。 |
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。 |
nonce_str | - | - | 是 | String(32) | 随机字符串。 |
[1]：只有微信支付时才使用。
[2]：wxpay_pay_mch_key_ext 和 alipay_pay_mch_key_ext 只需要填写一种。
输出参数
参数名 | 必填 | 类型 | 说明 |
response_content | 是 | ResponseContent | 请求内容，该 string 可以转为 JSON 结构，JSON 格式见本节 ResponseContent。 |
authen_info | 否 | AuthenInfo | 认证信息，详见接口调用说明。 |
ResponseContent 结构
参数名 | 必填 | 类型 | 说明 |
status | 是 | Status | 错误码，详见 Status。0：成功；非0：失败。 |
description | 否 | String(255) | 错误描述。 |
log_id | 是 | Number(32) | 消息 ID。 |
internal_status | 是 | Number(32) | 调试使用，调用者可以不予理会。 |
official_account_pay | 否 | OfficialAccountResponse | authen_info 存在时必填。详见 OfficialAccountPayResponse。 |
OfficialAccountPayResponse 结构
参数名 | 必填 | 类型 | 说明 |
order_content | 是 | OrderContent | 订单信息，详见公共数据结构 OrderContent。 |
pay_mch_key | 是 | PayMchKey | 支付商户信息，详见公共数据结构 PayMchKey。 |
jsapi_args | 是 | JsapiArguments | JSAPI 支付需要的参数，详见公共数据结构 JsapiArguments。 |
nonce_str | 是 | String(32) | 随机字符串。 |
示例
输入参数示例：
{"request_content": "{"pay_mch_key": {"out_mch_id": "sz01CRXVcdYDyJik8873","out_sub_mch_id": "sz01KuceBtrckIKw339L","out_shop_id": "sz01NmziKgZQmAI98Kij","pay_platform": 1,"wxpay_pay_mch_key_ext": {"sub_open_id": "oxEiL1Yq1eIlkll987C-o3v9y6MYQ"}},"pay_content": {"out_trade_no": "sz017439399162737843772384118","total_fee": 10000,"fee_type": "CNY","body": "\\u6e56\\u5357\\u4ea4\\u901a\\u5de5\\u7a0b\\u5b66\\u9662\\u540e\\u52e4\\u5904"},"order_client": {"spbill_create_ip": "192.168.1.1"},"nonce_str": "57vJCSbipmT0z00TJhw9xIHn3QGdZBah","trade_type": 3}","authen_info": {"a": {"authen_type": 1,"authen_code": "503EB8AE9F3CB922F1F772FAE0C60247BB5CE50BC84050723F154A5FEE64132C"}}}
输出参数示例：
{"response_content": "{"status": 0,"description": "\\u64CD\\u4F5C\\u6210\\u529F\\u3002","log_id": 3056348287,"internal_status": 0,"official_account_pay": {"pay_mch_key": {"pay_platform": 1,"out_mch_id": "sz01CRXVcdYDyT5TC38H","out_sub_mch_id": "sz01KuceBtrcksX1OW6V","out_shop_id": "sz01NmziKgZQmaT07BQI","sub_pay_platform": 100,"wxpay_pay_mch_key_ext": {"app_id": "wx929d56168e0xxxxx","sub_app_id": " wx0217eb58c7xxxxxx","sub_open_id": " oxEiL1Yq1eIlkll987C-o3v9y6MYQ "}},"order_content": {"out_trade_no": "sz010187m90829162737843772384118","trade_type": 3,"time_expire": 1567067378,"nonce_str": "57vJCSbipmT0z00TJhw9xIHn3QGdZBah","create_time": 1567067258,"last_update_time": 1567067258,"is_transforming": false,"total_fee": 10000,"fee_type": "CNY","cash_fee_type": "CNY","body": "\\u6E56\\u5357\\u4EA4\\u901A\\u5DE5\\u7A0B\\u5B66\\u9662\\u540E\\u52E4\\u5904","wxpay_order_content_ext": {"current_trade_state": 6,"goods_tag": "","prepare_id": "wx2916273827558523ae1a04971089444300"}},"nonce_str": "K3hIsvsZEffiLrm8n2HP2wx2IPZzNkUU","jsapi_args": {"wxpay": {"get_brand_wcpay": {"app_id": "wx369ab4160391b078","timestamp": "1567067258","nonce_str": "5cee0f921bc24254140045e4fe22483b","package": "prepay_id=wx2916273827558523ae1a04971089444300","sign_type": "MD5","pay_sign": "35E6E610203BCC85603B0A2C7996BB03"}}}}}","authen_info": {"a": {"authen_type": 1,"authen_code": "9AFBB5A348A35F5696D46E8BDDD8716A5750FD14515C00BAC1E3A60E4419D46E"}}}