# 应用钱包
能力申请：发送邮件到zeldaliang@tencent.com进行申请，申请时需提供业务方资料和使用场景。
# 创建小钱包
# 接口描述
用于为主体创建小钱包
# 请求方法
POST(application/json)
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/create-wallet?access_token=access_token
# 参数说明
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 |
# 响应说明
{
"code": 0,
"message": "ok",
"data": {}
}
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 |
| message | 是 | String | ok | 状态描述信息 |
| data | 是 | Object | {} | 这里固定为空对象 |
# 用户账户发放补贴钱包
# 接口描述
为用户账户发放补贴钱包
# 请求方法
POST(application/json)
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/wallet-issue?access_token=access_token
# 参数说明
{
"bill_no": "1234567890abcdef",
"list": "[{\"card_number\":\"51447\",\"name\":\"陈小东\",\"amt\":1001}]"
}
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 | |
| bill_no | 是 | String | 1234567890abcdef | 订单号,防重,16字节以内 |
| list | 是 | String | 发放用户列表，需进行encode处理 |
其中list中包含的子项数据结构如下：
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| card_number | 是 | String | 51447 | 用户卡号 |
| name | 是 | String | 陈小东 | 用户姓名，需要与卡号匹配 |
| amt | 是 | Integer | 1001 | 发放金额，单位为分，此处代表10.01元 |
# 响应说明
{
"code": 0,
"message": "ok",
"data": {
"id": 1001
}
}
| 参数 | 必填 | 类型 | 实例 | 说明 | |
|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | |
| message | 是 | String | ok | 状态描述信息 | |
| data | id | 是 | Integer | 1001 | 发放任务id，任务异步进行，成功后进行通知 |
# 清零用户账户
# 接口描述
将用户账户进行清零处理
# 请求方法
POST(application/json)
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/wallet-clear?access_token=access_token
# 参数说明
{
"clear_type": 0,
"bill_no": "1234567890abcdef",
"list": "[\"51447\"]"
}
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 | |
| clear_type | 是 | Integer | 0 | 清空类型，0:清空当前主体所有账户余额，1:清空list中账号余额 |
| bill_no | 是 | String | 1234567890abcdef | 订单号,防重,16字节以内 |
| list | 否 | String | "[\"51447\"]" | 清空用户卡号列表，需encode处理 |
# 响应说明
{
"code": 0,
"message": "ok",
"data": {
"id": 1001
}
}
| 参数 | 必填 | 类型 | 实例 | 说明 | |
|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | |
| message | 是 | String | ok | 状态描述信息 | |
| data | id | 是 | Integer | 1001 | 发放任务id，任务异步进行，成功后进行通知 |
# 主体账户充值
# 接口描述
为主体账户进行充值
# 请求方法
POST(application/json)
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/wallet-recharge?access_token=access_token
# 参数说明
{
"bill_no": "123456789abcdef",
"amt": 1001
}
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 | |
| bill_no | 是 | String | 1234567890abcdef | 订单号,防重,16字节以内 |
| amt | 是 | Integer | 1001 | 充值金额，单位为分，此处为10.01元 |
# 响应说明
{
"code": 0,
"message": "ok",
"data": {
"balance": 1001
}
}
| 参数 | 必填 | 类型 | 实例 | 说明 | |
|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | |
| message | 是 | String | ok | 状态描述信息 | |
| data | balance | 是 | Integer | 1001 | 主体账户余额，单位为分，此处为10.01元 |
# 主体账户余额查询
# 接口描述
查询主体账户余额
# 请求方法
GET
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/wallet-balance?access_token=xxx
# 参数说明
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 |
# 响应说明
{
"code": 0,
"message": "ok",
"data": {
"balance": 1001
}
}
| 参数 | 必填 | 类型 | 实例 | 说明 | |
|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | |
| message | 是 | String | ok | 状态描述信息 | |
| data | balance | 是 | Integer | 1001 | 主体账户余额，单位为分，此处为10.01元 |
# 用户余额查询
# 接口描述
查询用户余额
# 请求方法
GET
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/account-balance?acces_token=xxx&card_number=51447
# 参数说明
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 | |
| card_number | 是 | String | 51447 | 用户卡号 |
# 响应说明
{
"code": 0,
"message": "ok",
"data": {
"balance": 1001
}
}
| 参数 | 必填 | 类型 | 实例 | 说明 | |
|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | |
| message | 是 | String | ok | 状态描述信息 | |
| data | balance | 是 | Integer | 1001 | 用户余额，单位为分，此处为10.01元 |
# 用户消费明细查询
# 接口描述
查询用户消费明细
# 请求方法
GET
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/account-records?access_token=xxx&card_number=51447¤t=1&page_size=30
# 参数说明
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 | |
| card_number | 是 | String | 51447 | 查询用户卡号 |
| current | 否 | Integer | 1 | 分页页数 |
| page_size | 否 | Integer | 30 | 分页大小，默认为30，最大值为50 |
# 响应说明
{
"code": 0,
"message": "ok",
"data": [
{
"title": "商家1",
"amount": 1,
"pay_time": "2020-01-19 10:46:11",
"icon": "https://dldir1.qq.com/djt/mnprogram/consume/consume.png",
"merchant_name": "商家1",
"type": 0
}
]
}
| 参数 | 必填 | 类型 | 实例 | 说明 | |
|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | |
| message | 是 | String | ok | 状态描述信息 | |
| current | 是 | Integer | 1 | 分页页数 | |
| page_size | 是 | Integer | 30 | 分页大小 | |
| total | 是 | Integer | 1 | 总数 | |
| data | title | 是 | String | 商家1 | 商家名称 |
| amount | 是 | Integer | 1001 | 消费金额，单位为分，此处为10.01元 | |
| pay_time | 是 | Datetime | 2020-01-19 10:46:11 | 消费时间 | |
| icon | 是 | String | 商家Logo链接 | ||
| merchant_name | 是 | String | 商户1 | 商户名称 | |
| type | 是 | Integer | 0 | 预留字段 | |
# 主体充值/扣费明细
# 接口描述
查询主体账户充值/扣费明细查询
# 请求方法
GET
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/wallet-recharge-detail?access_token=xxx¤t=1&page_size=30
# 参数说明
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 | |
| cure_page | 否 | Integer | 1 | 分页页数 |
| page_size | 否 | Integer | 30 | 分页大小，默认为30，最大值为50 |
# 响应说明
{
"code":0,
"message":"ok",
"data": {
"total": 2,
"list": [
{
"type": 0,
"amt": 10000,
"time": "2020-04-15T16:15:02+08:00",
"note": ""
}
]
}
}
| 参数 | 必填 | 类型 | 实例 | 说明 | ||
|---|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | ||
| message | 是 | String | ok | 状态描述信息 | ||
| data | total | 是 | Integer | 2 | 明细总数 | |
| list | type | 是 | Integer | 0 | 明细类型 | |
| amount | 是 | Integer | 10000 | 充值/扣费金额，单位为分 | ||
| time | 是 | Datetime | 2020-04-15T16:15:02+08:00 | 充值/扣费时间 | ||
| note | 是 | String | 备注 | |||
# 用户账户充值/扣费明细
# 接口描述
查询用户账户充值/扣费明细查询
# 请求方法
GET
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/account-recharge-detail?access_token=xxx&card_number=51447¤t=1&page_size=30
# 参数说明
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 | |
| cure_page | 否 | Integer | 1 | 分页页数 |
| page_size | 否 | Integer | 30 | 分页大小，默认为30，最大值为50 |
# 响应说明
{
"code":0,
"message":"ok",
"data": {
"total": 2,
"list": [
{
"type": 0,
"amt": 10000,
"time": "2020-04-15T16:15:02+08:00",
"note": ""
}
]
}
}
| 参数 | 必填 | 类型 | 实例 | 说明 | ||
|---|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | ||
| message | 是 | String | ok | 状态描述信息 | ||
| data | total | 是 | Integer | 2 | 明细总数 | |
| list | type | 是 | Integer | 0 | 明细类型 | |
| amount | 是 | Integer | 10000 | 充值/扣费金额，单位为分 | ||
| time | 是 | Datetime | 2020-04-15T16:15:02+08:00 | 充值/扣费时间 | ||
| note | 是 | String | 备注 | |||
# 消费接口
# 接口描述
用于进行用户扣费
# 请求方法
POST(application/json)
# 请求地址
https://open.wecard.qq.com/cgi-bin/pay/app-wallet/account-pay?access_token=access_token
# 参数说明
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| access_token | 是 | String | 应用凭证 | |
| card_number | 是 | String | 51447 | 查询用户卡号 |
| name | 是 | String | 陈小东 | 查询用户姓名 |
| bill_no | 是 | String | 1234567890abcdef | 订单号,防重,16字节以内 |
| amt | 是 | Integer | 1001 | 发放金额，单位为分，此处为10.01元 |
# 响应说明
{
"code": 0,
"message": "ok",
"data": {
"id": "wxeewfwsdsadsadsaj"
}
}
| 参数 | 必填 | 类型 | 实例 | 说明 | |
|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | |
| message | 是 | String | ok | 状态描述信息 | |
| data | id | 是 | String | wxeewfwsdsadsadsaj | 订单id |
# 事件通知接收
# 接口描述
用于接收异步任务完成事件通知，需要业务方提供公网地址，业务方需要给予相应的相应
# 请求方法
POST(application/json)
# 请求地址
业务方提供的公网地址
# 参数说明
{
"type": 1,
"id": 1001,
"status": 200,
"message": "fail",
"data": {},
"fail_list": [
{
"card_number":"51447",
"name":"陈小东",
"note":"电子卡号/学工号姓名不匹配"
}
]
}
| 参数 | 必填 | 类型 | 实例 | 说明 | |
|---|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 | |
| message | 是 | String | ok | 状态描述信息 | |
| data | 是 | Object | {} | type为1或2，且status为100时，为空对象 | |
| fail_list | card_number | 是 | String | 51447 | 用户卡号 |
| name | 是 | String | 陈小东 | 用户姓名 | |
| note | 是 | String | 电子卡号/学工号姓名不匹配 | 执行失败信息 | |
# 响应说明
{
"code": 0,
"message": "ok",
"data": {}
}
| 参数 | 必填 | 类型 | 实例 | 说明 |
|---|---|---|---|---|
| code | 是 | Integer | 0 | 状态码，0为成功，非0为错误 |
| message | 是 | String | ok | 状态描述信息 |
| data | 是 | Object | {} | 此处固定为空对象 |