API接口文档 有需要办理408544的,可联系微信:vpsdawanjia

简介

API接口文档

host

https://api.vpsdawanjia.com

接口统计信息

GET
12
POST
2
DELETE
1

1、登录

账号登出
GET /api-uaa/oauth/remove/token
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
access_tokenaccess_tokenquerytrue
string
响应状态
状态码
说明
schema
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
No Data

No Data

响应示例
账号密码登录
GET /api-uaa/oauth/token
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
AuthenticationAuthorizationfalse
string
grant_typepassword_codefalse
string
passwordpasswordfalse
string
usernameusernamefalse
string
响应状态
状态码
说明
schema
200
OK
Result«OAuth2AccessToken»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
dataOAuth2AccessTokenOAuth2AccessToken
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"access_token": "访问令牌",
		"expires_in": "access_token有效期,单位s",
		"refresh_token": "刷新令牌",
		"tokenHead": "访问令牌头前缀"
	},
	"message": "",
	"success": true
}
刷新token
POST /api-uaa/oauth/token
请求数据类型
[ "application/json" ]
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
AuthorizationAuthorizationfalse
string
grant_typerefresh_tokenfalse
string
refresh_tokenrefresh_tokenfalse
string
响应状态
状态码
说明
schema
200
OK
Result«OAuth2AccessToken»
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
dataOAuth2AccessTokenOAuth2AccessToken
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"access_token": "访问令牌",
		"expires_in": "access_token有效期,单位s",
		"refresh_token": "刷新令牌",
		"tokenHead": "访问令牌头前缀"
	},
	"message": "",
	"success": true
}

2、用户管理

根据access_token当前登录用户
GET /api-center/user/current
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
No Data

No Data

响应状态
状态码
说明
schema
200
OK
Result«user对象»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
datauser对象user对象
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"companyPhoneNumber": "公司电话",
		"firstName": "姓",
		"lastName": "名",
		"registeredBusinessName": "注册商家名称",
		"roleCompanyBelow": "公司的角色",
		"username": "用户名"
	},
	"message": "",
	"success": true
}

3、企业管理

查询当前用户的企业信息
GET /api-center/businessInfo/getByBusinessInfo
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
No Data

No Data

响应状态
状态码
说明
schema
200
OK
Result«企业信息管理»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
data企业信息管理企业信息管理
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"birthDate": "出生年月",
		"businessAddressCity": "城市",
		"businessAddressState": "州",
		"businessAddressZip": "邮编",
		"businessStreetAddress": "地址",
		"businessToken": "企业token",
		"businessType": "企业类型",
		"city": "城市",
		"companyPhoneNumber": "公司号码",
		"firstName": "名",
		"homeAddress": "家庭地址",
		"lastName": "姓",
		"legalRegisteredBusinessName": "企业名称",
		"phoneNumber": "联系号码",
		"state": "州",
		"streetAddress": "街道地址",
		"zip": "邮编"
	},
	"message": "",
	"success": true
}

4、企业资料

查询
GET /api-center/businessFile/getById
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
ididquerytrue
string
响应状态
状态码
说明
schema
200
OK
Result«企业信息管理»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
data企业信息管理企业信息管理
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"birthDate": "出生年月",
		"businessAddressCity": "城市",
		"businessAddressState": "州",
		"businessAddressZip": "邮编",
		"businessStreetAddress": "地址",
		"businessToken": "企业token",
		"businessType": "企业类型",
		"city": "城市",
		"companyPhoneNumber": "公司号码",
		"firstName": "名",
		"homeAddress": "家庭地址",
		"lastName": "姓",
		"legalRegisteredBusinessName": "企业名称",
		"phoneNumber": "联系号码",
		"state": "州",
		"streetAddress": "街道地址",
		"zip": "邮编"
	},
	"message": "",
	"success": true
}
查询当前用户的企业资料
GET /api-center/businessFile/getBySysBusinessFile
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
No Data

No Data

响应状态
状态码
说明
schema
200
OK
Result«企业信息管理»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
data企业信息管理企业信息管理
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"birthDate": "出生年月",
		"businessAddressCity": "城市",
		"businessAddressState": "州",
		"businessAddressZip": "邮编",
		"businessStreetAddress": "地址",
		"businessToken": "企业token",
		"businessType": "企业类型",
		"city": "城市",
		"companyPhoneNumber": "公司号码",
		"firstName": "名",
		"homeAddress": "家庭地址",
		"lastName": "姓",
		"legalRegisteredBusinessName": "企业名称",
		"phoneNumber": "联系号码",
		"state": "州",
		"streetAddress": "街道地址",
		"zip": "邮编"
	},
	"message": "",
	"success": true
}

5、卡管理

创建单张虚拟卡
POST /api-center/card/createCard
请求数据类型
[ "application/json" ]
响应数据类型
[ "*/*" ]
请求示例
{
	"addressNotes": "addressNotes",
	"billingAddress": "billingAddress",
	"birthDate": "2021-05-15",
	"city": "city",
	"email": "email",
	"firstName": "firstName",
	"lastName": "lastName",
	"limitAmount": "limitAmount 必须>=10",
	"limitMonth": "1,2,3,4,5,6,7,8,9,10,11,12 (其中一项即可)",
	"phone": "000-000-0000",
	"state": "AL,AK,AZ,AR,CA,CO,CT,DE,FL,GA,HI,ID,IL,IN,IA,KS,KY,LA,ME,MD,MA,MI,MN,MS,MO,MT,NE,NV,NH,NJ,NM,NY,NC,ND,OH,OK,OR,PA,RI,SC,SD,TN,TX,UT,VT,VA,WA,WV,WI,WY (其中一项即可)",
	"zip": "zip"
}
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
dtocard对象bodytrue
card对象
card对象
响应状态
状态码
说明
schema
200
OK
Result
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
dataobject
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {},
	"message": "",
	"success": true
}
删除单张卡
DELETE /api-center/card/delete
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
ididquerytrue
string
响应状态
状态码
说明
schema
200
OK
Result
204
No Content
401
Unauthorized
403
Forbidden
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
dataobject
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {},
	"message": "",
	"success": true
}
根据cardToken查询卡信息
GET /api-center/card/findBusinessCardByCardToken
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
cardToken卡tokenquerytrue
string
响应状态
状态码
说明
schema
200
OK
Result«Card对象»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
dataCard对象Card对象
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"businessId": "企业ID",
		"cardNumber": "卡号",
		"cardNumberLastFour": "卡号后四位数",
		"cardToken": "卡Token",
		"cardType": "卡类型",
		"createTime": "创建时间",
		"endDate": "有效结束时间",
		"firstName": "姓",
		"id": "id",
		"lastName": "名",
		"limitMonth": "有效时长(月)",
		"starDate": "有效起始时间",
		"status": "状态 0-正常 1-已暂停 2-删除",
		"surplusLimitAmount": "卡余额"
	},
	"message": "",
	"success": true
}
根据id查询卡
GET /api-center/card/getById
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
ididquerytrue
string
响应状态
状态码
说明
schema
200
OK
Result«Card对象»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
dataCard对象Card对象
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"businessId": "企业ID",
		"cardNumber": "卡号",
		"cardNumberLastFour": "卡号后四位数",
		"cardToken": "卡Token",
		"cardType": "卡类型",
		"createTime": "创建时间",
		"endDate": "有效结束时间",
		"firstName": "姓",
		"id": "id",
		"lastName": "名",
		"limitMonth": "有效时长(月)",
		"starDate": "有效起始时间",
		"status": "状态 0-正常 1-已暂停 2-删除",
		"surplusLimitAmount": "卡余额"
	},
	"message": "",
	"success": true
}
查询客户所有卡
GET /api-center/card/list
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
current分页起始位置querytrue
ref
pageSize分页结束位置querytrue
ref
响应状态
状态码
说明
schema
200
OK
Result«Card对象»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
dataCard对象Card对象
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"businessId": "企业ID",
		"cardNumber": "卡号",
		"cardNumberLastFour": "卡号后四位数",
		"cardToken": "卡Token",
		"cardType": "卡类型",
		"createTime": "创建时间",
		"endDate": "有效结束时间",
		"firstName": "姓",
		"id": "id",
		"lastName": "名",
		"limitMonth": "有效时长(月)",
		"starDate": "有效起始时间",
		"status": "状态 0-正常 1-已暂停 2-删除",
		"surplusLimitAmount": "卡余额"
	},
	"message": "",
	"success": true
}

6、卡流水记录

客户所有流水记录
GET /api-center/funds/list
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
current分页起始位置querytrue
ref
pageSize分页结束位置querytrue
ref
createTime_begin开始时间queryfalse
string
createTime_end结束时间queryfalse
string
响应状态
状态码
说明
schema
200
OK
Result«Funds对象»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
dataFunds对象Funds对象
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"amount": "金额",
		"balance": "账户余额",
		"businessId": "企业ID",
		"description": "说明",
		"initiated": "时间",
		"status": "状态 Completed/Failed/Pending",
		"type": "类型 Credit/Debit"
	},
	"message": "",
	"success": true
}

7、账单管理

卡token查询账单列表
GET /api-center/bill/cardTransactionActivity
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
cardToken卡tokenquerytrue
string
响应状态
状态码
说明
schema
200
OK
Result«bill对象»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
databill对象bill对象
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"businessToken": "企业token",
		"cardName": "卡名称",
		"cardNumber": "卡号",
		"cardToken": "卡token",
		"merchantAddress": "商家地址",
		"merchantName": "商家名称",
		"reason": "交易说明",
		"status": "交易状态 COMPLETE/PENDING/REVERSED/DECLINED",
		"transactionAmount": "交易金额",
		"transactionTime": "交易时间",
		"transactionToken": "交易token",
		"type": "交易类型 authorization/refund/foreign transaction fee"
	},
	"message": "",
	"success": true
}
用户查询账单列表
GET /api-center/bill/list
请求数据类型
响应数据类型
[ "*/*" ]
请求参数
参数名称
参数说明
请求类型
是否必须
数据类型
schema
current分页起始位置querytrue
ref
pageSize分页结束位置querytrue
ref
响应状态
状态码
说明
schema
200
OK
Result«bill对象»
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
codeinteger(int32)integer(int32)
databill对象bill对象
messagestring
successboolean
响应示例
{
	"code": 0,
	"data": {
		"businessToken": "企业token",
		"cardName": "卡名称",
		"cardNumber": "卡号",
		"cardToken": "卡token",
		"merchantAddress": "商家地址",
		"merchantName": "商家名称",
		"reason": "交易说明",
		"status": "交易状态 COMPLETE/PENDING/REVERSED/DECLINED",
		"transactionAmount": "交易金额",
		"transactionTime": "交易时间",
		"transactionToken": "交易token",
		"type": "交易类型 authorization/refund/foreign transaction fee"
	},
	"message": "",
	"success": true
}