付款碼支付API(支持單品優(yōu)惠)
應用場景
請求參數(shù)變更:單品優(yōu)惠僅在原付款碼支付API基礎上新增了一個請求參數(shù)version,其他協(xié)議規(guī)則保持不變。
返回參數(shù)變更:新增參數(shù)promotion_detail,以json方式展示,所有優(yōu)惠信息都將通過該字段做展示,同時為了保持參數(shù)風格一致,原字段“總代金券金額(coupon_fee)”、“應結訂單金額(settlement_total_fee)”也進行了重命名 ,詳細內(nèi)容請見“注意事項”。
接口地址
https://api.mch.weixin.qq.com/pay/micropay
https://api2.mch.weixin.qq.com/pay/micropay(備用域名)見跨城冗災方案
是否需要證書
不需要。
輸入?yún)?shù)
名稱 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
接口版本號 | version | 是 | String(32) | 1.0 | 新增字段,接口版本號,區(qū)分原接口,固定填寫1.0 |
訂單優(yōu)惠標記 | goods_tag | 否 | String(32) | 訂單優(yōu)惠標記,用于區(qū)分訂單是否可以享受優(yōu)惠,字段內(nèi)容在微信后臺配置券時進行設置,說明詳見代金券或立減優(yōu)惠 | |
商品詳情 | detail | 是 | String(6000) | 示例見下文 | 新增字段,單品優(yōu)惠活動該字段必傳,且必須按照規(guī)范上傳,JSON格式,詳見下文【單品優(yōu)惠活動字段說明】 |
其他字段列表見 |
單品優(yōu)惠活動detail字段列表說明:
名稱 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
訂單原價 | cost_price | 否 | int | 608800 | 1.商戶側一張小票訂單可能被分多次支付,訂單原價用于記錄整張小票的交易金額。 2.當訂單原價與支付金額不相等,則不享受優(yōu)惠。 3.該字段主要用于防止同一張小票分多次支付,以享受多次優(yōu)惠的情況,正常支付訂單不必上傳此參數(shù)。 |
商品小票ID | receipt_id | 否 | String(32) | wx123 | 商家小票ID |
單品列表 | goods_detail | 是 | String | 示例見下文 | 單品信息,使用Json數(shù)組格式提交 |
單品優(yōu)惠活動goods_detail字段說明:
名稱 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
商品編碼 | goods_id | 是 | String(32) | 商品編碼 | 由半角的大小寫字母、數(shù)字、中劃線、下劃線中的一種或幾種組成 |
微信支付商品編碼 | wxpay_goods_id | 否 | String(32) | 1001 | 微信支付定義的統(tǒng)一商品編號(沒有可不傳) |
商品名稱 | goods_name | 否 | String(256) | iPhone6s 16G | 商品的實際名稱 |
商品數(shù)量 | quantity | 是 | int | 1 | 用戶購買的數(shù)量 |
商品單價 | price | 是 | int | 528800 | 單位為:分。如果商戶有優(yōu)惠,需傳輸商戶優(yōu)惠后的單價(例如:用戶對一筆100元的訂單使用了商場發(fā)的優(yōu)惠券100-50,則活動商品的單價應為原單價-50) |
detail字段值舉例如下:
{
"cost_price":608800,
"receipt_id":"wx123",
"goods_detail":[ //注意goods_detail字段的格式為"goods_detail":[{}],較多商戶寫成"goods_detail":{}
{
"goods_id":"商品編碼",
"wxpay_goods_id":"1001",
"goods_name":"",
"quantity":1,
"price":528800
},
{
"goods_id":"商品編碼",
"wxpay_goods_id":"1002",
"goods_name":"iPhone6s 32G",
"quantity":1,
"price":608800
}
]
}
提交支付數(shù)據(jù)舉例:
<xml>
<appid>wxdace645e0bc2c424</appid>
<attach>test</attach>
<auth_code>130050378319653252</auth_code>
<body>被掃測試</body>
<detail><![CDATA[{"cost_price":1,"receipt_id":"wx123","goods_detail":[{"goods_id":"商品編碼","wxpay_goods_id":"1001","goods_name":"iPhone6s 16G","quantity":1,"price":1},{"goods_id":"商品編碼","wxpay_goods_id":"1002","goods_name":"iPhone6s 32G","quantity":1,"price":1}]}]]></detail>
<device_info>TEST01</device_info>
<goods_tag>MEETING</goods_tag>
<mch_id>1900009001</mch_id>
<nonce_str>4b4f6f692547affd2c8fadb39fed603a</nonce_str>
<out_trade_no>19000090011489146530</out_trade_no>
<spbill_create_ip>14.23.150.211</spbill_create_ip>
<sub_mch_id>11383918</sub_mch_id>
<total_fee>503</total_fee>
<version>1.0</version>
<sign>144FF79B7391FE1BD0708470B7D8A2E3</sign>
</xml>
注:參數(shù)值用XML轉義即可,CDATA標簽用于說明數(shù)據(jù)不被XML解析器解析。
返回結果
當return_code 和result_code都為SUCCESS的時:
名稱 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
其他字段列表見 | |||||
營銷詳情 | promotion_detail | 是 | String(6000) | 示例見下文 | 新增返回,營銷詳情列表,使返回值為Json格式 |
單品優(yōu)惠活動promotion_detail字段列表說明:
名稱 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
券ID | promotion_id | 是 | String(32) | 109519 |
券或者立減優(yōu)惠id |
優(yōu)惠名稱 | name | 否 | String(64) | 單品惠-6 |
優(yōu)惠名稱 |
優(yōu)惠范圍 | scope | 否 | String(32) | SINGLE |
GLOBAL- 全場代金券 SINGLE- 單品優(yōu)惠 |
優(yōu)惠類型 | type | 否 | String(32) | DISCOUNT |
COUPON- 代金券,需要走結算資金的充值型代金券,(境外商戶券幣種與支付幣種一致) DISCOUNT- 優(yōu)惠券,不走結算資金的免充值型優(yōu)惠券,(境外商戶券幣種與標價幣種一致 |
優(yōu)惠券面額 | amount | 是 | int | 5 | 用戶享受優(yōu)惠的金額 |
活動ID | activity_id | 是 | String(32) | 931386 |
在微信商戶后臺配置的批次ID |
微信出資 | wxpay_contribute | 否 | String(32) | 0 | 特指由微信支付商戶平臺創(chuàng)建的優(yōu)惠,出資金額等于本項優(yōu)惠總金額,單位為分 |
商戶出資 | merchant_contribute | 否 | String(32) | 0 | 特指商戶自己創(chuàng)建的優(yōu)惠,出資金額等于本項優(yōu)惠總金額,單位為分 |
其他出資 | other_contribute | 否 | String(32) | 5 | 其他出資方出資金額,單位為分 |
單品列表 | goods_detail | 否 | String | 見下文 | 單品信息,使用Json格式 |
單品優(yōu)惠活動goods_detail字段說明:
名稱 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
商品編碼 | goods_id | 是 | String(32) | 商品編碼 | 由半角的大小寫字母、數(shù)字、中劃線、下劃線中的一種或幾種組成 |
商品備注 | goods_remark | 否 | String(128) | 1001 | goods_remark為備注字段,按照配置原樣返回,字段內(nèi)容在微信后臺配置券時進行設置。 |
商品優(yōu)惠金額 | discount_amount | 是 | int | 100 | 單品的總優(yōu)惠金額,單位為:分 |
商品數(shù)量 | quantity | 是 | int | 1 | 用戶購買的數(shù)量 |
商品價格 | price | 是 | int | 528800 | 單位為:分。如果商戶有優(yōu)惠,需傳輸商戶優(yōu)惠后的單價(例如:用戶對一筆100元的訂單使用了商場發(fā)的紙質優(yōu)惠券100-50,則活動商品的單價應為原單價-50) |
注意:goods_remark為備注字段,按照配置原樣返回,goods_tag是訂單優(yōu)惠標記,用于區(qū)分訂單是否可以享受優(yōu)惠,兩個字段內(nèi)容都在微信后臺配置券時進行設置。
promotion_detail字段值舉例如下:
{
"promotion_detail":[
{
"promotion_id":"109519",
"name":"單品惠-6",
"scope":"SINGLE",
"type":"DISCOUNT",
"amount":5,
"activity_id":"931386",
"wxpay_contribute":0,
"merchant_contribute":0,
"other_contribute":5,
"goods_detail":[
{
"goods_id":"a_goods1",
"goods_remark":"商品備注",
"quantity":7,
"price":1,
"discount_amount":4
},
{
"goods_id":"a_goods2",
"goods_remark":"商品備注",
"quantity":1,
"price":2,
"discount_amount":1
}
]
}
]
}