微信支付-開發(fā)者文檔

接口說明

適用對象： 直連商戶

請求URL：https://api.mch.weixin.qq.com/v3/marketing/favor/coupon-stocks

請求方式：POST

接口頻率：單個商戶號調用頻率60/min，所有商戶號調用頻率為1000/min

接口耗時：80ms

path指該參數(shù)為路徑參數(shù)

query 指該參數(shù)需在請求URL傳參

body 指該參數(shù)需在請求JSON傳參

請求參數(shù)

參數(shù)名

變量

類型[長度限制]

必填

描述

批次名稱

stock_name

string[1,20]

是

body 批次名稱
校驗規(guī)則：
1、批次名稱最多9個中文漢字
2、批次名稱最多20個字母
3、批次名稱中不能包含不當內容和特殊字符 _ , ; |
示例值：微信支付代金券批次

批次備注

comment

string[1,60]

否

body 僅制券商戶可見，用于自定義信息。
校驗規(guī)則：批次備注最多60個UTF8字符數(shù)
示例值：零售批次

歸屬商戶號

belong_merchant

string[1,20]

是

body 批次歸屬商戶號
本字段暫未開放生效，但入?yún)r請設置為當前創(chuàng)建代金券商戶號即不會報錯，暫時不支持入?yún)⑵渌纳虘籼?/span>
示例值：98568865

可用時間-開始時間

available_begin_time

string[1,32]

是

body 批次開始時間，遵循rfc3339標準格式，格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss表示時分秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領先UTC 8小時，即北京時間）。例如：2015-05-20T13:29:35+08:00表示，北京時間2015年5月20日 13點29分35秒。
校驗規(guī)則：
1、開始時間不可早于當前時間
2、不能創(chuàng)建365天后開始的批次
3、批次可用時間范圍最長為90天
示例值：2015-05-20T13:29:35+08:00

可用時間-結束時間

available_end_time

string[1,32]

是

body 批次結束時間，遵循rfc3339標準格式，格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss表示時分秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領先UTC 8小時，即北京時間）。例如：2015-05-20T13:29:35+08:00表示，北京時間2015年5月20日 13點29分35秒。
校驗規(guī)則：
1、結束時間需晚于開始時間
2、可用時間最長為90天
3、有效時間間隔最短為1s
示例值：2015-05-20T13:29:35+08:00

+發(fā)放規(guī)則

stock_use_rule

object

是

body 批次使用規(guī)則

參數(shù)名	變量	類型[長度限制]	必填	描述
發(fā)放總上限	max_coupons	uint64	是	最大發(fā)券數(shù) 校驗規(guī)則： 1、發(fā)放總個數(shù)最少5個 2、發(fā)放總個數(shù)最多1000萬個示例值：100
總預算	max_amount	uint64	是	最大發(fā)券預算，當營銷經(jīng)費no_cash選擇預充值false時，激活批次時會從制券商戶的余額中扣除預算，請保證賬戶金額充足，單位：分 max_amount需要等于coupon_amount（面額） * max_coupons（發(fā)放總上限）校驗規(guī)則：批次總預算最多1000萬元示例值：5000
單天預算發(fā)放上限	max_amount_by_day	uint64	否	設置此字段，允許指定單天最大發(fā)券預算，單位：分。校驗規(guī)則： 1、不能大于總預算 2、max_amount_by_day不可以為0 示例值：400
單個用戶可領個數(shù)	max_coupons_per_user	uint32	是	活動期間每個用戶可領個數(shù)，當開啟了自然人限領時，多個微信號同屬于一個身份證時，視為同一用戶。校驗規(guī)則： 1、不能大于發(fā)放總個數(shù) 2、最少為1個，最多為60個示例值：3
是否開啟自然人限制	natural_person_limit	bool	是	當開啟了自然人限領時，多個微信號同屬于一個身份證時，視為同一用戶，枚舉值 true：是 false：否示例值：false
是否開啟防刷攔截	prevent_api_abuse	bool	是	若開啟防刷攔截，當用戶命中惡意、小號、機器、羊毛黨、黑產(chǎn)等風險行為時，無法成功發(fā)放代金券。枚舉值 true：是 false：否示例值：false

+樣式設置

pattern_info

object

否

body 代金券詳情頁

參數(shù)名	變量	類型[長度限制]	必填	描述
使用說明	description	string[1,3000]	是	用于說明詳細的活動規(guī)則，會展示在代金券詳情頁。校驗規(guī)則：最多1000個UTF8字符示例值：微信支付營銷代金券
商戶logo	merchant_logo	string[1,128]	否	商戶logo ，僅支持通過《圖片上傳API》接口獲取的圖片URL地址。 1、商戶logo大小需為120像素*120像素。 2、支持JPG/JPEG/PNG格式，且圖片小于1M。 3、最多128個UTF8字符示例值：https://qpic.cn/xxx
品牌名稱	merchant_name	string[1,128]	否	品牌名稱，展示在用戶卡包校驗規(guī)則： 1、最多12個中文漢字 2、最多36個英文字符示例值：微信支付
背景顏色	background_color	string[1,15]	否	券的背景顏色，可設置10種顏色，色值請參考卡券背景顏色圖。顏色取值為顏色圖中的顏色名稱。可選枚舉字段不用則不傳，不可以傳空值示例值：COLOR020
券詳情圖片	coupon_image	string[1,128]	否	券詳情圖片， 850像素*350像素，且圖片大小不超過2M，支持JPG/PNG格式，僅支持通過《圖片上傳API》接口獲取的圖片URL地址。示例值：https://qpic.cn/xxx

+核銷規(guī)則

coupon_use_rule

object

是

body 核銷規(guī)則

參數(shù)名

變量

類型[長度限制]

必填

描述

+券生效時間

coupon_available_time

object

否

允許指定券的特殊生效時間規(guī)則。
該字段暫未開放

參數(shù)名

變量

類型[長度限制]

必填

描述

+ 固定時間段可用

fix_available_time

object

否

允許指定券在特殊時間段生效。當設置固定時間段可用時不可設置領取后N天有效
該字段暫未開放

參數(shù)名	變量	類型[長度限制]	必填	描述
可用星期數(shù)	available_week_day	uint32	否	允許指定每周固定星期數(shù)生效，0代表周日生效，1代表周一生效，以此類推；不填則代表在可用時間內周一至周日都生效。該字段暫未開放示例值：1，2
當天開始時間	begin_time	uint32	否	允許指定特殊生效星期數(shù)中的具體生效的時間段。當天開始時間，單位：秒。該字段暫未開放示例值：0
當天結束時間	end_time	uint32	否	允許指定特殊生效星期數(shù)中的具體生效的時間段。當天結束時間，單位：秒，默認為23點59分59秒。該字段暫未開放示例值：3600

領取后N天有效

second_day_available

bool

否

領取后，券的開始時間為領券后第二天，如7月1日領券，那么在7月2日00:00:00開始。
當設置領取后N天有效時，不可設置固定時間段可用。
枚舉值：
true：是
false：否
該字段暫未開放
示例值：false

領取后有效時間

available_time_after_receive

uint32

否

領取后，券的結束時間為領取N天后，如設置領取后7天有效，那么7月1日領券，在7月7日23:59:59失效（在可用時間內計算失效時間，若券還未到領取后N天，但是已經(jīng)到了可用結束時間，那么也會過期）
領取后有效時間，單位：分鐘。
該字段暫未開放
示例值：1440

+固定面額滿減券使用規(guī)則

fixed_normal_coupon

object

否

stock_type為NORMAL時必填。

參數(shù)名	變量	類型[長度限制]	必填	描述
面額	coupon_amount	uint64	是	面額，單位：分。校驗規(guī)則： 1、必須為整數(shù) 2、必須大于1元且小于等于500元示例值：100
門檻	transaction_minimum	uint64	是	使用券金額門檻，單位：分。若指定可核銷商品編碼，門檻則為可核銷商品部分的消費金額，而不是訂單的消費金額。校驗規(guī)則：使用門檻必須大于優(yōu)惠金額示例值：100

訂單優(yōu)惠標記

goods_tag

array

否

訂單優(yōu)惠標記，按json格式。
商戶下單時需要傳入相同的標記(goods_tag)，用戶同時符合其他規(guī)則才能享受優(yōu)惠
校驗規(guī)則：
1、最多允許錄入50個
2、每個訂單優(yōu)惠標記支持字母/數(shù)字/下劃線，不超過128個UTF8字符。
示例值：["123321","456654"]

指定付款方式

limit_pay

array[1,1]

否

指定付款方式的交易可核銷/使用代金券，可指定零錢付款、指定銀行卡付款，需填入支付方式編碼，不在此列表中的銀行卡，暫不支持此功能。黃色標記部分為不可使用的銀行。
校驗規(guī)則：條目個數(shù)限制為【1，1】。
零錢：CFT
示例值：ICBC_CREDIT

+ 指定銀行卡BIN

limit_card

object

否

指定銀行卡bin付款的交易可核銷/使用代金券，當批次限定了指定銀行卡時方可生效

參數(shù)名	變量	類型[長度限制]	必填	描述
銀行卡名稱	name	string[1,4]	否	將在微信支付收銀臺向用戶展示，最多4個中文漢字示例值：精粹白金
指定卡BIN	bin	array	否	使用指定卡BIN的銀行卡支付方可享受優(yōu)惠，按json格式特殊規(guī)則：單個卡BIN的字符長度為【6,9】,條目個數(shù)限制為【1,10】。示例值：['62123456','62123457']

支付方式

trade_type

array

否

允許指定支付方式的交易才可核銷/使用代金券，不填則默認“不限”。
枚舉值：
MICROAPP：小程序支付
APPPAY：APP支付
PPAY：免密支付
CARD：刷卡支付
FACE：人臉支付
OTHER：其他支付
示例值：["MICROAPP","APPPAY"]

是否可疊加其他優(yōu)惠

combine_use

bool

否

允許指定本優(yōu)惠是否可以和本商戶號創(chuàng)建的其他券同時使用，不填則默認允許同時使用。枚舉值：
true：是
false：否
示例值：false

可核銷商品編碼

available_items

array

否

包含指定SKU商品編碼的交易才可核銷/使用代金券：活動商戶在交易下單時，需傳入用戶購買的所有SKU商品編碼，當命中代金券中設置的商品編碼時可享受優(yōu)惠。
校驗規(guī)則：
1、單個商品編碼的字符長度為【1，128】
2、條目個數(shù)限制為【1，50】
示例值：['123321','456654']

不可核銷商品編碼

unavailable_items

array

否

該字段暫未開放
包含指定SKU商品編碼的交易不可核銷/使用代金券。
校驗規(guī)則：
1、單個商品編碼的字符長度為【1，128】
2、條目個數(shù)限制為【1，50】
示例值：['789987','56765']

可用商戶號

available_merchants

array

是

可用商戶的交易才可核銷/使用代金券。當營銷經(jīng)費no_cash=false時，可用商戶允許填入任何類型的特約商戶或普通商戶
當營銷經(jīng)費no_cash=true時，分為以下幾種情況：
1、創(chuàng)建商戶是普通商戶或服務商特約商戶(子商戶)：可添加本商戶號或同品牌商戶。
說明：若可用商戶中，有特約商戶(子商戶)，那么特約商戶自己發(fā)起的交易、以及服務商幫特約商戶發(fā)起的交易，都可以使用代金券。
2、創(chuàng)建商戶是普通服務商：可添加已授權的子商戶，詳見《申請免充值代金券產(chǎn)品權限》。
說明：特約商戶如果有多個服務商，那么服務商為他發(fā)起的交易，只要完成了免充值授權，都可以使用代金券；特約商戶自己發(fā)起的交易不可以使用代金券。
3、創(chuàng)建商戶是渠道商、銀行服務商或從業(yè)機構：可直接添加旗下任意子商戶，不需要子商戶授權。
校驗規(guī)則：條目個數(shù)限制為【1，50】
示例值：['9856000','9856111']

營銷經(jīng)費

no_cash

bool

是

body 營銷經(jīng)費。枚舉值：
true：免充值
false：預充值
1、免充值：制券方無需提前充值資金，用戶核銷代金券時，直接從訂單原價中扣除優(yōu)惠減價金額，最終只將用戶實際支付的金額結算給核銷商戶，商戶實收少于訂單原價。
2、預充值：制券方需將優(yōu)惠預算提前充值到微信支付商戶可用余額中，用戶核銷代金券時，系統(tǒng)從制券方商戶可用余額中扣除優(yōu)惠減價部分對應的資金，連同用戶實際支付的資金，一并結算給核銷商戶，不影響實收。
示例值：false

批次類型

stock_type

string[1,16]

是

body 批次類型，僅支持：
NORMAL：固定面額滿減券批次
示例值：NORMAL

商戶單據(jù)號

out_request_no

string[1,128]

是

body 商戶創(chuàng)建批次憑據(jù)號（格式：商戶id+日期+流水號），可包含英文字母，數(shù)字，|，_，*，-等內容，不允許出現(xiàn)其他不合法符號，商戶側需保持商戶單據(jù)號全局唯一。
示例值：89560002019101000121

擴展屬性

ext_info

string[1,128]

否

body 擴展屬性字段，按json格式，如無需要則不填寫。
該字段暫未開放
示例值：{'exinfo1':'1234','exinfo2':'3456'}

卡券背景顏色圖

請求示例

JSON


{
	"stock_name": "微信支付代金券批次",
	"comment": "零售批次",
	"belong_merchant": "98568865",
	"available_begin_time": "2015-05-20T13:29:35+08:00",
	"available_end_time": "2015-05-20T13:29:35+08:00",
	"stock_use_rule": {
		"max_coupons": 100,
		"max_amount": 5000,
		"max_amount_by_day": 400,
		"max_coupons_per_user": 3,
		"natural_person_limit": false,
		"prevent_api_abuse": false
	},
	"pattern_info": {
		"description": "微信支付營銷代金券",
		"merchant_logo": "https://qpic.cn/xxx",
		"merchant_name": "微信支付",
		"background_color": "COLOR020",
		"coupon_image": "https://qpic.cn/xxx"
	},
	"coupon_use_rule": {
		
		"fixed_normal_coupon": {
			"coupon_amount": 50,
			"transaction_minimum": 100
		},
		
		"goods_tag": [
			"123321",
			"123322"
		],
		"trade_type": ["OTHER","APPPAY"],
		"combine_use": false,
		"available_items": [
			"123321",
			"123322"
		],
		"available_merchants": [
			"9856000",
			"9856001"
		]
	},
	"no_cash": false,
	"stock_type": "NORMAL",
	"out_request_no": "89560002019101000121"
}

    
｛
JAVA示例代碼
｝

返回參數(shù)

參數(shù)名	變量	類型[長度限制]	必填	描述
批次號	stock_id	string[1,20]	是	微信為每個代金券批次分配的唯一ID。示例值：98065001
創(chuàng)建時間	create_time	string[1,32]	是	創(chuàng)建時間，遵循rfc3339標準格式，格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss表示時分秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領先UTC 8小時，即北京時間）。例如：2015-05-20T13:29:35+08:00表示，北京時間2015年5月20日 13點29分35秒。示例值：2015-05-20T13:29:35.+08:00

返回示例

正常示例


{
  "stock_id": "98065001",
  "create_time": "2015-05-20T13:29:35+08:00"

}


    http://2323weixin.qq.com

錯誤碼公共錯誤碼

狀態(tài)碼	錯誤碼	描述	解決方案
400	PARAM_ERROR	回調url不能為空	請?zhí)顚懟卣{url
	PARAM_ERROR	回調商戶不能為空	請?zhí)顚懟卣{商戶
	PARAM_ERROR	券id必填	請?zhí)顚懭痠d
	PARAM_ERROR	appid必填	請輸入appid
	PARAM_ERROR	openid必填	請輸入openid
	PARAM_ERROR	頁大小超過閾值	請不要超過最大的頁大小
	PARAM_ERROR	輸入時間格式錯誤	請輸入正確的時間格式
	PARAM_ERROR	批次號必填	請輸入批次號
	PARAM_ERROR	商戶號必填	請輸入商戶號
	PARAM_ERROR	非法的批次狀態(tài)	請檢查批次狀態(tài)
400	MCH_NOT_EXISTS	商戶號不合法	請輸入正確的商戶號
400	INVALID_REQUEST	openid與appid不匹配	請使用appid下的openid
	INVALID_REQUEST	活動已結束或未激活	請檢查批次狀態(tài)
	INVALID_REQUEST	非法的商戶號	請檢查商戶號是否正確
400	APPID_MCHID_NOT_MATCH	商戶號與appid不匹配	請綁定調用接口的商戶號和appid后重試
403	USER_ACCOUNT_ABNORMAL	用戶非法	該用戶賬號異常，無法領券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。
403	NOT_ENOUGH	批次預算不足	請補充預算
403	REQUEST_BLOCKED	調用商戶無權限	請開通產(chǎn)品權限后再調用該接口
	REQUEST_BLOCKED	商戶無權發(fā)券	調用接口的商戶號無權發(fā)券，請檢查是否是自己的批次或是已授權的批次。
	REQUEST_BLOCKED	批次不支持跨商戶發(fā)券	該批次未做跨商戶號的授權，請授權后再發(fā)放
	REQUEST_BLOCKED	用戶被限領攔截	用戶領取已經(jīng)達到上限，請調高上限或停止發(fā)放。
404	RESOURCE_NOT_EXISTS	批次不存在	請檢查批次ID是否正確
429	FREQUENCY_LIMIT_EXCEED	接口限頻	請降低調用頻率
403	NO_AUTH	你配置的信息需要開通特殊權限	請參考：QA方案
403	REQUEST_BLOCKED	活動未開始或已結束	該活動未開始或已結束

视频一区二区三区自拍_千金肉奴隷1985未删减版在线观看_国产成人黄色视频在线播放_少女免费播放片高清在线观看_国产精品v欧美精品v

微信支付商戶平臺

創(chuàng)建代金券批次API

接口說明

請求參數(shù)

請求示例

返回參數(shù)

返回示例

錯誤碼公共錯誤碼