XX 系统
接口文档
XXXX 有限公司
二零一九年一月
修订历史记录
|
日期 |
版本 |
说明 |
作者 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
目 录
1. 引言... 4
1.1. 编写目的... 4
1.2. 读者对象... 4
1.3. 项目背景... 4
1.4. 接口概述... 4
1.5. 参考资料... 4
2. 接口定义... 5
2.1. XX接口... 5
1. 引言
1.1. 编写目的
编写本接口文档的目的是为XX系统的软件开发人员提供接口协议说明，包括数据交换的标准及数据交换的格式、定义及相关约定。
1.2. 读者对象
本接口文档可能的合法读者对象为XX系统的软件开发人员。
1.3. 项目背景
项目名称：XX系统
1.4. 接口概述
本接口采用RESTFUL风格，采用标准的Http Post协议，接口的请求及返回参数都是采用JSON格式。
1.5. 参考资料
XX上的需求文档：
http://122.40.129.106:8080/redmeine/issuacs/145
XX提供的接口文档：
《XX系统接口文档.doc》
2. 接口定义
2.1. XX接口
|
接口名称 |
jzhPay |
||||
|
http请求方式 |
GET/POST |
||||
|
访问url |
http://126.40.129.106:8080/accountSystems/api/jzhPay |
||||
|
功能 |
|
||||
|
说明 |
该交易贷后系统发起，财务发送订单垫付请求后在账户系统内创建网点账户，开户成功后从担保公司账户上转账到请求垫款的网点账户。 |
||||
|
请求参数 |
|||||
|
参数 |
参数说明 |
参数类型 |
是否必填项 |
备注 |
|
|
account |
name |
客户姓名 |
String(20) |
是 |
与银行卡户名一致 |
|
idType |
证件类型 |
Int(2) |
是 |
1:身份证 2：护照 3：军官证 4：其他 |
|
|
idCard |
证件号码 |
String(18) |
是 |
与银行预留的证件号码一致 |
|
|
phone |
手机号码 |
String(11) |
是 |
手机号码为登录ID，用于找回密码和短信服务 |
|
|
type |
账户类型 |
Int(2) |
是 |
1：个人用户 2：企业用户 |
|
|
|
邮箱地址 |
String(50) |
否 |
企业用户为法人邮箱地址 |
|
|
bankAddress |
开户行地址 |
String(150) |
是 |
包括省市，区县和开户行行别 |
|
|
bankName |
开户行支行名称 |
String(30) |
否 |
企业用户为企业开户行支行名称 |
|
|
cardNo |
账号 |
String(20) |
是 |
企业用户为公司对公账号 |
|
|
payPwd |
支付密码 |
String(15) |
否 |
金账户提现时使用 |
|
|
remark |
备注 |
String(60) |
否 |
|
|
|
order |
orderNo |
订单编号 |
String(15) |
是 |
|
|
bondCompanyNo |
担保公司编号 |
Int(3) |
是 |
1：易商 2：泽浩 |
|
|
clientName |
主贷人姓名 |
String(30) |
是 |
|
|
|
clientIdCard |
主贷人身份证号码 |
String(18) |
是 |
|
|
|
spName |
申请网点名称 |
String(50) |
是 |
|
|
|
lendBank |
申请贷款银行 |
String(50) |
否 |
默认为延中工行 |
|
|
loanMonth |
申请贷款期限(月) |
Int(4) |
否 |
|
|
|
loanAmt |
公司垫付金额 |
String[] |
是 |
对于延中工行， |
|
|
carPayAmt |
车款金额 |
String(20) |
否 |
二期开发使用 |
|
|
servicePayAmt |
金融服务费金额 |
String(20) |
否 |
二期开发使用 |
|
|
buyerName |
购车方名称 |
String(30) |
否 |
二期开发使用 |
|
|
buyerIdCard |
购车方证件号 |
String(18) |
否 |
二期开发使用 |
|
|
返回信息 |
|||||
|
code |
返回代码 |
0:成功 其他：失败 |
|||
|
retMsg |
返回信息 |
成功返回“成功”，其他返回对应的错误信息 |
|||
|
参数示例 |
|||||
|
请求示例 |
参数示例 { "account": { "name": "XX", "idType": 1, "idCard": "231X11XXX107182XXX", "phone": "13X1X80X4XX", "companyName": "XX有限公司", "type": 2, "email": "", "bankAddress": "浙江省,杭州市,招商银行", "bankName": "中国工商银行开封分行中山路支行", "cardNo": "6X148XX715X86X0X", "payPwd": "123", "remark": "123" }, "order": { "orderNo": "豫24-190120-002", "bondCompanyNo": 0, "clientName": "郭XX", "clientIdCard": "41X62XX9891X26X42X", "spName": "河南开封清涛业务部", "lendBank": "中国工商银行股份有限公司杭州延中支行", "loanMonth": 36, "loanAmt": ["58000","4500"], "carPayAmt": "", "servicePayAmt": "", "buyerName": "", "buyerIdCard": "" } } |
||||
|
返回示例 |
{"code":"0"," retMsg":"成功"} |
||||