API_BASE_URL_PREFIX
API_BASE_URL_PREFIX = 'https://api.weixin.qq.com'
API接口URL需要使用此前缀
微信卡卷
createCardQrcode(string $card_id, string $code = '', string $openid = '', integer $expire_seconds, boolean $is_unique_code = false, string $balance = '') : boolean|string
生成卡券二维码 成功则直接返回ticket值,可以用 getQRUrl($ticket) 换取二维码url
string | $card_id | 卡券ID 必须 |
string | $code | 指定卡券 code 码,只能被领一次。use_custom_code 字段为 true 的卡券必须填写,非自定义 code 不必填写。 |
string | $openid | 指定领取者的 openid,只有该用户能领取。bind_openid 字段为 true 的卡券必须填写,非自定义 openid 不必填写。 |
integer | $expire_seconds | 指定二维码的有效时间,范围是 60 ~ 1800 秒。不填默认为永久有效。 |
boolean | $is_unique_code | 指定下发二维码,生成的二维码随机分配一个 code,领取后不可再次扫描。填写 true 或 false。默认 false。 |
string | $balance | 红包余额,以分为单位。红包类型必填(LUCKY_MONEY),其他卡券类型不填。 |
consumeCardCode(string $code, string $card_id = '') : boolean|array
消耗 code 自定义 code(use_custom_code 为 true)的优惠券,在 code 被核销时,必须调用此接口。
string | $code | 要消耗的序列号 |
string | $card_id | 要消耗序列号所述的 card_id,创建卡券时use_custom_code 填写 true 时必填。 |
{ "errcode":0, "errmsg":"ok", "card":{"card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc"}, "openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA" }
checkCardCode(string $code) : boolean|array
查询 code 的有效性(非自定义 code)
string | $code |
{ "errcode":0, "errmsg":"ok", "openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA", //用户 openid "card":{ "card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc", "begin_time": 1404205036, //起始使用时间 "end_time": 1404205036, //结束时间 } }
getCardIdList(integer $offset, integer $count = 50) : boolean|array
批量查询卡列表
integer | $offset | 开始拉取的偏移,默认为0从头开始 |
integer | $count | 需要查询的卡片的数量(数量最大50,默认50) |
{ "errcode":0, "errmsg":"ok", "card_id_list":["ph_gmt7cUVrlRk8swPwx7aDyF-pg"], //卡 id 列表 "total_num":1 //该商户名下 card_id 总数 }
updateCardCode(string $code, string $card_id, string $new_code) : boolean
更改 code 为确保转赠后的安全性,微信允许自定义code的商户对已下发的code进行更改。 注:为避免用户疑惑,建议仅在发生转赠行为后(发生转赠后,微信会通过事件推送的方式告知商户被转赠的卡券code)对用户的code进行更改。
string | $code | 卡券的 code 编码 |
string | $card_id | 卡券 ID |
string | $new_code | 新的卡券 code 编码 |
setSelfconsumecell(string $card_id, boolean $is_openid = false, boolean $need_verify_cod = false, boolean $need_remark_amount = false) : boolean|array
设置自助核销接口
string | $card_id | 卡券ID |
boolean | $is_openid | 是否开启自助核销功能,填true/false,默认为false |
boolean | $need_verify_cod | 用户核销时是否需要输入验证码,填true/false,默认为false |
boolean | $need_remark_amount | 用户核销时是否需要备注核销金额,填true/false,默认为false |