Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
D documents
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • pass
  • documents
  • Wiki
    • 接口
  • 交易

交易 · Changes

Page history
Update 交易 authored Jun 04, 2019 by 叶佳菲's avatar 叶佳菲
Show whitespace changes
Inline Side-by-side
Showing with 33 additions and 65 deletions
+33 -65
  • 接口/交易.md 接口/交易.md +33 -65
  • No files found.
接口/交易.md
View page @ 69a346c7
[[_TOC_]] [[_TOC_]]
写在前面 # 写在前面
===
- 文中将${seq}定义为参数名为seq的参数,相关的表中有参数描述 - 文中将${seq}定义为参数名为seq的参数,相关的表中有参数描述
- 文中将${timeout*}定义为可选的参数timeout - 文中将${timeout*}定义为可选的参数timeout
...@@ -9,9 +8,36 @@ ...@@ -9,9 +8,36 @@
- 本文中涉及到分页的接口使用skip、limit参数,表示跳过skip行取至多limit行,返回头X-Total-Count参数表示查询总行数 - 本文中涉及到分页的接口使用skip、limit参数,表示跳过skip行取至多limit行,返回头X-Total-Count参数表示查询总行数
- 所有接口使用HTTP状态码200表示成功,其他状态码表示失败,如有特例将在具体接口中说明 - 所有接口使用HTTP状态码200表示成功,其他状态码表示失败,如有特例将在具体接口中说明
# 资源属性描述
接口描述 ### `PAYMENT`结构
===
|参数名|类型|说明|
|:---|:---|:---|
|id|string|服务器订单号|
|seq|string(36)|客户端订单号|
|title|string(128)|订单描述|
|status||订单状态|
||accepted|订单处理中,结果未知,需要继续查询订单状态||
||normal|已支付,就是支付成功,此时钱已经入服务商账户||
||refunding|退款中,结果未知,需要继续查询订单状态||
||refund|部分退款,此时钱部分回到用户账户||
||closed|关闭,此时钱已经回到用户账户||
|status_msg||状态信息,如果有需要输出的时候,例如错误的时候,`有值不代表有错误`|
|create_time|timestamp|订单创建时间戳(毫秒)|
|notify_uri|string|扫码支付时二维码信息|
|account_id|支付通道|见[支持的支付通道定义](#支持的支付通道定义)|
|trade_id|string|业务订单号,如果存在|
|detail|list|明细,如果存在则输出|
| └ tags|list|明细标签组合,这是一个集合,取值不仅限于所列出值,见[支持的标签](#支持的标签)|
| └ card|string|如果是卡支付的话则输出为卡号,非卡支付不输出|
| └ amount|int|实付金额|
| └ balance|int|交易后余额,wallet时给出该值|
| └ time_end(部分渠道输出)|timestamp|支付完成时间|
> 对于接口中出现的资源属性将不再说明
# 接口描述
- 测试环境地址 - 测试环境地址
``` ```
...@@ -55,65 +81,7 @@ Authorization: Bearer ${token} ...@@ -55,65 +81,7 @@ Authorization: Bearer ${token}
} }
``` ```
|参数名|类型|说明| ### R2.查询可用账户
|:---|:---|:---|
|id|string|服务器订单号|
|seq|string(36)|客户端订单号|
|title|string(128)|订单描述|
|status||订单状态|
||accepted|订单处理中,结果未知,需要继续查询订单状态||
||normal|已支付,就是支付成功,此时钱已经入服务商账户||
||refunding|退款中,结果未知,需要继续查询订单状态||
||refund|部分退款,此时钱部分回到用户账户||
||closed|关闭,此时钱已经回到用户账户||
|status_msg||订单信息,如果有需要输出的时候,例如错误的时候|
|create_time|int|支付时间戳(毫秒)|
|notify_uri|string|扫码支付时二维码信息|
|account_id|支付通道|见[支持的支付通道定义](#支持的支付通道定义)|
|trade_id|string|业务订单号,如果存在|
|detail|list|明细,如果存在则输出|
| └ tags|list|明细标签组合,这是一个集合,取值不仅限于所列出值,见[支持的标签](#支持的标签)|
| └ card|string|如果是卡支付的话则输出为卡号,非卡支付不输出|
| └ amount|int|实付金额|
| └ balance|int|交易后余额,wallet时给出该值|
| └ time_end(部分渠道输出)|timestamp|支付完成时间|
### R2.事件总线
> - 查询token所授权终端的订单状态变更事件
```javascript
GET http://${domain}/sovellpay/v2/trade/event
?after=${index*}
&timeout=${timeout*}
&limit=${limit*}
Authorization: Bearer ${token}
```
|参数名|类型|说明|
|:---|:---|:---|
|limit|int|返回最大条数,默认100|
|index|int|初始是为0,之后的调用使用每次结果中的index|
|其他||见[其他请求参数说明](#其他请求参数说明)|
- 返回`PAYMENT`数组,返回参数定义同`R1.查询交易单`
```javascript
[{
"id": ${id},
"status": ${status},
"create_time": ${create_timestamp},
"title": ${title},
"goods": ${goods*},
"account_id": ${account_id*},
"notify_uri": ${notify_uri},
"seq": ${seq},
"index": ${index},
"trade_id": ${trade_id*}
}...]
```
### R3.查询可用账户
```javascript ```javascript
GET http://${domain}/sovellpay/v2/accounts GET http://${domain}/sovellpay/v2/accounts
...@@ -269,7 +237,7 @@ Content-Type: application/json ...@@ -269,7 +237,7 @@ Content-Type: application/json
|refund ${amount}|退款指定金额(分)(例如 refund 1)| |refund ${amount}|退款指定金额(分)(例如 refund 1)|
|refund *|全额退款| |refund *|全额退款|
- 返回同 `R1.查询交易单` - 返回 `PAYMENT`结构
- 错误返回 - 错误返回
...@@ -293,7 +261,7 @@ DELETE http://${domain}/sovellpay/v2/trade/${seq}?sign=${sign} ...@@ -293,7 +261,7 @@ DELETE http://${domain}/sovellpay/v2/trade/${seq}?sign=${sign}
Authorization: Bearer ${token} Authorization: Bearer ${token}
``` ```
- 返回同 `R1.查询交易单` - 返回 [`PAYMENT`结构](#PAYMENT结构)
- 错误返回 - 错误返回
......
Clone repository
  • Home
  • 接口
    • 交易
    • 消息
    • 用户
    • 通用券
  • 渠道
    • 微信 1基本参数
    • 微信 2商户平台配置
    • 微信 3公众号参数
    • 微信 4公众平台配置
    • 微信(服务商方式)
    • 支付宝 1基本参数
    • 支付宝 2公钥上传
    • 支付宝(服务商方式)