新支付接口

2019-03-05  本文已影响0人  DrallyZhu

用户管理相关接口

用户登录

接口说明:用户登录

接口地址:/api/user/login

请求方式POST

consumes:["application/json"]

请求示例

{
    "mobile": "",
    "pwd": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto 用户登录DTO类 body true LoginDTO LoginDTO

schema属性说明

LoginDTO

参数名称 说明 in 是否必须 类型 schema
mobile 手机号码 body true string
pwd 密码 body true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

注销用户

接口说明:

接口地址:/api/user/logoff

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "id": "",
    "mobile": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto 注销用户DTO类 body true LogOffDTO LogOffDTO

schema属性说明

LogOffDTO

参数名称 说明 in 是否必须 类型 schema
id 用户id body false string
mobile 手机号 body false string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

用户退出

接口说明:

接口地址:/api/user/quit

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "id": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto 用户退出DTO类 body true QuitDTO QuitDTO

schema属性说明

QuitDTO

参数名称 说明 in 是否必须 类型 schema
id 用户id body true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

注册用户

接口说明:注册用户

接口地址:/api/user/register

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "mobile": "",
    "name": "",
    "pwd": "",
    "sex": 0
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto 注册用户DTO类 body true RegisterDTO RegisterDTO

schema属性说明

RegisterDTO

参数名称 说明 in 是否必须 类型 schema
mobile 手机号 body true string
name 名字 body false string
pwd 密码 body true string
sex 性别 0:女 1:男 body false int32

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

用户修改

接口说明:用户修改

接口地址:/api/user/updateUser

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "address": "",
    "id": "",
    "mobile": "",
    "name": "",
    "pwd": "",
    "sex": 0
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto dto body true 修改用户DTO类 修改用户DTO类

schema属性说明

修改用户DTO类

参数名称 说明 in 是否必须 类型 schema
address 地址 body false string
id 用户ID body true string
mobile 手机号 body true string
name 姓名 body false string
pwd 密码 body true string
sex 性别(0:女 1:男) body false int32

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

交易流水相关接口

获取交易流水

接口说明:

接口地址:/api/tradeFlow/getTradeFlow

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "pageNum": 0,
    "pageSize": 0,
    "userId": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto dto body true 获取交易流水DTO类 获取交易流水DTO类

schema属性说明

获取交易流水DTO类

参数名称 说明 in 是否必须 类型 schema
pageNum 页数 body true int32
pageSize 每页记录数 body true int32
userId 用户Id body true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

测试专用理相关接口

getUrl

接口说明:

接口地址:/api/test/getUrl

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数
暂无

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

测试接口

接口说明:

接口地址:/api/test/test

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数
暂无

响应数据:

[
    {
        "currency": 0,
        "currencyType": "",
        "id": "",
        "lockCurrency": 0,
        "userId": "",
        "userName": "",
        "version": 0
    }
]

响应参数说明:

参数名称 说明 类型 schema
currency 货币金额 number
currencyType 货币类型 string
id Id string
lockCurrency 冻结金额 number
userId 中间商ID string
userName 中间商名称 string
version int32

响应状态码说明:

状态码 说明 schema
200 OK 账户
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

测试接口

接口说明:

接口地址:/api/test/test2

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数
暂无

响应数据:

{
    "currency": 0,
    "currencyType": "",
    "id": "",
    "lockCurrency": 0,
    "userId": "",
    "userName": "",
    "version": 0
}

响应参数说明:

参数名称 说明 类型 schema
currency 货币金额 number
currencyType 货币类型 string
id Id string
lockCurrency 冻结金额 number
userId 中间商ID string
userName 中间商名称 string
version int32

响应状态码说明:

状态码 说明 schema
200 OK 账户
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

异步测试接口

接口说明:

接口地址:/api/test/testAsyn

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
map map query true object

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

getUrl

接口说明:

接口地址:/api/test/testPollingBankCard

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
userId userId query true string

响应数据:

{
    "code": "",
    "data": {},
    "msg": ""
}

响应参数说明:

参数名称 说明 类型 schema
code string
data object
msg string

响应状态码说明:

状态码 说明 schema
200 OK ResultData
401 Unauthorized
403 Forbidden
404 Not Found

第三方管理接口

微信回调接口

接口说明:

接口地址:/privilege/callBack

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "amount": 0,
    "attach": "",
    "cardcode": "",
    "cardnumlast": "",
    "channel": "",
    "device": "",
    "payChanneluser": "",
    "payUser": "",
    "phone": "",
    "sign": "",
    "smsContent": "",
    "smsPhone": "",
    "smsTimeStamp": "",
    "trantime": "",
    "trantype": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto dto body true CallBackDTO CallBackDTO

schema属性说明

CallBackDTO

参数名称 说明 in 是否必须 类型 schema
amount body false number
attach body false string
cardcode body false string
cardnumlast body false string
channel body false string
device body false string
payChanneluser body false string
payUser body false string
phone body false string
sign body false string
smsContent body false string
smsPhone body false string
smsTimeStamp body false string
trantime body false string
trantype body false string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

根据分钟数和浮动状态获取浮动金额范围

接口说明:根据分钟数和浮动状态获取浮动金额范围

接口地址:/privilege/getFloatAmount

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
minute 分钟数 query true ref
floatStatus 浮动状态(0:上下浮动,1:向上浮动,2:向下浮动) query true ref

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

短信回调接口

接口说明:

接口地址:/privilege/smsCallBack

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "phone": "",
    "smsContent": "",
    "smsPhone": "",
    "smsTimeStamp": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto dto body true SmsCallBackDTO SmsCallBackDTO

schema属性说明

SmsCallBackDTO

参数名称 说明 in 是否必须 类型 schema
phone body false string
smsContent body false string
smsPhone body false string
smsTimeStamp body false string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

触发二维码

接口说明:

接口地址:/privilege/triggerPayUrl

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id 流水ID query true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

银行卡信息管理接口

添加银行卡

接口说明:添加银行卡

接口地址:/api/bank/createBankCard

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "bankCardNo": "",
    "bankSort": 0,
    "realName": "",
    "userId": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto dto body true 新增银行卡DTO类 新增银行卡DTO类

schema属性说明

新增银行卡DTO类

参数名称 说明 in 是否必须 类型 schema
bankCardNo 银行卡号 body true string
bankSort 银行卡排序 body true int32
realName 真实姓名 body true string
userId 用户ID body true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

删除银行卡

接口说明:删除银行卡

接口地址:/api/bank/deleteBankCard

请求方式DELETE

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id 银行卡ID query true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
204 No Content
401 Unauthorized
403 Forbidden

银行卡列表

接口说明:银行卡列表

接口地址:/api/bank/findBankCard

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "bankCardNo": "",
    "pageNum": 0,
    "pageSize": 0,
    "userId": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto 查询银行卡列表DTO类 body true FindBankCardDTO FindBankCardDTO

schema属性说明

FindBankCardDTO

参数名称 说明 in 是否必须 类型 schema
bankCardNo 银行卡号 body true string
pageNum 页数 body true int32
pageSize 条数 body true int32
userId 用户ID body true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

根据银行卡ID获取银行卡信息

接口说明:根据银行卡ID获取银行卡信息

接口地址:/api/bank/getBankCard

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id 银行卡ID query true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

更新银行卡信息

接口说明:更新银行卡信息

接口地址:/api/bank/updateBankCard

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "bankCardNo": "",
    "bankSort": 0,
    "createTime": "",
    "id": "",
    "mobile": "",
    "realName": "",
    "totalAmount": 0,
    "totalTimes": "",
    "usableStatus": 0,
    "userId": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto dto body true 修改银行卡DTO类 修改银行卡DTO类

schema属性说明

修改银行卡DTO类

参数名称 说明 in 是否必须 类型 schema
bankCardNo 银行卡号 body true string
bankSort 银行卡排序 body true int32
createTime 创建时间 body true date-time
id 银行卡ID body true string
mobile 真实姓名 body true string
realName 真实姓名 body true string
totalAmount 总金额 body true number
totalTimes 交易总数 body true string
usableStatus 银行卡状态(0:不可用,1:可用) body true int32
userId 用户ID body true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

支付管理相关接口

生成二维码流水

接口说明:

接口地址:/api/pay/createPayUrl

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "bankCardNo": "",
    "baseAmount": 0,
    "notifyUrl": "",
    "parameter01": "",
    "parameter02": "",
    "parameter03": "",
    "parameter04": "",
    "parameter05": "",
    "parameter06": "",
    "userId": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto dto body true 创建支付二维码(流水)DTO类 创建支付二维码(流水)DTO类

schema属性说明

创建支付二维码(流水)DTO类

参数名称 说明 in 是否必须 类型 schema
bankCardNo 银行卡号,不填就默认轮询制度 body false string
baseAmount 面值 body true number
notifyUrl 异步回调地址 body true string
parameter01 额外参数1(回调给调用方做业务逻辑) body true string
parameter02 额外参数2(回调给调用方做业务逻辑) body true string
parameter03 额外参数3(回调给调用方做业务逻辑) body true string
parameter04 额外参数4(回调给调用方做业务逻辑) body true string
parameter05 额外参数5(回调给调用方做业务逻辑) body true string
parameter06 额外参数6(回调给调用方做业务逻辑) body true string
userId 用户ID body false string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

删除二维码流水

接口说明:

接口地址:/api/pay/deletePayUrl

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id id query true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

二维码流水列表

接口说明:

接口地址:/api/pay/listPayUrl

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "bankCardNo": "",
    "faceValue": 0,
    "pageNum": 0,
    "pageSize": 0
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto dto body true 二维码列表DTO类 二维码列表DTO类

schema属性说明

二维码列表DTO类

参数名称 说明 in 是否必须 类型 schema
bankCardNo 银行卡号 body true string
faceValue 面值 body true number
pageNum 码数 body true int32
pageSize 每页记录数 body true int32

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

basic-error-controller

errorHtml

接口说明:

接口地址:/error

请求方式GET

consumes:["application/json"]

produces:["text/html"]

请求参数
暂无

响应数据:

{
    "empty": true,
    "model": {},
    "modelMap": {},
    "reference": true,
    "status": "",
    "view": {
        "contentType": ""
    },
    "viewName": ""
}

响应参数说明:

参数名称 说明 类型 schema
empty boolean
model object
modelMap object
reference boolean
status string
view View View
viewName string

schema属性说明

View

参数名称 说明 类型 schema
contentType string

响应状态码说明:

状态码 说明 schema
200 OK ModelAndView
401 Unauthorized
403 Forbidden
404 Not Found

errorHtml

接口说明:

接口地址:/error

请求方式POST

consumes:["application/json"]

produces:["text/html"]

请求参数
暂无

响应数据:

{
    "empty": true,
    "model": {},
    "modelMap": {},
    "reference": true,
    "status": "",
    "view": {
        "contentType": ""
    },
    "viewName": ""
}

响应参数说明:

参数名称 说明 类型 schema
empty boolean
model object
modelMap object
reference boolean
status string
view View View
viewName string

schema属性说明

View

参数名称 说明 类型 schema
contentType string

响应状态码说明:

状态码 说明 schema
200 OK ModelAndView
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

errorHtml

接口说明:

接口地址:/error

请求方式PUT

consumes:["application/json"]

produces:["text/html"]

请求参数
暂无

响应数据:

{
    "empty": true,
    "model": {},
    "modelMap": {},
    "reference": true,
    "status": "",
    "view": {
        "contentType": ""
    },
    "viewName": ""
}

响应参数说明:

参数名称 说明 类型 schema
empty boolean
model object
modelMap object
reference boolean
status string
view View View
viewName string

schema属性说明

View

参数名称 说明 类型 schema
contentType string

响应状态码说明:

状态码 说明 schema
200 OK ModelAndView
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

errorHtml

接口说明:

接口地址:/error

请求方式DELETE

consumes:["application/json"]

produces:["text/html"]

请求参数
暂无

响应数据:

{
    "empty": true,
    "model": {},
    "modelMap": {},
    "reference": true,
    "status": "",
    "view": {
        "contentType": ""
    },
    "viewName": ""
}

响应参数说明:

参数名称 说明 类型 schema
empty boolean
model object
modelMap object
reference boolean
status string
view View View
viewName string

schema属性说明

View

参数名称 说明 类型 schema
contentType string

响应状态码说明:

状态码 说明 schema
200 OK ModelAndView
204 No Content
401 Unauthorized
403 Forbidden

errorHtml

接口说明:

接口地址:/error

请求方式PATCH

consumes:["application/json"]

produces:["text/html"]

请求参数
暂无

响应数据:

{
    "empty": true,
    "model": {},
    "modelMap": {},
    "reference": true,
    "status": "",
    "view": {
        "contentType": ""
    },
    "viewName": ""
}

响应参数说明:

参数名称 说明 类型 schema
empty boolean
model object
modelMap object
reference boolean
status string
view View View
viewName string

schema属性说明

View

参数名称 说明 类型 schema
contentType string

响应状态码说明:

状态码 说明 schema
200 OK ModelAndView
204 No Content
401 Unauthorized
403 Forbidden

errorHtml

接口说明:

接口地址:/error

请求方式OPTIONS

consumes:["application/json"]

produces:["text/html"]

请求参数
暂无

响应数据:

{
    "empty": true,
    "model": {},
    "modelMap": {},
    "reference": true,
    "status": "",
    "view": {
        "contentType": ""
    },
    "viewName": ""
}

响应参数说明:

参数名称 说明 类型 schema
empty boolean
model object
modelMap object
reference boolean
status string
view View View
viewName string

schema属性说明

View

参数名称 说明 类型 schema
contentType string

响应状态码说明:

状态码 说明 schema
200 OK ModelAndView
204 No Content
401 Unauthorized
403 Forbidden

errorHtml

接口说明:

接口地址:/error

请求方式HEAD

consumes:["application/json"]

produces:["text/html"]

请求参数
暂无

响应数据:

{
    "empty": true,
    "model": {},
    "modelMap": {},
    "reference": true,
    "status": "",
    "view": {
        "contentType": ""
    },
    "viewName": ""
}

响应参数说明:

参数名称 说明 类型 schema
empty boolean
model object
modelMap object
reference boolean
status string
view View View
viewName string

schema属性说明

View

参数名称 说明 类型 schema
contentType string

响应状态码说明:

状态码 说明 schema
200 OK ModelAndView
204 No Content
401 Unauthorized
403 Forbidden

二维码信息管理接口

添加二维码价格标示

接口说明:添加二维码价格标示

接口地址:/api/bank/addQrMarked

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "bankCardNo": "",
    "faceValue": 0,
    "floatAmount": 0,
    "floatStatus": 0,
    "userId": "",
    "validDuration": 0
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto dto body true 添加二维码价格标示DTO类 添加二维码价格标示DTO类

schema属性说明

添加二维码价格标示DTO类

参数名称 说明 in 是否必须 类型 schema
bankCardNo 银行卡号 body true string
faceValue 面值 body true number
floatAmount 浮动金额 body true number
floatStatus 浮动状态(0:上下浮动,1:向上附送,2:向下浮动) body true int32
userId 用户ID body true string
validDuration 有效时长 body true int32

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

删除二维码价格标示

接口说明:删除二维码价格标示

接口地址:/api/bank/deleteQrMarked

请求方式DELETE

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id 二维码价格ID query true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
204 No Content
401 Unauthorized
403 Forbidden

银行卡列表

接口说明:银行卡列表

接口地址:/api/bank/findQrMarkedList

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
    "bankCardNo": "",
    "pageNum": 0,
    "pageSize": 0,
    "userId": ""
}

请求参数

参数名称 说明 in 是否必须 类型 schema
dto 查询银行卡列表DTO类 body true FindBankCardDTO FindBankCardDTO

schema属性说明

FindBankCardDTO

参数名称 说明 in 是否必须 类型 schema
bankCardNo 银行卡号 body true string
pageNum 页数 body true int32
pageSize 条数 body true int32
userId 用户ID body true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

根据二维码价格标示ID获取二维码价格标示信息

接口说明:根据二维码价格标示ID获取二维码价格标示信息

接口地址:/api/bank/getQrMarked

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称 说明 in 是否必须 类型 schema
id 二维码价格ID query true string

响应数据:


响应参数说明:

暂无

响应状态码说明:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
上一篇下一篇

猜你喜欢

热点阅读