147 lines
2.1 KiB
Markdown
147 lines
2.1 KiB
Markdown
# 支付集成模块接口文档
|
|
|
|
## 模块概述
|
|
支付集成模块提供金币充值、订单创建、支付处理等功能。
|
|
|
|
---
|
|
|
|
## 接口列表
|
|
|
|
### 1. 获取充值选项列表
|
|
|
|
**接口路径**: `GET /api/front/gift/recharge/options`
|
|
|
|
**请求参数**: 无
|
|
|
|
**返回参数**:
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"msg": "success",
|
|
"data": [
|
|
{
|
|
"id": "选项ID",
|
|
"coinAmount": 金币数量,
|
|
"price": 价格,
|
|
"discountLabel": "优惠标签"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
### 2. 创建充值订单
|
|
|
|
**接口路径**: `POST /api/front/gift/recharge/create`
|
|
|
|
**请求头**:
|
|
```
|
|
Authorization: Bearer {token}
|
|
```
|
|
|
|
**请求参数**:
|
|
```json
|
|
{
|
|
"optionId": "选项ID",
|
|
"coinAmount": 金币数量,
|
|
"price": 价格
|
|
}
|
|
```
|
|
|
|
**返回参数**:
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"msg": "success",
|
|
"data": {
|
|
"orderId": "订单ID",
|
|
"paymentUrl": "支付URL"
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
### 3. 订单支付
|
|
|
|
**接口路径**: `POST /api/front/pay/payment`
|
|
|
|
**请求头**:
|
|
```
|
|
Authorization: Bearer {token}
|
|
```
|
|
|
|
**请求参数**:
|
|
```json
|
|
{
|
|
"orderNo": "订单号",
|
|
"payType": "支付类型",
|
|
"payChannel": "支付渠道",
|
|
"from": "android"
|
|
}
|
|
```
|
|
|
|
**payType说明**:
|
|
- alipay: 支付宝支付
|
|
- weixin: 微信支付
|
|
- yue: 余额支付
|
|
|
|
**payChannel说明**:
|
|
- appAliPay: 支付宝APP支付
|
|
- weixinAppAndroid: 微信APP支付(Android)
|
|
- yue: 余额支付
|
|
|
|
**返回参数**:
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"msg": "success",
|
|
"data": {
|
|
"status": true,
|
|
"payType": "支付类型",
|
|
"orderNo": "订单号",
|
|
"jsConfig": {
|
|
"appId": "应用ID",
|
|
"partnerId": "商户ID",
|
|
"prepayId": "预支付ID",
|
|
"package": "扩展字段",
|
|
"nonceStr": "随机字符串",
|
|
"timeStamp": "时间戳",
|
|
"sign": "签名"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
**说明**: jsConfig用于调用支付SDK
|
|
|
|
---
|
|
|
|
### 4. 查询支付宝支付结果
|
|
|
|
**接口路径**: `GET /api/front/pay/alipay/queryPayResult`
|
|
|
|
**请求头**:
|
|
```
|
|
Authorization: Bearer {token}
|
|
```
|
|
|
|
**请求参数**:
|
|
```
|
|
orderNo: 订单号
|
|
```
|
|
|
|
**返回参数**:
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"msg": "success",
|
|
"data": true
|
|
}
|
|
```
|
|
|
|
**data说明**:
|
|
- true: 支付成功
|
|
- false: 支付失败或未支付
|