参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
access_token | access_token | query | true | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|
No Data
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
Authentication | Authorization | false | string | ||
grant_type | password_code | false | string | ||
password | password | false | string | ||
username | username | false | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«OAuth2AccessToken» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | OAuth2AccessToken | OAuth2AccessToken | |
message | string | ||
success | boolean |
{ "code": 0, "data": { "access_token": "访问令牌", "expires_in": "access_token有效期,单位s", "refresh_token": "刷新令牌", "tokenHead": "访问令牌头前缀" }, "message": "", "success": true }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
Authorization | Authorization | false | string | ||
grant_type | refresh_token | false | string | ||
refresh_token | refresh_token | false | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«OAuth2AccessToken» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | OAuth2AccessToken | OAuth2AccessToken | |
message | string | ||
success | boolean |
{ "code": 0, "data": { "access_token": "访问令牌", "expires_in": "access_token有效期,单位s", "refresh_token": "刷新令牌", "tokenHead": "访问令牌头前缀" }, "message": "", "success": true }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|
No Data
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«user对象» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | user对象 | user对象 | |
message | string | ||
success | boolean |
{ "code": 0, "data": { "companyPhoneNumber": "公司电话", "firstName": "姓", "lastName": "名", "registeredBusinessName": "注册商家名称", "roleCompanyBelow": "公司的角色", "username": "用户名" }, "message": "", "success": true }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|
No Data
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«企业信息管理» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | 企业信息管理 | 企业信息管理 | |
message | string | ||
success | boolean |
{ "code": 0, "data": { "birthDate": "出生年月", "businessAddressCity": "城市", "businessAddressState": "州", "businessAddressZip": "邮编", "businessStreetAddress": "地址", "businessToken": "企业token", "businessType": "企业类型", "city": "城市", "companyPhoneNumber": "公司号码", "firstName": "名", "homeAddress": "家庭地址", "lastName": "姓", "legalRegisteredBusinessName": "企业名称", "phoneNumber": "联系号码", "state": "州", "streetAddress": "街道地址", "zip": "邮编" }, "message": "", "success": true }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
id | id | query | true | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«企业信息管理» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | 企业信息管理 | 企业信息管理 | |
message | string | ||
success | boolean |
{ "code": 0, "data": { "birthDate": "出生年月", "businessAddressCity": "城市", "businessAddressState": "州", "businessAddressZip": "邮编", "businessStreetAddress": "地址", "businessToken": "企业token", "businessType": "企业类型", "city": "城市", "companyPhoneNumber": "公司号码", "firstName": "名", "homeAddress": "家庭地址", "lastName": "姓", "legalRegisteredBusinessName": "企业名称", "phoneNumber": "联系号码", "state": "州", "streetAddress": "街道地址", "zip": "邮编" }, "message": "", "success": true }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|
No Data
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«企业信息管理» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | 企业信息管理 | 企业信息管理 | |
message | string | ||
success | boolean |
{ "code": 0, "data": { "birthDate": "出生年月", "businessAddressCity": "城市", "businessAddressState": "州", "businessAddressZip": "邮编", "businessStreetAddress": "地址", "businessToken": "企业token", "businessType": "企业类型", "city": "城市", "companyPhoneNumber": "公司号码", "firstName": "名", "homeAddress": "家庭地址", "lastName": "姓", "legalRegisteredBusinessName": "企业名称", "phoneNumber": "联系号码", "state": "州", "streetAddress": "街道地址", "zip": "邮编" }, "message": "", "success": true }
{ "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 |
---|---|---|---|---|---|
dto | card对象 | body | true | card对象 | card对象 |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
message | string | ||
success | boolean |
{ "code": 0, "data": {}, "message": "", "success": true }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
id | id | query | true | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result |
204 | No Content | |
401 | Unauthorized | |
403 | Forbidden |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
message | string | ||
success | boolean |
{ "code": 0, "data": {}, "message": "", "success": true }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
cardToken | 卡token | query | true | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«Card对象» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | Card对象 | Card对象 | |
message | string | ||
success | boolean |
{ "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 }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
id | id | query | true | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«Card对象» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | Card对象 | Card对象 | |
message | string | ||
success | boolean |
{ "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 }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
current | 分页起始位置 | query | true | ref | |
pageSize | 分页结束位置 | query | true | ref |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«Card对象» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | Card对象 | Card对象 | |
message | string | ||
success | boolean |
{ "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 }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
current | 分页起始位置 | query | true | ref | |
pageSize | 分页结束位置 | query | true | ref | |
createTime_begin | 开始时间 | query | false | string | |
createTime_end | 结束时间 | query | false | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«Funds对象» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | Funds对象 | Funds对象 | |
message | string | ||
success | boolean |
{ "code": 0, "data": { "amount": "金额", "balance": "账户余额", "businessId": "企业ID", "description": "说明", "initiated": "时间", "status": "状态 Completed/Failed/Pending", "type": "类型 Credit/Debit" }, "message": "", "success": true }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
cardToken | 卡token | query | true | string |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«bill对象» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | bill对象 | bill对象 | |
message | string | ||
success | boolean |
{ "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 }
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
current | 分页起始位置 | query | true | ref | |
pageSize | 分页结束位置 | query | true | ref |
状态码 | 说明 | schema |
---|---|---|
200 | OK | Result«bill对象» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | bill对象 | bill对象 | |
message | string | ||
success | boolean |
{ "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 }