微理財與玖富小金票介面對接專案文件
微理財與玖富小金票介面對接需求說明書
| 版本 |
日期 |
作者 |
審批 |
| V1.3 |
2015-03-25 |
姚國亮 |
|
文件修訂記錄
| 版本編號 |
變化狀態 |
簡要說明 |
日期 |
變更人 |
批准日期 |
批准人 |
| V1.0 |
A |
新建 | 2015.1.21 |
姚國亮 |
|
|
| V1.2 |
M |
評審修改後定稿 |
2015.1.26 |
姚國亮 |
|
|
| V1.3 |
M |
1、完善產品查詢、使用者所有訂單查詢、購買支付等介面。 2、增加欄位必填項說明，增加欄位長度限制。 |
2015.3.25 |
熊學傑 |
2015.3.25 |
姚國亮 |
| V1.4 |
M |
1、完善產品查詢介面。 |
2015.3.26 |
姚國亮 |
|
|
注：變化狀態：A—增加，M—修改，D—刪除
目錄
1.概述
通過微理財的行業客戶資源和行業的資源優勢，基於玖富小金票P2P平臺，通過微理財APP應用為玖富小金票提供理財產品的宣傳和營銷服務。
為了實現以上目標，需要對根據目前P2P行業的業務操作模式，由小金票為微理財提供接入介面，滿足微理財客戶端的使用者理財、查詢和兌付需求，提供統一開放的對外接入介面。
1.1.目的
定義微理財APP應用和玖富小金票的業務流程和介面規範。
1.2範圍
本次功能僅涉及理財產品接入服務。
2.介面需求
2.1使用者註冊
2.1.1業務描述
使用者在微理財APP應用上註冊或登入後，如果使用者需要購買玖富微理財產品，需要通過使用者註冊實時介面在小金票系統進行使用者資訊註冊，傳輸資料包括使用者標識、使用者名稱、手機號、身份證資訊，小金票系統接收到資料後，根據使用者的資訊進行判斷使用者是否已經註冊。如果已經註冊，直接返回小金票系統的使用者標識和成功標識；如果註冊失敗，直接返回失敗標識和訊息。
2.1.1業務流程
2.2購買支付
2.2.1業務描述
使用者在微理財選擇玖富小金票產品後，直接輸入購買金額，通過購買充值介面提交小金票使用者ID、產品ID、到期處理方式、購買金額資訊，小金票介面接收到資料包後生成待確認訂單狀態，同時通過聯動快捷支付介面進行手機端支付，聯動支付成功後，通過介面引數ret_url通知手機端是否成功狀態，通過引數notify_url通知小金票系統修改訂單狀態。如果支付成功，修改訂單狀態為持有中；如果失敗，修改訂單狀態為失敗，完成購買支付流程。
2.2.2業務流程
2.3收益查詢
2.3.1業務描述
使用者登陸微理財後，在使用者中心會顯示使用者的收益資訊。微理財APP通過收益查詢介面傳送使用者對應的小金票使用者標識，系統返回郵箱、手機、到賬資金、在途資金、預期收益、已賺取收益等資訊，微理財收到使用者收益資料後，在使用者中心進行展示。
2.3.2業務流程
2.4訂單查詢
2.4.1業務描述
使用者登陸微理財後，在使用者中心會顯示使用者的訂單資訊，微理財APP通過訂單查詢介面傳送使用者對應的小金票使用者標識，系統返回型別、預期收益、投資金額、數量、歷史投資金額等資訊，微理財收到使用者訂單資料後，在使用者中心進行展示。
2.4.2業務流程
3.介面規範
3.1.資料包格式規範
3.1.1.請求資料包格式規範
請求資料包目前都是封裝成物件資料資訊進行傳遞。
例子： com.weiyinpiao.entity.WypOrder
3.1.2.正常響應資料包格式規範
響應資料包的格式目前支援兩種格式。一種是返回list資料，list資料包中封裝了返回資料物件資訊；另一種是直接返回實體物件資料資訊。
例子：
java.util.List<Object>、com.weiyinpiao.common.wobaifu.entity.LianLianPayInfo
3.1.3.異常響應資料包格式規範
異常響應資料都統一封裝成異常響應資料物件。此異常響應資料物件中包含了具體的響應碼和響應資訊。
3.2.資料格式定義
3.2.1使用者註冊
| 引數名 |
型別 |
長度 |
必輸(Y)/非必輸(N) |
描述 |
| mobile |
String |
11 |
Y |
使用者手機號 |
| custSource |
int |
4 |
Y |
客戶來源(1-小金票2-沃百富 3-微理財) |
| nickName |
String |
50 |
N |
暱稱 |
| realName |
String |
50 |
N |
真實姓名 |
| password |
String |
50 |
Y |
使用者密碼 |
| headImgUrl |
String |
250 |
N |
頭像路徑 |
| sex |
String |
1 |
N |
性別 |
| idCardNo |
String |
18 |
Y |
身份證號 |
| |
String |
80 |
N |
郵箱 |
| bankId |
String |
50 |
N |
銀行id |
| bankName |
String |
120 |
N |
開戶行名稱 |
| bankCardNo |
String |
120 |
N |
已繫結銀行卡號 |
| isReal |
String |
1 |
Y |
實名認證標記 |
| isHaveAccount |
String |
1 |
N |
賬務存在標記 |
| moneyAmount |
Decimal |
(10,2) |
N |
金額 |
| createTime |
Date |
|
N |
建立時間 |
| updateTime |
Date |
|
N |
更新時間 |
| referId |
int |
20 |
N |
推薦人id |
| isDel |
String |
1 |
Y |
刪除標記 |
| inviteNum |
int |
20 |
N |
邀請人數量 |
| extraProfit |
Decimal |
(12,2) |
N |
額外收益率 |
| extraProfitTerm |
int |
11 |
N |
額外收益率期限 |
| freeLogin |
String |
1 |
N |
免登陸標記 |
| openId |
String |
250 |
N |
微信openid |
| wbfUserId |
String |
50 |
N |
|
3.2.1.2.返回引數
| 引數名 |
長度 |
描述 |
| code |
20 |
返回程式碼 |
| message |
200 |
提示訊息 |
| memberId |
20 |
小金票使用者ID |
3.2.2產品查詢
3.2.2.2請求引數
| 引數名 |
型別 |
長度 |
必輸(Y)/非必輸(N) |
描述 |
| productId |
int |
20 |
N |
票據ID |
| ProdStatus |
String |
1 |
N |
產品狀態 |
| consumer |
int |
4 |
N |
售賣方 |
| currentPage |
String |
|
N |
當前頁數 |
| pageSize |
String |
|
N |
每頁記錄數 |
| piaojuNo |
String |
30 |
N |
票號 |
| productIssue |
String |
100 |
N |
產品期號 |
3.2.2.3返回引數
| 引數名 |
長度 |
描述 |
| Code |
20 |
返回程式碼 |
| Message |
200 |
返回訊息 |
| product_id |
20 |
產品id |
| product_name |
50 |
產品名稱 |
| product_issue |
100 |
產品期號 |
| piaoju_no |
120 |
票號 |
| Total |
12 |
理財金額 |
| par_face_value |
12 |
票面金額 |
| accept_bank |
128 |
承兌銀行 |
| Profit |
10 |
年化收益率 |
| sale_start_time |
20 |
開售時間（時分秒yyyy-MM-dd HH:mm:ss） |
| sale_end_time |
20 |
停售時間（時分秒yyyy-MM-dd HH:mm:ss） |
| maturity_time |
20 |
理財到期日（yyyy-MM-dd） |
| time_long |
3 |
投資期限（天）備註：一般不會超過一年 |
| product_status |
1 |
產品狀態（1-預售，2-發售，3-等待還款，4-結束，5-流標，6-訂單滿額） |
| buy_money |
12 |
產品已申購金額 |
| remain_money |
12 |
可投金額 |
| piaoju_img |
100 |
票據圖片URL |
| currentpage |
12 |
當前頁(從1開始) |
| count |
10 |
產品條數 |
3.2.3購買下單
3.2.3.1請求引數
| 引數名 |
型別 |
長度 |
必輸(Y)/非必輸(N) |
描述 |
| piaojuId |
int |
20 |
Y |
票據ID |
| customerId |
int |
20 |
Y |
客戶ID |
| buyMoney |
decimal |
(12,2) |
Y |
購買金額 |
| extraProfitConnent |
String |
250 |
N |
額外收益原因 |
| extraProfitType |
String |
1 |
N |
額外收益型別 |
| bankId |
String |
50 |
N |
銀行ID |
| bankName |
String |
50 |
N |
銀行名稱 |
| bankAccount |
String |
120 |
Y |
銀行賬號 |
| wbfOrderId |
String |
50 |
N |
|
| resultPay |
String |
50 |
N |
訂單支付結果 |
| cashCouponBasicMoney |
decimal |
(12,2) |
N |
現金券本金 |
| standby1 |
String |
30 |
N |
冗餘欄位1 |
| standby2 |
String |
30 |
N |
冗餘欄位2 |
3.2.3.2返回引數
| 引數名 |
長度 |
描述 |
| id |
20 |
主鍵 |
| orderNo |
50 |
訂單號 |
| orderTime |
Date |
下單時間 |
| customerId |
20 |
客戶ID |
| buyMoney |
(12,2) |
購買金額 |
| piaojuId |
20 |
票據ID |
| startTime |
Date |
開始計息時間 |
| endTime |
Date |
截止計息時間 |
| updateTime |
Date |
更新時間 |
| timeLong |
30 |
期限 |
| timeUnit |
1 |
期限單位 |
| prinInterest |
(10,2) |
到期本金和利息 |
| profit |
(10,6) |
年化收益率 |
| interest |
(10,2) |
到期利息 |
| holdStatus |
1 |
持有狀態 |
| extraProfitRate |
(10,2) |
額外收益率 |
| extraBasicMoney |
(12,2) |
額外本金 |
| extraProfit |
(12,2) |
額外收益 |
| extraProfitConnent |
250 |
額外收益原因 |
| extraProfitType |
1 |
額外收益型別 |
| isAcount |
1 |
是否到賬 |
| isDel |
1 |
刪除標記 |
| payType |
1 |
支付渠道 |
| bankId |
50 |
銀行id |
| bankName |
50 |
銀行名稱 |
| bankAccount |
120 |
訂單交易銀行賬號 |
| wbfOrderId |
50 |
|
| standby1 |
30 |
冗餘欄位1 |
| standby2 |
30 |
冗餘欄位2 |
3.2.4購買支付
3.2.4.1請求引數
| 引數名 |
型別 |
長度 |
必輸(Y)/非必輸(N) |
描述 |
| orderNo |
String |
50 |
Y |
訂單號 |
| customerId |
int |
20 |
Y |
使用者ID |
| piaojuId |
int |
20 |
Y |
票據ID |
3.2.4.2返回引數
| 引數名 |
長度 |
描述 |
| code |
20 |
返回程式碼 |
| message |
200 |
返回訊息 |
| postUrl |
200 |
請求連連支付URL路徑 |
| reqData |
1000 |
請求連連支付URL引數的值;互動方式必須用HTTPS以POST方式請求，請用req_data引數帶json請求引數串. |
3.2.5收益查詢
| 引數名 |
型別 |
長度 |
必填 |
描述 |
| memberId |
String |
20 |
Y |