商户进件
公共响应参数
字段 |
是否必选 |
字段类型 |
字段说明 |
code |
是 |
String |
错误码 |
message |
是 |
String |
错误信息 |
result |
是 |
Boolean |
返回结果 |
data |
是 |
String |
业务参数 |
图片上传接口
字段 |
是否必选 |
字段类型 |
字段说明 |
pic_file |
是 |
File |
图片,单张大小限制在1M以内 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
pic |
是 |
String |
图片url |
商户进件接口
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
full_name |
是 |
String |
商户全称 |
name |
是 |
String |
商户简称 |
social_credit_code |
是 |
String |
营业执照编号 |
province_code |
否 |
String |
省份编号 |
city_code |
否 |
String |
城市编号 |
district_code |
否 |
String |
区/县编号 |
address |
是 |
String |
详细地址 |
contact_name |
是 |
String |
联系人姓名 |
contact_mobile |
是 |
String |
联系人手机 |
contact_email |
是 |
String |
联系人邮箱 |
contact_certification_type |
是 |
String |
联系人证件类型,默认01,身份证 |
contact_certification_no |
是 |
String |
联系人证件号码 |
sales_man |
否 |
String |
拓展业务员(名字) |
custom_manager |
否 |
String |
所属客户经理(名字) |
mcc |
是 |
String |
经营类目 |
legal_name |
是 |
String |
法人姓名 |
legal_certification_no |
是 |
String |
法人身份证 |
legal_type |
是 |
String |
法人证件类型,默认01,身份证 |
tel |
是 |
String |
客服电话 |
tobacco_license |
否 |
String |
烟草许可证 |
merchant_types |
是 |
String |
商户类型 1:个体 2:企业 |
bank_account |
是 |
String |
结算信息(字符串), 具体值请参看结算信息对象 |
merchant_photo |
是 |
String |
证件照信息(字符串), 具体值请参看证件照信息对象 |
institution_products |
是 |
String |
支付类型及费率(字符串),具体值请参看支付类型对象 |
notify |
否 |
String |
商户进件通知地址 |
trade_notify |
否 |
String |
交易通知地址 |
remark |
否 |
String |
备注,预留,不必填 |
social_credit_start |
否 |
String |
营业执照编号有效期开始日期 |
social_credit_end |
否 |
String |
营业执照编号有效期结束日期 |
legal_certification_start |
否 |
String |
法人证件有效期开始日期 |
legal_certification_end |
否 |
String |
法人证件有效期结束日期 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
- bank_account(结算信息对象,JSON字符串)
字段 |
是否必选 |
字段类型 |
字段说明 |
account_types |
是 |
String |
结算账号标志 0-对公 1-对私 |
bank_account_no |
是 |
String |
银行账号 |
bank_name |
是 |
String |
开户人名称 |
cycle |
是 |
String |
结算周期 00-T+1 01-D+1 |
bank_code |
是 |
String |
联合行号 |
- merchant_photo(证件照信息对象,JSON字符串)
字段 |
是否必选 |
字段类型 |
字段说明 |
license_code_photo |
是 |
String |
营业执照 |
bank_card_front_photo |
否 |
String |
银行卡正面 |
open_account_license_photo |
否 |
String |
结算银行开户许可证 |
legal_certification_front_photo |
是 |
String |
负责人身份证正面 |
legal_certification_back_photo |
是 |
String |
负责人身份证反面 |
group_photo |
否 |
String |
工作人员与商户负责人合影 |
indoor_photo |
否 |
String |
门店内景照 |
door_head_photo |
否 |
String |
门头照 |
protocol_photo |
否 |
String |
商户协议 |
bank_card_license_photo |
否 |
String |
结算账户指定书 |
settle_certification_front_photo |
否 |
String |
结算人身份证正面照片 |
settle_certification_back_photo |
否 |
String |
结算人身份证反面照片 |
tobacco_license_photo |
否 |
String |
烟草许可证照片 |
contact_photo |
否 |
String |
联系人身份证正面照片 |
contact_back_photo |
否 |
String |
联系人身份证反面照片 |
additional_photo |
否 |
String |
补充资料照片 |
- additional_photo(补充资料照片,最多5张,一个json数组字符串)
字段 |
是否必选 |
字段类型 |
字段说明 |
name |
是 |
String |
补充资料图片名称 |
url |
是 |
String |
补充资料图片url |
- institutionProduct(支付类型对象,JSON字符串)
字段 |
是否必选 |
字段类型 |
字段说明 |
institution_code |
是 |
String |
支付通道编号 |
institution_product_code |
是 |
String |
支付产品编号 |
rate |
是 |
String |
费率(万分之) |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
否 |
String |
商户编号 |
store_code |
否 |
String |
门店编号 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
门店进件接口
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
merchant_code |
是 |
String |
所属商户编号 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
full_name |
是 |
String |
门店全称 |
name |
是 |
String |
门店简称 |
province_code |
否 |
String |
省份编号 |
city_code |
否 |
String |
城市编号 |
district_code |
否 |
String |
区/县编号 |
address |
是 |
String |
详细地址 |
contact_name |
是 |
String |
联系人姓名 |
contact_mobile |
是 |
String |
联系人手机 |
contact_email |
是 |
String |
联系人邮箱 |
contact_certification_type |
是 |
String |
联系人证件类型,默认01,身份证 |
contact_certification_no |
是 |
String |
联系人证件号码 |
tel |
是 |
String |
客服电话 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
否 |
String |
商户编号 |
store_code |
否 |
String |
门店编号 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
修改门店信息
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
store_code |
是 |
String |
门店编号 |
name |
否 |
String |
商户简称 |
contact_name |
否 |
String |
联系人姓名 |
contact_mobile |
否 |
String |
联系人手机 |
contact_email |
否 |
String |
联系人邮箱 |
contact_certification_type |
否 |
String |
联系人证件类型,默认01,身份证 |
contact_certification_no |
否 |
String |
联系人证件号码 |
address |
否 |
String |
详细地址 |
tel |
否 |
String |
客服电话 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
store_code |
是 |
String |
门店编号 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否成功 1:成功 2:失败 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
进件查询接口
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
merchant_code |
是 |
String |
商户编号 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否审核 0:未审核 1:审核通过 2:审核不通过 3:进件完成 |
name |
是 |
String |
商户名称 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
审核通知
注:通知参数不需要加入统一响应参数 data 中,只需要直接接收以下参数
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否审核 0:未审核 1:审核通过 2:审核不通过 4:进件成功 5:进件失败 6:进件中 |
tobacco_license |
否 |
String |
烟草许可证 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
添加授权目录
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
merchant_code |
是 |
String |
商户编号 |
auth_dir |
是 |
String |
支付授权目录 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否成功 1:成功 2:失败 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
添加APPID
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
merchant_code |
是 |
String |
商户编号 |
wx_app_id |
是 |
String |
微信appId |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否成功 1:成功 2:失败 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
添加关注APPID
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
merchant_code |
是 |
String |
商户编号 |
wx_subscribe_app_id |
是 |
String |
微信appId |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否成功 1:成功 2:失败 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
修改基础信息
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
merchant_code |
是 |
String |
商户编号 |
name |
否 |
String |
商户简称 |
contact_name |
否 |
String |
联系人姓名 |
contact_mobile |
否 |
String |
联系人手机 |
contact_email |
否 |
String |
联系人邮箱 |
contact_certification_type |
否 |
String |
联系人证件类型,默认01,身份证 |
contact_certification_no |
否 |
String |
联系人证件号码 |
sales_man |
否 |
String |
拓展业务员(名字) |
custom_manager |
否 |
String |
所属客户经理(名字) |
tel |
否 |
String |
客服电话 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否成功 1:成功 2:失败 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
修改结算信息
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
merchant_code |
是 |
String |
商户编号 |
account_types |
否 |
String |
结算账号标志 0-对公 1-对私 |
bank_account_no |
否 |
String |
银行账号 |
bank_name |
否 |
String |
开户人名称 |
cycle |
否 |
String |
结算周期 00-T+1 01-D+1 |
bank_code |
否 |
String |
联合行号 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否成功 1:成功 2:失败 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
修改商户图片信息
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
merchant_code |
是 |
String |
商户编号 |
license_code_photo |
否 |
String |
营业执照 |
bank_card_front_photo |
否 |
String |
银行卡正面 |
open_account_license_photo |
否 |
String |
结算银行开户许可证 |
legal_certification_front_photo |
否 |
String |
负责人身份证正面 |
legal_certification_back_photo |
否 |
String |
负责人身份证反面 |
group_photo |
否 |
String |
工作人员与商户负责人合影 |
indoor_photo |
否 |
String |
门店内景照 |
door_head_photo |
否 |
String |
门头照 |
protocol_photo |
否 |
String |
商户协议 |
bank_card_license_photo |
否 |
String |
结算账户指定书 |
settle_certification_front_photo |
否 |
String |
结算人身份证正面照片 |
settle_certification_back_photo |
否 |
String |
结算人身份证反面照片 |
contact_photo |
否 |
String |
联系人身份证正面照片 |
contact_back_photo |
否 |
String |
联系人身份证反面照片 |
additional_photo |
否 |
String |
补充资料照片 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
- additional_photo(补充资料照片,最多5张,一个json数组字符串)
字段 |
是否必选 |
字段类型 |
字段说明 |
name |
是 |
String |
补充资料图片名称 |
url |
是 |
String |
补充资料图片url |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否成功 1:成功 2:失败 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
修改费率信息
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
merchant_code |
是 |
String |
商户编号 |
institution_code |
是 |
String |
支付通道编号 |
institution_product_code |
是 |
String |
支付产品编号 |
rate |
是 |
String |
费率(万分之) |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
failure_code |
是 |
String |
错误码 |
failure_msg |
是 |
String |
错误信息 |
merchant_code |
是 |
String |
商户编号 |
state |
是 |
String |
是否成功 1:成功 2:失败 |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
查询清分状态
字段 |
是否必选 |
字段类型 |
字段说明 |
agent_code |
是 |
String |
所属渠道编号,由系统分配 |
app_id |
是 |
String |
app_id, 由系统统一分配 |
out_trade_no |
否 |
String |
请求标识,确保唯一 |
merchant_code |
是 |
String |
商户编号 |
date |
是 |
String |
清分日期(如:20190101) |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
字段 |
是否必选 |
字段类型 |
字段说明 |
merchant_code |
是 |
String |
商户编号 |
name |
是 |
String |
商户名称 |
institutionList |
是 |
String |
上游通道清分状态(一个字符串json数组) |
sign |
是 |
String |
签名值 |
sign_type |
是 |
String |
签名类型 |
out_trade_no |
否 |
String |
请求标识,请求时传了值则有值,否则为空 |
字段 |
是否必选 |
字段类型 |
字段说明 |
institution_code |
是 |
String |
清分渠道 |
state |
是 |
String |
清分状态 0:处理中 1:清分成功 2:清分失败 |
failure_code |
否 |
String |
错误码 |
failure_msg |
否 |
String |
错误信息 |
field1 |
否 |
String |
预留字段 |
查询固定二维码列表
字段 |
是否必选 |
字段类型 |
字段说明 |
app_id |
是 |
String |
商户appid |
merchant_code |
是 |
String |
商户编号 |
store_code |
否 |
String |
门店编号 |
operator_id |
否 |
int |
收银员id |
sign |
是 |
String |
签名值 |
字段 |
是否必选 |
字段类型 |
字段说明 |
qr_codes |
是 |
String |
二维码信息列表(json串,内容见《二维码信息列表》) |
sign |
是 |
String |
签名值 |
字段 |
是否必选 |
字段类型 |
字段说明 |
qr_code_url |
是 |
String |
二维码内容 |
qr_code_img |
是 |
String |
二维码图片地址 |
store_code |
否 |
String |
二维码所属门店编号 |
merchant_code |
是 |
String |
二维码所属商户编号 |
operator_id |
否 |
String |
二维码所属收银员id |