资料格式说明

1{
2  "record_fields": [
3    // 要求提交三个资料项，分别是企业法人身份证号，企业法人证件类型，大陆居民身份证照片
4    {
5      "item_id": "100004",// 资料项ID，用于唯一的标识一个资料项
6      "field_name": "legal_person_card_id",// 资料项英文名（提交资料时需带上）
7      "name": "企业法人身份证号",// 资料项中文名，可用于页面展示（提交资料时需带上）
8      "type": 1,// 资料项类型，不同资料项类型有不同的校验规则 1-文本
9      "tips": "",// 资料项填写提示，一般在资料项名下小字展示
10      "placeholder": "请输入企业法人身份证号",// 输入框占位文案，用于在尚未填写时提示商户输入内容
11      "tooltip": "需要填写完整身份证号",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
12      "required": 1,// 是否必须提交 0-非必填 1-必填
13      "string_check_rule": {// 字符串校验规则
14        "min_string_length": 1,// 字符串最小长度，为0时不限制
15        "max_string_length": 50, // 字符串最大长度，为0时不限制
16         "validator": "idcard" // 字符串，说明这个字段，比如idcard-身份证号，number-数字，建议商户自行做输入正则检查
17                              // 符合一般格式即可，为空则无需处理
18       },
19      "need_encrypt":true // 提交内容需要加密
20    },
21    {
22      "item_id": "100005",// 资料项ID，用于唯一的标识一个资料项
23      "field_name": "legal_person_cert_type",// 资料项英文名（提交资料时需带上）
24      "name": "企业法人证件类型",// 资料项中文名，可用于页面展示（提交资料时需带上）
25      "type": 4,// 资料项类型 4-枚举，要求商户在枚举可选的字段列表里选择
26      "tips": "",// 资料项填写提示，一般在资料项名下小字展示
27      "placeholder": "请选择证件类型",// 输入框占位文案，用于在尚未填写时提示商户输入内容
28      "tooltip": "",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
29      "required": 0,// 是否必须提交 0-非必填 1-必填
30      "enum_check_rule": {// 枚举校验规则
31        // 这里表示枚举只能选一个
32        "min_list_length": 1,// 最小列表长度，为0时不限制
33        "max_list_length": 1,// 最大列表长度，为0时不限制
34        "enum_values": ["大陆居民身份证", "港澳台通行证"]// 枚举可选的字段列表
35      },
36      "need_encrypt":false // 提交内容不需要加密
37    },
38    {
39      "item_id": "100006",// 资料项ID，用于唯一的标识一个资料项
40      "field_name": "inland_cert_card_image",// 资料项英文名（提交资料时需带上）
41      "name": "大陆居民身份证照片",// 资料项中文名，可用于页面展示（提交资料时需带上）
42      "type": 2,// 资料项类型 2-文件
43      "tips": "请上传图片",
44      "placeholder": "",// 输入框占位文案，用于在尚未填写时提示商户输入内容
45      "tooltip": "需要正面和反面两张照片",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
46      "required": 1,// 是否必须提交 0-非必填 1-必填
47      "need_encrypt":false, // 提交内容不需要加密
48      "file_check_rule": {// 文件校验规则
49        // 这里表示上传2张图片，格式必须为["png", "jpg", "jpeg"]内
50        "min_list_length": 2,// 最小列表长度，为0时不限制
51        "max_list_length": 2,// 最大列表长度，为0时不限制
52        "enum_file_exts": ["png", "jpg", "jpeg"],// 限制提交的文件后缀
53        "max_file_size": 5 // 限制文件提交大小，单位M
54      },
55      "relations": [
56        {"source_key": 100005, "source_value": "大陆居民身份证"} // 当100005资料项枚举值为"大陆居民身份证"时，才展示这个资料项让商户填写
57      ]
58    } 
59  ]
60}

1/**
2 * 资料项
3**/
4message SubmissionItem
5{
6  optional uint32 item_id = 1; //资料项唯一id，不可重复
7  optional string field_name = 2; //资料项英文名
8  optional string name = 3; //资料项中文名
9  optional uint32 type = 4; //资料项类型枚举值参考前述表格
10  optional string tips = 5; //填写指引
11  optional uint32 required = 6; //选填必填, enum: 0非必填, 1必填
12  optional string placeholder = 7; //输入框占位文案
13  optional string tooltip = 8; //叹号悬浮提示语
14  repeated string pre_embedded_list = 9; // 预埋订单ID信息，仅当资料项type为6时才有
15  repeated SubmissionItemRelation relations = 10; //资料项关联关系
16  // 以下校验规则，对应资料项类型type，例如资料项类型为字符串，就只会返回string_check_rule
17  optional StringItemCheckRule string_check_rule = 11; //字符串资料项校验规则，当类型为1-文本时返回
18  optional FileItemCheckRule file_check_rule =12; //文件资料项校验规则，当类型为2-文件时返回
19  optional AddressItemCheckRule address_check_rule = 13; //地址资料项校验规则，当类型为3-地址时返回
20  optional EnumItemCheckRule enum_check_rule = 14; //枚举资料项校验规则，当类型为4-枚举时返回
21  optional TimeIntervalItemCheckRule time_interval_check_rule = 15; //时间区间资料项校验规则，当类型为5-时间区间时返回
22  optional OrderItemCheckRule order_interval_check_rule = 16; //订单资料项校验规则，当类型为6-订单时返回
23  optional bool need_encrypt = 17; // 是否需要加密，若为true，提交结果的repeated_field_data字段里每个string都要加密
24  // 加密规则参考https://wechatpay-api.gitbook.io/wechatpay-api-v3/qian-ming-zhi-nan-1/min-gan-xin-xi-jia-mi
25  
26}
27 
28/**
29 * 字符串资料项校验规则
30**/
31message StringItemCheckRule
32{
33  optional uint32 min_string_length = 1; //最小字符串长度
34  optional uint32 max_string_length = 2; //最大字符串长度
35  optional string validator = 3; // 正则校验规则，取值见后文，服务商侧自行验证是符合格式的数据即可
36}
37 
38/**
39 * 文件资料项校验规则
40**/
41message FileItemCheckRule
42{
43  repeated string enum_file_exts = 1; // 可选文件后缀名不带点号['jpg', 'png']
44  optional uint32 max_file_size = 2; //限制文件大小，单位M
45  optional uint32 min_list_length = 3; //最小列表长度，为0时不限制
46  optional uint32 max_list_length = 4; //最大列表长度，为0时不限制
47}
48 
49/**
50 * 地址资料项校验规则
51**/
52message AddressItemCheckRule
53{
54  optional uint32 min_string_length = 1; //最小字符串长度
55  optional uint32 max_string_length = 2; //最大字符串长度
56}
57 
58/**
59 * 枚举资料项校验规则
60**/
61message EnumItemCheckRule
62{
63  repeated string enum_values = 1; // 枚举取值列表
64  optional uint32 min_list_length = 2; //最小可选择数量，为0时不限制
65  optional uint32 max_list_length = 3; //最大可选择数量，为0时不限制
66}
67 
68/**
69 * 时间区间资料项校验规则
70**/
71message TimeIntervalItemCheckRule
72{
73  optional uint32 min_list_length = 1; //最小列表长度，为0时不限制
74  optional uint32 max_list_length = 2; //最大列表长度，为0时不限制
75}
76 
77/**
78 * 订单校验规则
79**/
80message OrderItemCheckRule
81{
82  repeated string enum_file_exts = 1; // 可选文件后缀名不带点号['jpg', 'png']
83  optional uint32 max_file_size = 2; // 限制文件大小，单位M
84  optional uint32 min_list_length = 3; // 最小可选择数量，为0时不限制
85  optional uint32 max_list_length = 4; // 最大可选择数量，为0时不限制
86}
87 
88 
89/**
90 * 资料项关联规则，具体说明见后文
91**/
92message SubmissionItemRelation
93{
94  optional uint32 source_key = 1; //触发源的资料项，存的是资料项的item_id
95  optional string source_value = 2; //触发源的值，表现为当key的资料项取x值的时候，才显示本资料项
96  // 同source_key之间是“或”关系，不同source_key之间是“且”关系，或关系优先且关系
97}

1{
2      "item_id": "100006",// 资料项ID，用于唯一的标识一个资料项
3      "field_name": "inland_cert_card_image",// 资料项英文名（提交资料时需带上）
4      "name": "大陆居民身份证照片",// 资料项中文名，可用于页面展示（提交资料时需带上）
5      "type": 2,// 资料项类型 2-文件
6      "tips": "请上传图片",
7      "placeholder": "",// 输入框占位文案，用于在尚未填写时提示商户输入内容
8      "tooltip": "需要正面和反面两张照片",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
9      "required": 0,// 是否必须提交 0-非必填 1-必填
10      "need_encrypt":false // 提交内容不需要加密
11      "file_check_rule": {
12        // 这里表示上传2张图片，格式必须为["png", "jpg", "jpeg"]内
13        "min_list_length": 2,// 最小列表长度
14        "max_list_length": 2,// 最大列表长度
15        "enum_file_exts": ["png", "jpg", "jpeg"],// 限制提交的文件后缀
16        "max_file_size": 5 // 限制文件提交大小，单位M
17      },
18 
19      // （100005资料项取值为"大陆居民"或"港澳居民"） 且（100007资料项取值为"身份证"）时才展示，不满足条件就不展示给商户填写
20      "relations": [
21        {"source_key": 100005, "source_value": "大陆居民"},
22        {"source_key": 100005, "source_value": "港澳居民"},
23        {"source_key": 100007, "source_value": "身份证"},
24      ]
25}

1"relations": [
2        {"source_key": 100012, "source_value": "线上经营"},
3        {"source_key": 100012, "source_value": "线上线下经营"},
4        {"source_key": 100031, "source_value": "APP"},
5        {"source_key": 100090, "source_value": "APP"},
6        {"source_key": 100091, "source_value": "APP"}
7      ]

1{
2      "item_id": "100004",// 资料项ID，用于唯一的标识一个资料项
3      "field_name": "legal_person_name",// 资料项英文名（提交资料时需带上）
4      "name": "企业法人姓名",// 资料项中文名，可用于页面展示（提交资料时需带上）
5      "type": 1,// 资料项类型，不同资料项类型有不同的校验规则 1-文本
6      "tips": "",// 资料项填写提示，一般在资料项名下小字展示
7      "placeholder": "请输入企业法人姓名",// 输入框占位文案，用于在尚未填写时提示商户输入内容
8      "tooltip": "需要填写完整姓名",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
9      "required": 1,// 是否必须提交 0-非必填 1-必填
10      "string_check_rule": {// 校验规则
11        "min_string_length": 1,// 字符串最小长度，为0时不限制
12        "max_string_length": 50 // 字符串最大长度，为0时不限制
13      },
14      "need_encrypt":true // 提交内容需要加密
15}

1{
2      "item_id": "100006",// 资料项ID，用于唯一的标识一个资料项
3      "field_name": "inland_cert_card_image",// 资料项英文名（提交资料时需带上）
4      "name": "大陆居民身份证照片",// 资料项中文名，可用于页面展示（提交资料时需带上）
5      "type": 2,// 资料项类型 2-文件
6      "tips": "请上传图片",
7      "placeholder": "",// 输入框占位文案，用于在尚未填写时提示商户输入内容
8      "tooltip": "需要正面和反面两张照片",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
9      "required": 1,// 是否必须提交 0-非必填 1-必填
10      "file_check_rule": {
11        // 这里表示上传2张图片，格式必须为["png", "jpg", "jpeg"]内
12        "min_list_length": 2,// 最小列表长度
13        "max_list_length": 2,// 最大列表长度
14        "enum_file_exts": ["png", "jpg", "jpeg"],// 限制提交的文件后缀
15        "max_file_size": 5 // 限制文件提交大小，单位M
16      },
17      "relations": [
18        {"source_key": 100005, "source_value": "大陆居民身份证"} // 当100005资料项枚举值为"大陆居民身份证"时，才展示这个资料项让商户填写
19      ],
20      "need_encrypt":false // 提交内容不需要加密
21} 

1{
2      "item_id": "100152",// 资料项ID，用于唯一的标识一个资料项
3      "field_name": "booth_address",// 资料项英文名（提交资料时需带上）
4      "name": "摊位地址",// 资料项中文名，可用于页面展示（提交资料时需带上）
5      "type": 3,// 资料项类型，不同资料项类型有不同的校验规则 1-文本
6      "tips": "",// 资料项填写提示，一般在资料项名下小字展示
7      "placeholder": "",// 输入框占位文案，用于在尚未填写时提示商户输入内容
8      "tooltip": "",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
9      "required": 1,// 是否必须提交 0-非必填 1-必填
10      "address_check_rule": {// 校验规则
11        "min_string_length": 1,// 字符串最小长度，为0时不限制
12        "max_string_length": 999 // 字符串最大长度，为0时不限制
13      },
14      "need_encrypt":false // 提交内容不需要加密
15}
16 

1{
2      "item_id": "100005",// 资料项ID，用于唯一的标识一个资料项
3      "field_name": "legal_person_cert_type",// 资料项英文名（提交资料时需带上）
4      "name": "企业法人证件类型",// 资料项中文名，可用于页面展示（提交资料时需带上）
5      "type": 4,// 资料项类型 4-枚举，要求商户在枚举可选的字段列表里选择
6      "tips": "",// 资料项填写提示，一般在资料项名下小字展示
7      "placeholder": "请选择证件类型",// 输入框占位文案，用于在尚未填写时提示商户输入内容
8      "tooltip": "",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
9      "required": 0,// 是否必须提交 0-非必填 1-必填
10      "enum_check_rule": {
11        // 这里表示枚举只能从enum_values里面选一个
12        "min_list_length": 1,// 最小列表长度，为0时不限制
13        "max_list_length": 1,// 最大列表长度，为0时不限制
14        "enum_values": ["大陆居民身份证", "港澳台通行证"]// 枚举可选的字段列表
15      },
16      "need_encrypt":false // 提交内容不需要加密
17}

1{
2      "item_id": "100016",// 资料项ID，用于唯一的标识一个资料项
3      "field_name": "FOpeningHours",// 资料项英文名（提交资料时需带上）
4      "name": "营业时间",// 资料项中文名，可用于页面展示（提交资料时需带上）
5      "type": 5,// 资料项类型 5-时间区间
6      "tips": "",// 资料项填写提示，一般在资料项名下小字展示
7      "placeholder": "请选择起止营业时间",// 输入框占位文案，用于在尚未填写时提示商户输入内容
8      "tooltip": "",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
9      "required": 0,// 是否必须提交 0-非必填 1-必填
10      "time_interval_check_rule": {
11        // 这里表示只能提交长度为2的字符串列表，起始时间和结束时间
12        "min_list_length": 2,// 最小列表长度，为0时不限制
13        "max_list_length": 2,// 最大列表长度，为0时不限制
14      },
15      "relations": [
16        // 当100012资料项枚举值为"线下经营"或"同时线上线下经营"时，才展示这个资料项让商户填写
17        {"source_key": 100012, "source_value": "线下经营"} 
18        {"source_key": 100012, "source_value": "同时线上线下经营"} 
19      ],
20      "need_encrypt":false // 提交内容不需要加密
21}
22 

1{
2      "item_id": "100025",// 资料项ID，用于唯一的标识一个资料项
3      "field_name": "order_info",// 资料项英文名（提交资料时需带上）
4      "name": "订单信息",// 资料项中文名，可用于页面展示（提交资料时需带上）
5      "type": 6,// 资料项类型，不同资料项类型有不同的校验规则 6-订单
6      "tips": "",// 资料项填写提示，一般在资料项名下小字展示
7      // 要求商户对支付指定的三个订单补充资料
8      "pre_embedded_list":[
9          "{\"wechat_order_id\":\"123456786\",}",
10          "{\"wechat_order_id\":\"123456787\",}",
11          "{\"wechat_order_id\":\"123456788\",}",
12      ],
13      "placeholder": "",// 输入框占位文案，用于在尚未填写时提示商户输入内容
14      "tooltip": "",// 叹号悬浮提示语，一般复杂资料项，会有叹号标识，鼠标悬浮在上面后会展示提示信息
15      "required": 1,// 是否必须提交 0-非必填 1-必填
16      "order_interval_check_rule": {// 校验规则
17        "min_list_length": 1,// 列表最小长度，为0时不限制
18        "max_list_length": 5 // 列表最大长度，为0时不限制
19        // 订单内部结构需要上传文件，因此这里也限制了上传文件的相关规则
20        "enum_file_exts": ["png", "jpg", "jpeg"],// 限制提交的文件后缀
21        "max_file_size": 5 // 限制文件提交大小，单位M
22      },
23      "need_encrypt":false // 提交内容不需要加密
24}

1// 五类资料项类型均给出示例
2{
3      // 字符串类型
4    	"record_fields": [ // 此处省略SubmissionItem的其他字段
5		{
6			"item_id": 100001,
7			"name": "身份证号",
8			"type": 1,
9			"field_name": "FCertCardId",
10          "repeated_field_data": [ 
11		"ri8U5FUSmHh1peGNBUvG+VwGHl31ymiLms5V1yhTbBWUApJDInme1b+ndtrlAielJYpQE41sSxj46ePMto2mySBIJjgCIyChLCTQ580M5pNKglAkjTnXwzJXyPhpyzkpdeFfUDjWc+qd6G4UwrL70br/EEqfQbGNaUKX6jAGjB8wd8wndImMB3iB2vUuAOL+6giLWCBBaC50QRfCTDlGi0c41Gt92tCrRSI7pWzU1cxxJwng7M53/J5PhI+eikLqbhUYlRPHYl6j0ouRItWHCRORYKuz6enluXyFwUCaaR3IeINSM8CwjHp6spnTIo70UaRJWAcZ0jQp/lwX2JVxaw=="// 加密后的身份证号
12			]
13		},
14      // 文件类型-单个文件
15		{
16			"item_id": 100002,
17			"name": "门店照片",
18			"type": 2,
19			"field_name": "FImages",
20          "repeated_field_data": [ 
21				"xxx1.jpg"
22			 ]
23       },
24        // 文件类型-多个文件
25		{
26			"item_id": 100003,
27			"name": "身份证照片",
28			"type": 2,
29			"field_name": "FImages",
30			"repeated_field_data": [ 
31				"xxx1.jpg",
32				"xxx2.jpg"
33			]
34		},
35        // 地址类型，地址提交的JSON结构固定，见后面说明
36		{
37			"item_id": 100004,
38			"name": "店铺地址",
39			"type": 3,
40			"field_name": "FAddRess",
41          "repeated_field_data": [ 
42				"{\"longitude\":\"37.5\",\"latitude\":\"123.5\",\"province\":\"广东省\",\"city\":\"深圳市\",\"area\":\"南山区\",\"street\":\"XX街道\",\"address\":\"XX路XX号\",\"name\":\"XXXX公司\"}"			]
43		},
44        // 枚举类型-选中一个
45		{
46			"item_id": 100005,
47			"name": "经营场景",
48			"type": 4,
49			"field_name": "FBusinessScenarios",
50			"repeated_field_data": [ 
51				"线上经营",
52			]
53		},
54         // 枚举类型-选中多个
55		{
56			"item_id": 100005,
57			"name": "经营场景",
58			"type": 4,
59			"field_name": "FBusinessScenarios",
60			"repeated_field_data": [ 
61				"线上经营",
62				"线上线下经营"
63			]
64		},
65        // 时间区间类型
66       {
67			"item_id": 100006,
68			"name": "营业时间",
69			"type": 4,
70			"field_name": "FOpeningHours",
71			"repeated_field_data": [ 
72				"09:00:00",
73				"20:00:00"
74			]
75		}
76       // 订单类型
77       {
78			"item_id": 100025,
79			"name": "订单信息",
80			"type": 4,
81			"field_name": "FOrderInfo",
82          // 订单类型返回结构见下文
83			"repeated_field_data": [ 
84				"{\"wechat_order_id\":\"支付订单号\",\"merchant_order_id\":\"商户订单号\",\"trade_time\":\"交易时间，采用YYYY-MM-DD HH:mm:ss标准，例如2023-07-17 02:08:22\",\"trade_money_amount\":\"交易金额\",\"trade_goods\":\"调单商品\",\"logistic_flag\":0,\"evidence_img_list\":[\"凭证图片1\",\"凭证图片2\",\"图片id\"]}",
85				"{\"wechat_order_id\":\"支付订单号\",\"merchant_order_id\":\"商户订单号\",\"trade_time\":\"交易时间，采用YYYY-MM-DD HH:mm:ss标准，例如2023-07-17 02:08:22\",\"trade_money_amount\":\"交易金额\",\"trade_goods\":\"调单商品\",\"logistic_flag\":0,\"evidence_img_list\":[\"凭证图片1\",\"凭证图片2\",\"图片id\"]}"，
86             "{\"wechat_order_id\":\"支付订单号\",\"merchant_order_id\":\"商户订单号\",\"trade_time\":\"交易时间，采用YYYY-MM-DD HH:mm:ss标准，例如2023-07-17 02:08:22\",\"trade_money_amount\":\"交易金额\",\"trade_goods\":\"调单商品\",\"logistic_flag\":0,\"evidence_img_list\":[\"凭证图片1\",\"凭证图片2\",\"图片id\"]}"
87			]
88		}
89	]
90}

1{
2  "longitude": "经度值",
3  "latitude": "纬度值",
4  "province": "省份",
5  "city": "城市",
6  "area": "区域",
7  "street": "街道",
8  "address": "详细地址",
9  "name": "地址名称"
10}

1{
2  "wechat_order_id": "支付订单号",
3  "merchant_order_id": "商户订单号",
4  "trade_time": "交易时间，采用YYYY-MM-DD HH:mm:ss标准，例如2023-07-17 02:08:22",
5  "trade_money_amount": "交易金额",
6  "trade_goods": "调单商品",
7  "logistic_flag": 0, // 是否物流，0表示否，1表示是
8  "evidence_img_list": ["凭证图片1", "凭证图片2", "凭证图片3"] // 凭证图片信息，多个图片的字符串数组
9}