业务说明

客户平台根据模板工具提前制作好合同模板，模板提交给相关人员进行配置。当客户平台的用户，即所有合同签署者，完成短信验证码发送后，客户平台向电子协议系统发送创建合同的命令并上送验证码，完成合同创建及电子签名。一旦客户平台或用户完成一次签署，无论本次合同是否过期未完成签署，系统仍记为已消费一次签署次数。需上送合同的所有信息。

提示

P：合同模板创建工具地址链接：https://pan.baidu.com/s/1VfqVFDHdUYtUEa_W_0Vpaw
提取码：jaks。

二.字段说明：

请求报文

1.contractBody字段：包括head和业务数据节点 note、createContract
a.head节点见电子协议联调说明(二、接口约定中-5. 报文参数-请求参数-head(头信息)详细)
b.业务数据节点 note：

请求 note节点字段

参数	约束	最大长度	说明	备注
randomCode	NOT NULL	2	短信随机码	短信随机码，用来区别当前用户接收的短信，防止多次获取时导致验证失败
checkCode	NOT NULL	6	验证码	系统直接发给客户的验证码，用户将接收到的验证码输入到客户平台，由客户平台传输给系统验证

c.createContract:

请求 createContract节点字段

参数	约束	最大长度	说明	备注
templateId	NOT NULL	10	模板 ID	制作好，提交给电子协议系统管理员后，管理员会反馈合同模板编号
isSign		1	签署类型	易生平台自身是否要签署该协议。0：抄送；1：签署；2：暂不签署；默认为 0
sealId		32	印章 ID	添加印章返回的印章 ID，不传时为默认印章
sealColor		1	签章颜色	1：红色；2：蓝色；3：黑色；默认为 1
contractName		100	合同名称	客户自定义合同名称
signLocation		200	签名域的标签值	易生平台默认签署域为:Signature_plat；可以签多个，以“;”分割
textValueInfo	NOT NULL		文本域信息	Map<String, String>，key 为合同模板文本域的标签值，value 为往文本域填入的值，替换原来 InvestmentInfo 属性
isFillInContractNo		1	是否填写合同编号	0：不填写；1：填写；默认为 0 如果需要把合同编号填写到合同模板里面，需要保证合同模板里面有一个文本域，key 值为：contractNo
expiredDate		8	合同过期时间	过期时间，默认 30 天，1 年封顶，过期后不能进行签署。格式：yyyyMMdd
attachment			附件信息	JSON 详细见子节点
signInfos				签名信息

请求 attachment节点字段

参数	约束	最大长度	说明	备注
attachmentName		50	附件名称	添加附件的名称（不能填写中文）。附件为与该合同相关的照片、音频、视频的哈希值。用来确保提供证据时的音视频文件没有被篡改
attachmentContent		200	附件内容	添加附件的内容。附件为与该合同相关的照片、音频、视频的哈希值。用来确保提供证据时的音视频文件没有被篡改

请求 signInfos节点字段

参数	约束	最大长度	说明	备注
userId	NOT NULL	32	用户 ID	开户时返回的用户 ID
authorizationTime	NOT NULL	14	授权时间	客户平台将采集到的用户输入验证码的时间发送给电子协议系统，格式：yyyyMMddHHmmss
location	NOT NULL	100	授权地点	客户平台将采集到的用户 IP或所在地发送给电子协议系统
signLocation	NOT NULL	200	签名域的标签值	签署人可以签多个，以“;”分割
projectCode	NOT NULL	32	项目编号	如果确定代签，必须保证代签的用户已经对该项目进行了授权
isCheckProjectCode		1	是否检查项目编号	0：不检查；1：检查；默认为 0，需要校验项目编号的时候传送
isProxySign		1	是否代签	0：不代签；1：代签；默认为 0。取 1 时，可不用再“签署合同”
isCopy			1	是否抄送
sealId		32	印章 ID	添加印章返回的印章 ID，不传时为默认印章
sealColor		1	签章颜色	1：红色；2：蓝色；3：黑色；默认为 1

返回报文

1.contractBody字段：包括head和业务数据节点contract
a.head节点见电子协议联调说明(二、接口约定中-5. 报文参数-请求参数-head(头信息)详细)
b.业务数据节点contract：

返回 contract节点字段

参数	约束	最大长度	说明	备注
userId	NOT NULL	32	用户 ID
contractNo	NOT NULL	30	合同编号	电子协议系统自动生成
contractTypeCode	NOT NULL	10	合同类型	详见电子协议-附录-码(2.合同类型)
contractName	NOT NULL	100	合同名称	用户提供合同模板时提供，一般同一模板对应同一个名称
contractState	NOT NULL	1	合同状态	详见电子协议-附录-码(4.合同状态)
createTime	NOT NULL	14	创建合同时间	格式：yyyyMMddHHmmss
expiredDate	NOT NULL	8	合同签署截止时间	针对不代签而用户自行去电子协议系统签署的用户。系统默认为 30 天。格式：yyyyMMdd
signatories			签署信息	JSON 详细见子节点

返回 signatories节点字段

参数	约束	最大长度	说明	备注
userName	NOT NULL	150	签署人名称
identTypeCode	NOT NULL	1	签署人证件类型编码
identNo	NOT NULL	80	签署人证件号码
signmentState	NOT NULL	1	签署状态	详见电子协议-附录-码(3.签署状态)
signTime	NOT NULL	14	签署时间	用户在合同上数字签名的时间，即时间戳的时间

请求参数

Body 参数application/x-www-form-urlencoded

termId

string

必需

电子协议系统分配的终端号

示例值:

TE120101

tradeTrace

string

必需

请求流水，唯一，不包括特殊字符

示例值:

z9KnSjwY9xyvVgoIRjK9

contractBody

string

请求的报文内容

必需

示例值:

{"head":{"txTime":"20230529155156"},"note":{"randomCode":"45","checkCode":"000000"},"createContract":{"signInfos":[{"projectCode":"123","location":"127.0.0.1","signLocation":"Signature1","authorizationTime":"20230529155156","isProxySign":"0","userId":"CFC5D50666BE219BE05311016B0A4D22"},{"projectCode":"123","location":"127.0.0.1","signLocation":"Signature2","authorizationTime":"20230529155156","isProxySign":"0","userId":"FCA7BBF6AC2A7489E05311016B0A5D38"}],"textValueInfo":{"1":"nnnn","2":"22222222222222","3":"333333333333"},"templateId":"QT_22325","isSign":"0"}}

merId

string

必需

电子协议系统分配的商户号

示例值:

MER021322120101

txCode

string

请求类型

必需

示例值:

3201

version

string

必需

版本默认 “1.0”

示例值:

1.0

channelId

string

必需

电子协议系统分配的机构号

示例值:

616161622120101

sign

string

必需

请求的签名，是对 POST 请求参数的签名

示例值:

392DB56B7A9957964FBB5A731E512096

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

resultCode

enum<string>

应答码

必需

应答码

<= 2 字符

枚举值:

00010306253031429698A094

resultMsg

string

应答描述

可选

应答描述

contractBody

string

应答的报文

可选

应答的报文

sign

string

请求的签名，是对 POST 应答参数的签名

可选

请求的签名，是对 POST 应答参数的签名

示例

{
    "contractBody": "{\"head\":{\"txTime\":\"20221026164922\",\"retCode\":\"60000000\",\"retMessage\":\"OK\"},\"contract\":{\"contractNo\":\"QT20230427000007029\",\"contractTypeCode\":\"QT\",\"contractName\":\"特约商户（两方）受理支付业务协议\",\"contractState\":0,\"createTime\":\"20230427153548\",\"expiredDate\":\"20230527\",\"fileId\":\"6b92b714-67f1-426a-9e8d-8c5d5196cbc3\",\"signatories\":[{\"userId\":\"8D4CFF34AB1D289EE05311016B0A9A8A\",\"userName\":\"某公司\",\"identTypeCode\":\"8\",\"identNo\":\"110101111111117\",\"signmentState\":0,\"signTimes\":0,\"signTime\":20230427153548}]}}",
    "resultCode": "00",
    "sign": "F7C99C455E7DA4B13CE595D1BEE4AF5E"
}

创建合同3201

业务说明

二.字段说明：

请求报文

返回报文

请求参数

示例代码

返回响应