企业商户查询企业支付额度卡
更新时间:2025.04.29企业商户查询企业支付额度卡。该接口允许服务商查询指定员工的企业支付额度卡详情,包括卡片金额、可用金额、有效期、使用记录等信息。企业可通过此接口了解额度卡的使用情况,进行费用追踪和报销管理。
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/webizpay/employees/{employee_id}/quota-cards/{card_no}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
card_no 必填 string
【企业支付额度卡卡号】 企业支付额度卡卡号,微信支付平台生成的唯一标识额度卡的编号。通过创建卡和查询卡返回。
employee_id 必填 string
【微信授权关系 ID】 微信授权关系ID,微信支付平台生成的唯一标识授权关系的ID,用户注册时会回调商户获取微信授权关系ID或者商户通过企业下唯一的员工ID查询企业支付员工接口获得。
query 查询参数
sp_mchid 必填 string
【服务商商户号】 是由微信支付系统生成并分配给每个服务商的唯一标识符,具体请参考服务商模式开发必要参数说明。
sub_mchid 必填 string
【出资子商户号】 由服务商为子商户进件后获取,具体请参考服务商模式开发必要参数说明。
请求示例
GET
应答参数
200 OK
sp_mchid 必填 string
【服务商商户号】 服务商商户号,具有企业支付服务商资质的微信支付商户号
sub_mchid 必填 string
【出资子商户号】 出资子商户号,企业支付的出资方商户号
card_no 必填 string
【企业支付额度卡卡号】 企业支付额度卡卡号,微信支付平台生成的唯一标识额度卡的编号
out_card_no 必填 string
【商户卡号】 商户卡号,由商户系统生成的唯一标识额度卡的编号
employee_id 必填 string
【微信授权关系 ID】 微信授权关系ID,微信支付平台生成的唯一标识授权关系的ID
card_template_id 必填 string
【企业支付卡模板ID】 企业支付卡模板ID,额度卡使用的模板ID,决定卡片的使用规则、退款规则等。可以咨询微信支付了解卡模板ID对应规则
card_rule 必填 string
【使用规则】 单次使用/多次使用,卡模板中配置项
可选取值
SINGLE
: 单次使用MULTIPLE
: 多次使用
refund_rule 必填 string
【退款规则】 退款规则,描述额度卡的退款策略 退回:'RETURN'不退回:'NOT_RETURN'
可选取值
RETURN
: 退款后返回卡NOT_RETURN
: 退款后不返回卡
amount 必填 integer
【卡片总金额】 卡片总金额,单位为分,整型。示例:1元应填写 100
remain_amount 必填 integer
【卡片可用金额】 卡片可用金额,单位为分,整型。示例:1元应填写 100
effective_end_time 必填 string
【卡片有效期】 卡片有效期,额度卡失效的时间,超过此日期的卡无法被使用,无法获得卡片的微信支付跳转链接。
遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE
。yyyy-MM-DD
表示年月日;T
字符用于分隔日期和时间部分;HH:mm:ss
表示具体的时分秒;TIMEZONE
表示时区(例如,+08:00
对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00
表示北京时间2015年5月20日13点29分35秒。
effective_begin_time 必填 string
【卡片生效时间】 卡片生效时间,额度卡开始生效的时间。
遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE
。yyyy-MM-DD
表示年月日;T
字符用于分隔日期和时间部分;HH:mm:ss
表示具体的时分秒;TIMEZONE
表示时区(例如,+08:00
对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00
表示北京时间2015年5月20日13点29分35秒。
card_state 必填 string
【卡片状态】 卡片状态,表示额度卡当前的状态,包括生效(ACTIVE)和失效(DISABLED)两种状态
可选取值
ACTIVE
: 生效DISABLED
: 失效
card_name 必填 string
【卡片名称】 卡片名称,企业自定义的额度卡名称,用于标识额度卡用途。由商户下发额度卡是传入。
reason 选填 string
【失效原因】 失效原因,说明额度卡失效的原因,如'有效期结束'、'管理员作废'等
card_usage_time 选填 string
【卡片使用时间】 卡片使用时间,最近一次使用额度卡进行支付的时间。
对单次卡来说,为第一次支付的时间,此后卡片过期。
对多次卡来说,为最后一次支付的时间。
若卡片没被使用,则没有这个字段返回
遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE
。yyyy-MM-DD
表示年月日;T
字符用于分隔日期和时间部分;HH:mm:ss
表示具体的时分秒;TIMEZONE
表示时区(例如,+08:00
对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00
表示北京时间2015年5月20日13点29分35秒。
transaction_id 选填 string
【卡片关联微信支付订单号】 卡片关联微信支付订单号,最近一次使用该额度卡支付产生的微信支付交易单号。
若卡片没被使用,则没有这个字段返回
card_disabled_time 选填 string
【卡片失效时间】 卡片失效时间,额度卡变为失效状态的时间。
若卡片仍在生效,则没有这个字段返回。
例如:单次卡被使用、单次卡到期、多次卡被使用、多次卡到期、单次卡被作废、多次卡被作废。 卡片失效时间表示上述的某一个最先到达的状态的时间。
遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE
。yyyy-MM-DD
表示年月日;T
字符用于分隔日期和时间部分;HH:mm:ss
表示具体的时分秒;TIMEZONE
表示时区(例如,+08:00
对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00
表示北京时间2015年5月20日13点29分35秒。
card_remark 选填 string
【卡片备注】 卡片备注,额度卡的补充说明信息。由商户下发额度卡时传入。
应答示例
200 OK
错误码
公共错误码