微信参数集合

微信请求参数

参数 中文名 类型 必填 最大长度 说明
sub_appid 子商户公众账号ID String N 32 微信分配的子商户公众账号ID,可在支付完成后获取。若不传则取商户配置中sub_appid
sub_openid 用户子标识 String N 128 用户在主商户appid下的唯一标识。(微信JS支付、小程序支付此参数必传)
device_info 设备号 String N 32 自定义参数,可以为终端设备号(门店号或收银设备ID),PC网页或公众号内支付可以传”WEB”
detail 商品详情 JSON N 6000 商品详细描述,对于使用单品优惠的商户,改字段必须按照规范上传”,参见 微信商品详情
attach 附加数据 String N 127 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
goods_tag 订单优惠标记 String N 32 订单优惠标记,代金券或立减优惠功能的参数
scene_Info 场景信息 JSON N 256 该字段常用于线下活动时的场景信息上报,支持上报实际门店信息,商户也可以按需求自己上报相关信息。该字段为JSON对象数据, 对象格式为{“store_info”:{“id”“:”门店ID”,”name”:”名称”,”area_code”:”编码”,”address”:”地址”}},参见 微信场景信息
identity 实名信息 JSON N 不限 详见下表,示例值:{“type”:”IDCARD”,”number”:”111111111111”,”name”:”张三”},参见 微信实名信息

微信实名信息

参数 中文名 类型 必填 最大长度 说明
type 类型 String N 32  
number 证件号 String N 32  
name 姓名 String N 32  

微信商品详情

参数 中文名 类型 必填 最大长度 说明
cost_price 订单原价 int N   1.商户侧一张小票订单可能被分多次支付,订单原价用于记录整张小票的交易金额。2.当订单原价与支付金额不相等,则不享受优惠。 3.该字段主要用于防止同一张小票分多次支付,以享受多次优惠的情况,正常支付订单不必上传此参数。
receipt_id 商品小票ID String N 32 商家小票ID
goods_detail 单品列表 JSONArray Y   单品信息,使用Json数组格式提交,参考 微信单品信息

微信单品信息

参数 中文名 类型 必填 最大长度 说明
goods_id 商品编码 String Y 32 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成
wxpay_goods_id 微信侧商品编码 String N 32 微信支付定义的统一商品编号(没有可不传)
goods_name 商品名称 String Y 256 商品的实际名称
quantity 商品数量 int Y   用户购买的数量
price 商品单价 String Y 32 单位为:元。如果商户有优惠,需传输商户优惠后的单价 例如:用户对一笔100元的订单使用了商场发的纸质优惠券100-50 则活动商品的单价应为原单价-50

微信场景信息

参数 中文名 类型 必填 最大长度 说明
id 门店id String N 32 门店编号,由商户自定义
name 门店名称 String N 64 门店名称,由商户自定义
area_code 门店行政区划码 String N 6 门店所在地行政区划码,参见 地区编码
address 门店详细地址 String N 128 门店详细地址,由商户自定义

微信返回的异步响应报文内容

参数 中文名 类型 必填 最大长度 说明
sub_appid 子商户公众账号ID String N 32 微信分配的子商户公众账号ID
openid 用户标识 String Y 128 用户在商户appid下的唯一标识
sub_openid 用户子标识 String N 128 用户在子商户appid下的唯一标识
bank_type 付款银行 String Y 16 银行类型,采用字符串类型的银行标识,银行类型见附表
cash_fee 现金支付金额 int N   现金支付金额订单现金支付金额
coupon_fee 代金券金额 String N   代金券或立减优惠金额<=订单总金额,订单总金额-代金券或立减优惠金额=现金支付金额
attach 商家数据包 String N 128 商家数据包,原样返回
promotion_detail 营销详情列表 JSONArray N 6000 营销详情列表,使返回值为Json格式上传version时有此字段, 参见 微信营销详情列表

微信营销详情列表

参数 中文名 类型 必填 最大长度 说明
promotion_id 券或者立减优惠id String Y 32 券或者立减优惠id
name 优惠名称 String N 64 优惠名称
scope 优惠范围 String N 32 GLOBAL- 全场代金券 SINGLE- 单品优惠
type 优惠类型 String N 32 COUPON- 代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致) DISCOUNT- 优惠券,不走结算资金的免充值型优惠券, (境外商户券币种与标价币种一致
amount 优惠券面额 String Y 5 用户享受优惠的金额
activity_id 活动ID String Y 32 在微信商户后台配置的批次ID
merchant_contribute 商户出资 String N 32 特指商户自己创建的优惠,出资金额等于本项优惠总金额
other_contribute 其他出资 String N 32 其他出资方出资金额
goods_detail 单品列表 JSON N 3000 单品信息,使用Json格式,每个单品信息参见 微信返回单品信息

微信返回单品信息

参数 中文名 类型 必填 最大长度 说明
goods_id 商品编码 String Y 32 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成
goods_remark 商品备注 String N 32 goods_remark为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置。
discount_amount 商品优惠金额 String Y 32 单品的总优惠金额,单位为:元
quantity 商品数量 String Y 32 用户购买的数量
price 商品单价 String Y 32 单位为:元。如果商户有优惠,需传输商户优惠后的单价 例如:用户对一笔100元的订单使用了商场发的纸质优惠券100-50 则活动商品的单价应为原单价-50