ADD - api 文档

api.md

+# 小赢backend接口文档
+
+
+## 接口列表
+
+- 银行列表 `pay/installment/xiaoying/banks`
+- 省市列表 `pay/installment/xiaoying/cities`
+- 计算分期金额 `pay/installment/xiaoying/calc`
+- 注册并实名认证 `pay/installment/xiaoying/register`
+- 用户信息填写 `pay/installment/xiaoying/userinfo`
+- 绑定代扣银行卡预校验 `pay/installment/xiaoying/check_bank`
+- 绑定银行卡 `pay/installment/xiaoying/bind_bank`
+- 申请借款 `pay/installment/xiaoying/loan`
+- 查询借款状态 `pay/installment/xiaoying/status`
+- 补充审核资料 `pay/installment/xiaoying/replenish`
+- 退款或放弃贷款 `pay/installment/xiaoying/refund`
+
+
+### 1. 银行列表
+
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/banks`
+
+#### 请求参数
+``` javascript
+{
+}
+```
+
+#### 返回值
+```javascript
+{
+    "ICBC": {
+        id: 1,
+        code: "ICBC",
+        name: "中国工商银行",
+        phone: "95588",
+        icon: "http://....",
+        description: "单笔限额5万, 日限额10万",
+        created_time: "2016-07-01 11:34:09"
+    },
+    ...
+}
+```
+
+
+### 2. 省市列表
+
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/cities`
+
+#### 请求参数
+``` javascript
+{
+}
+```
+
+#### 返回值
+```javascript
+{
+    "安徽省": [
+        "安庆市",
+        ...
+    ],
+    ...
+}
+```
+
+
+### 3. 计算分期金额
+
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/calc`
+
+#### 请求参数
+``` javascript
+{
+    'service_id': 11243,                // 美购id
+    'amount': 110000,                   // 借款金额 单位 分
+}
+```
+
+#### 返回值
+```javascript
+{
+    6: {
+        total: 211530,                  // 应还总额
+        period_pay: 35255,              // 每期应还
+    },
+    12: {
+        total: 221748,                  // 应还总额
+        period_pay: 18479,              // 每期应还
+    }
+}
+```
+
+
+### 4. 注册并实名认证
+
+#### 请求方式
+
+    > `pay/installment/xiaoying/register`
+
+#### 请求参数
+``` javascript
+{
+    name: "***",                        // 姓名
+    id_card: "****....",                // 身份证号
+    phone: "18899990000",
+    password: "123456",
+}
+```
+
+### 返回值
+```javascript
+{
+}
+```
+
+
+### 5. 用户信息填写
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/userinfo`
+
+#### 请求参数
+``` javascript
+{
+    name: "***",
+    gender: "男",                       // 男, 女
+    age: 23,
+    education: '本科',
+    province: "安徽省",
+    city: "安庆市",
+    district: "我也不知道哪个区, 随便填",
+    address: "....",
+    immediate_family_name: '***',
+    immediate_family_relation: "父子"
+    immediate_family_phone: '19888394455',
+    contact_name: '***',
+    contect_relation: "朋友"
+    contact_phone: '19888394455',
+    id_card_front: 'http://gmei......',         // 身份证正面
+    id_card_back: 'http://gmei......',          // 身份证背面
+    id_card_hold: 'http://gmei......',          // 身份证手持照
+}
+```
+
+#### 返回值
+```javascript
+{
+}
+```
+
+
+### 6. 绑定代扣银行卡预校验
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/check_bank`
+
+#### 请求参数
+``` javascript
+{
+    name: "***",                            // 持卡人
+    bank_code: "ICBC",
+    bank_district: "北京朝阳",
+    card: '62193....',                      // 银联储蓄卡号
+    phone: "18823334455",                   // 银行预留手机号
+}
+```
+
+#### 返回值
+```javascript
+{
+    ticket: '2233344334',                   // 验证凭证
+}
+```
+
+### 7. 绑定银行卡
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/bind_bank`
+
+#### 请求参数
+``` javascript
+{
+    sms_code: '123123',                     // 手机收到的验证码
+}
+```
+
+#### 返回值
+```javascript
+{
+}
+```
+
+
+
+### 8. 申请借款
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/loan`
+
+#### 请求参数
+``` javascript
+{
+    order_id: 23344455,                     // 订单id
+    periods: 6,                             // 期数
+}
+```
+
+#### 返回值
+```javascript
+{
+    loan_id: 1234455,                       // 借款协议号
+}
+```
+
+
+### 9. 查询借款状态
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/status`
+
+#### 请求参数
+``` javascript
+{
+    order_id: 123441123,
+}
+```
+
+#### 返回值
+```javascript
+{
+    order_id: 1234455,
+    status: 1,                                  // 0:待提交审核 10:待风控审核 50:审核通过 60:审核拒绝 70:待补件 100:借款成功 120:放款失败
+    description: '审核结果的简要描述',
+    supply_code: 1,                             // 补件编码, 待补件状态才有补件编码
+    /*
+        1 身份证正面照缺失
+        2 身份证正面照不清晰
+        3 身份证反面照缺失
+        4 身份证反面照不清晰
+        5 手持身份证照片缺失
+        6 手持身份证照片不清晰
+    */
+}
+```
+
+### 10. 补充审核资料
+
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/replenish`
+
+#### 请求参数
+``` javascript
+{
+    id_card_front: 'http://gmei......',         // 身份证正面
+    id_card_back: 'http://gmei......',          // 身份证背面
+    id_card_hold: 'http://gmei......',          // 身份证手持照
+}
+```
+
+#### 返回值
+```javascript
+{
+}
+```
+
+### 11. 退款或放弃贷款
+
+
+#### 请求方式
+    
+    > `pay/installment/xiaoying/refund`
+
+#### 请求参数
+``` javascript
+{
+    order_id: 12332211,
+}
+```
+
+#### 返回值
+```javascript
+{
+}
+```