进件 SDK 参数说明

开户进件

通过该接口,为子商户进行开户进件。

  • 请求参数说明

属性

类型

必填

描述

request_id

string(32)

请求ID

usr_phone

string(11)

注册手机号

cont_name

string(16)

联系人姓名

cont_phone

string(11)

联系人手机号码

customer_email

string(60)

电子邮箱

mer_name

string(32)

商户名,小微商户填负责人姓名

mer_short_name

string(10)

商户名简称

license_code

string(22)

营业执照编码,如三证合一传三证合一码,企业时必填

reg_addr

string(60)

注册地址

cust_addr

string(60)

经营地址

cust_tel

string(20)

商户电话

mer_start_valid_date

string(8)

商户有效日期(始),格式 YYYYMMDD (若开户企业类商户,必填)

mer_valid_date

string(8)

商户有效日期(至),格式 YYYYMMDD(若为长期有效,固定为“20991231”;若开户企业类商户,必填)

legal_name

string(16)

法人/负责人 姓名

legal_type

string(1)

法人/负责人证件类型,0-身份证

legal_idno

string(25)

法人/负责人证件号码

legal_mp

string(32)

法人/负责人手机号

legal_start_cert_id_expires

string(8)

法人/负责人身份证有效期(始),格式 YYYYMMDD

legal_id_expires

string(8)

法人/负责人身份证有效期(至),格式 YYYYMMDD

card_id_mask

string(64)

结算银行卡号

bank_code

string(8)

结算银行卡所属银行code,详见 银行代码表

card_name

string(64)

结算银行卡开户姓名

bank_acct_type

string(1)

结算银行账户类型,1 : 对公, 2 : 对私。小微只能是对私

prov_code

string(4)

结算银行卡省份编码,见 附件 省市表(四位)

area_code

string(4)

结算银行卡地区编码,见 附件 省市表(四位)

rsa_public_key

string(1024)

商户rsa 公钥

fee_rate_list

string

费率列表,json 字符串,根据所需支付渠道配置对应费率,费率值不超过 10位的小数,具体内容详见后续 fee_rate_list 说明

entry_mer_type

string

商户类型:1-企业;2-小微。默认为企业

notify_url

string(250)

异步通知地址,url为http/https路径,服务器POST回调,URL 上请勿附带参数

mer_level

string(2)

商户层级:02-二级商户,默认普通商户;平台商户进件二级商户时传入,进件成功后,成为平台商户下属二级商户。

  • 费率列表说明:

费率类型

属性

wx_pub_online

微信公众号支付(线上)

wx_pub_offline

微信公众号支付(线下)

wx_lite_online

微信小程序支付(线上)

wx_lite_offline

微信小程序支付(线下)

wx_scan

微信扫码支付(被扫-线下)

alipay_qr_online

支付宝扫码支付(主扫-线上)

alipay_qr_offline

支付宝扫码支付(主扫-线下)

alipay_scan

支付宝扫码支付(被扫-线下)

alipay_lite_online

支付宝小程序支付(线上)

alipay_lite_offline

支付宝小程序支付(线下)

alipay_call

支付宝唤起支付(线上)

ali_pub_off_b2b

支付宝生活号(线下)

ali_pub_online_b2b

支付宝生活号(线上)

union_qr_under

银联云闪付扫码支付交易金额≤1000元(线下)

union_qr_beyond

银联云闪付扫码支付交易金额>1000元(线下)

union

银联云闪付控件支付(线上)

union_online_b2b

银联在线

具体示例如下:

[{
    "rate_channel": "wx_pub_online",
    "fee_rate": "0.003"
}, {
    "rate_channel": "wx_pub_offline",
    "fee_rate": "0.003"
}, {
    "rate_channel": "wx_lite_online",
    "fee_rate": "0.004"
}, {
    "rate_channel": "wx_lite_offline",
    "fee_rate": "0.004"
}, {
    "rate_channel": "wx_scan",
    "fee_rate": "0.0035"
}, {
    "rate_channel": "alipay_qr_online",
    "fee_rate": "0.0038"
}, {
    "rate_channel": "alipay_qr_offline",
    "fee_rate": "0.0068"
}, {
    "rate_channel": "alipay_scan",
    "fee_rate": "0.0038"
}, {
    "rate_channel": "alipay_lite_online",
    "fee_rate": "0.0038"
}, {
    "rate_channel": "alipay_lite_offline",
    "fee_rate": "0.0068"
}, {
    "rate_channel": "alipay_call",
    "fee_rate": "0.0038"
}, {
    "rate_channel": "union_qr_under",
    "fee_rate": "0.004"
}, {
    "rate_channel": "union_qr_beyond",
    "fee_rate": "0.007"
}, {
    "rate_channel": "union",
    "fee_rate": "0.0068"
}]
  • 响应参数说明

属性

类型

必填

描述

request_id

string(32)

请求ID

status

string(9)

接口调用状态,succeeded - 成功 failed - 失败 pending - 处理中

error_type

String

错误类型

error_code

String

错误码

error_msg

String

返回具体的错误描述

  • 响应示例

{
    "request_id": "merchant_entry_1568686499494",
    "status": "pending"
}

商户开户查询

查询子商户开户结果

  • 请求参数说明

属性

类型

必填

描述

request_id

string(32)

请求ID

  • 响应参数说明

属性

类型

必填

描述

request_id

string

请求ID

test_api_key

string

测试API Key

live_api_key

string

生产API Key

login_pwd

string

初始密码

app_id_list

array

应用ID列表

sign_view_url

string

合同查看地址

status

string(9)

接口调用状态,succeeded - 成功 failed - 失败 pending - 处理中

error_type

String

错误类型

error_code

String

错误码

error_msg

String

返回具体的错误描述

  • 响应示例

{
    "app_id_list": "[{" app_name ":" test_13333333344 "," cre_user ":" 0005098598975552 "," stat ":" N "," upd_ts ":1568635649000," upd_user ":" 0005098598975552 "," remark ":" "," id ":193," app_id ":" app_28eadb84 - 0651 - 4d0d - 9a24 - 7918151aa259 "," cre_ts ":1568635649000," mer_cust_id ":" 0005098598975552 "}]",
    "live_api_key": "api_live_a99c99cb-a9a8-4121-81ec-915c13b7d731",
    "request_id": "merchant_entry_1568686499494",
    "sign_view_url": "https://testapi.fadada.com:8443/api//viewContract.action?app_id=400932&v=2.0&timestamp=20190917101525&contract_id=201909170200013731&msg_digest=MzExMUJGMDc3ODg3RkQyRjg1RkU0MEY1Q0Q5M0I3Q0ZEODUxQTExNw==",
    "status": "succeeded",
    "test_api_key": "api_test_4b048905-1d1d-4e20-88fa-1e28e04f3371"
}

修改结算账户信息

修改商户结算账户信息可以将商户结算账户的信息进行变更, 商户号不变。同步返回 pending 状态表示申请已受理,调用成功后,会 异步消息通知 告知。

  • 请求参数说明

参数

类型

必填

说明

adapay_func_code

String(64)

Y

Adapay接口功能号,该接口填固定值:merchant.modify

order_no

String(64)

Y

请求订单号,只能为英文、数字或者下划线的一种或多种组合

sub_api_key

String(64)

Y

商户开户进件返回的API Key

settle_card_info

String

Y

结算账户信息

notify_url

String(250)

N

异步通知地址,url为http/https路径,服务器POST回调,URL 上请勿附带参数

  • settle_card_info

参数

类型

必填

说明

card_id

String(64)

Y

结算银行卡号

bank_code

String(8)

Y

结算银行卡所属银行code,详见 银行代码表

bank_acct_type

String(1)

Y

结算银行账户类型,1 : 对公, 2 : 对私。小微只能是对私

prov_code

String(4)

Y

结算银行卡省份编码,见 附件 省市表(四位)

area_code

String(4)

Y

结算银行卡地区编码,见 附件 省市表(四位)

  • 响应参数说明

参数

类型

必填

说明

object

String(64)

Y

结算卡对象,merchant_modify

prod_mode

String(8)

Y

是否prod模式,true是prod模式,false是mock模式

order_no

String(64)

Y

请求订单号,只能为英文、数字或者下划线的一种或多种组合

sub_api_key

String(64)

Y

商户开户进件返回的API Key

status

String(16)

Y

接口调用状态,succeeded - 成功 failed - 失败 pending - 处理中

error_code

String(32)

N

错误码

error_msg

String(128)

N

错误描述

error_type

String(32)

N

错误类型

invalid_param

String(32)

N

当发生参数错误时返回具体的参数名,便于定位错误原因

  • 响应示例

{
    "object": "merchant_modify",
    "order_no": "test_settle_card_202304060009",
    "prod_mode": "true",
    "status": "pending",
    "sub_api_key": "test_api_live_00000001"
}

商户入驻

为子商户进行微信或支付宝入驻,并进行支付渠道配置,若使用wx_lite时,appid为微信小程序的appid且必传,若使用wx_pub时,appid为微信公众号的appid且必传,path为支付授权目录且必传; 若子商户不想使用某一种支付渠道,则该支付渠道的值就不传。

支付授权目录说明:

  1. 商户最后拉起微信支付APP的页面地址我们称之为”支付授权目录”,例如https://www.weixin.com/pay.php;

  2. 商户配置的支付授权目录必须符合规则,否则会报错“当前页面的URL未注册”;

  3. 设置完成后会有延迟,一般 30 分钟内生效。

授权目录校验规则说明:

  1. 如果授权目录设置为顶级域名(例如https://www.weixin.com/),那么只校验顶级域名,不校验后缀;

  2. 如果授权目录设置为多级目录,就会进行全匹配,例如设置支付授权目录为https://www.weixin.com/abc/123/,则实际请求页面目录不能为https://www.weixin.com/abc/,也不能为https://www.weixin.com/abc/123/pay/,必须为https://www.weixin.com/abc/123/。

  • 请求参数说明

属性

类型

必填

描述

request_id

string

sub_api_key

string

商户开户进件返回的API Key

fee_type

string

费率类型:01-标准费率线上,02-标准费率线下

app_id

string

商户开户进件返回的应用ID

wx_category

string

微信经营类目(与支付宝二选一),请参考 附件 枚举表文件中

alipay_category

string

支付宝经营类目(与微信二选一),请参考 附件 枚举表文件中clsid与经营类目映射 sheet,根据用户的 cls_id 映射后得到

cls_id

string

行业分类,请参考 附件 枚举表文件中,clsid与经营类目映射_sheet,支付宝的经营类目都由 clis_id 匹配后得到

model_type

string

入驻模式:1-服务商模式

mer_type

string

商户种类,1-政府机构,2-国营企业,3-私营企业,4-外资企业,5-个体工商户,7-事业单位,8-小微

province_code

string

省份编码,见 附件 省市地区表(六位)

city_code

string

城市编码,见 附件 省市地区表(六位)

district_code

string

区县编码,见 附件 省市地区表(六位)(部分地区为九位)

add_value_list

string

支付渠道配置信息,其中 appid 为微信 appid,path 为微信授权目录 {"wx_lite":{"appid":"xxx"},"wx_pub":{"appid":"xxxx","path":"http://xxxx"},"wx_scan":"", "alipay":"","alipay_wap":"","alipay_lite":"","alipay_qr":"","alipay_scan":""}

notify_url

string(250)

异步通知地址,url为http/https路径,服务器POST回调,URL 上请勿附带参数

  • 响应参数说明

属性

类型

必填

描述

request_id

string

请求id

status

string(9)

接口调用状态,succeeded - 成功 failed - 失败 pending - 处理中

error_type

String

错误类型

error_code

String

错误码

error_msg

String

返回具体的错误描述

  • 响应示例

{
    "request_id": "merchant_resident_1568687057520",
    "status": "pending"
}

商户入驻修改

为子商户进行入驻信息修改或升级M3,目前仅支持支付宝渠道的操作,修改结果异步报文通知

  • 请求参数说明

属性

类型

必填

描述

request_id

string

请求ID

sub_api_key

string

商户开户进件返回的API Key

alipay_request_params

string

支付宝入驻修改参数信息(json字符串)

wx_request_params

string

微信入驻修改参数信息(json字符串)

alipay_request_params 包含以下内容

mer_short_name

String(10)

商户简称 商户简称,长度为10个中文

mer_phone

String(11)

商户电话

fee_type

Sting(2)

费率类型:02-线下

card_no

String(32)

结算卡号

card_name

String(64)

结算卡户名

category

String(128)

支付宝经营类目,请参考 附件 枚举表文件中,clsid与经营类目映射_sheet,根据用户的 cls_id 映射后得到

cls_id

String(10)

行业分类,请参考 附件 枚举表文件中,clsid与经营类目映射_sheet,微信和支付宝的经营类目都由 clis_id 匹配后得到

mer_name

String(32)

商户名称

mer_addr

String(128)

商户地址

contact_name

String(32)

联系人姓名

contact_phone

String(11)

联系人电话

contact_mobile

String(11)

联系人手机号

contact_email

String(128)

联系人邮箱

legal_id_no

String(32)

法人身份证号

mer_license

String(32)

商户营业执照编号

province_code

String(16)

省份编码,见 附件 省市地区表(六位)

city_code

String(16)

城市编码,见 附件 省市地区表(六位)

district_code

String(16)

区县编码,见 附件 省市地区表(六位) (部分地区为九位)

alipay_request_params 示例如下

wx_request_params 包含以下内容

mer_short_name

String(10)

商户简称 商户简称,长度为10个中文

mer_phone

String(11)

商户客服电话

alipay_request_params 示例如下

  • 响应参数说明

同步返回

属性

类型

必填

描述

request_id

string

请求ID

status

string

pending: 处理中,failed:失败

error_type

String

错误类型

error_code

String

错误码

error_msg

String

返回具体的错误描述

sign

String

返回参数的签名串

异步返回

属性

类型

必填

描述

request_id

string

请求ID

status

string

pending: 处理中,failed:失败

alipay_stat

string

入驻修改返回结果(成功S,失败F)

wx_stat

string

入驻修改返回结果(成功S,失败F)

error_type

String

错误类型

error_code

String

错误码

error_msg

String

返回具体的错误描述

sign

String

返回参数的签名串

商户入驻查询

通过 request_id 查询商户入驻结果

  • 请求参数说明

属性

类型

必填

描述

request_id

string(32)

请求ID

  • 响应参数说明

属性

类型

必填

描述

request_id

string

请求ID

status

string

succeeded-成功 failed-失败 pending-处理中

wx_stat

string

微信入驻结果:S-成功,F-失败

alipay_stat

string

支付宝入驻结果:S-成功,F-失败

wx_alipay_response

string

配置结果描述 (S-成功,F-失败,I-处理中)json格式:"wx_lite":"S","wx_pub":"S","wx_scan":"S","alipay":"F","alipay_wap":"F","alipay_lite":"F","alipay_qr":"F","alipay_scan":"I"}

wx_mer_code

String

微信子商户号

alipay_mer_code

String

支付宝子商户号

error_type

String

错误类型

error_code

String

错误码

error_msg

String

返回具体的错误描述

  • 响应示例

{
    "request_id": "201909161000002",
    "wx_alipay_response": {
        "wx_lite": "S",
        "wx_pub": "S",
        "wx_scan": "S",
        "alipay": "S",
        "alipay_wap": "S",
        "alipay_lite": "S",
        "alipay_qr": "S",
        "alipay_scan": "S"
    },
    "wx_mer_code": "0021001020",
    "wx_stat": "S",
    "status": "succeeded",
}

上传商户证照

商户进件成功后,需要在5个工作日内补充商户基础资料,否则会关闭商户状态,不允许做交易。 该接口每次提交仅支持上传一张照片,上传成功后,Adapay 会返回pic_id字段值,该值 需要作为 提交商户证照 接口的请求参数上送至Adapay。

  • 请求参数说明

属性

类型

必填

描述

sub_api_key

string

子商户的 apiKey

file

string

图片必须JPG/PNG/JPEG/BMP等类型的文件,大小在2M以内(文件名中不能使用字符/、、:、*、?、”、<、> )

file_type

String

图片类型,01:三证合一码,02:法人/小微负责人身份证正面,03:法人/小微负责人身份证反面,04:门店,05:开户许可证/小微负责人银行卡正面照,06:股东身份证正面,07:股东身份证反面,08:结算账号开户证明,09:网站截图,10:行业资质文件,11:icp备案许可证明或者许可证编码,12:租赁合同,13:交易测试记录,14:业务场景证明材料,15:小微商户头门照,16:小微商户店内经营照,17:联系人身份证正面,18:联系人身份证反面,19:法人授权函

  • 响应参数说明

属性

类型

必填

描述

file_type

string

图片类型

pic_id

string

Adapay系统生成的图片id,作为 提交商户证照 接口的请求参数上送至Adapay

error_type

String

错误类型

error_code

String

错误码

error_msg

String

返回具体的错误描述

提交商户证照

通过 上传商户证照 接口将商户的各种类型基础资料上传成功后,将Adapay生成的各种图片类型的pic_id值通过该接口上送至Adapay。 调用成功后,需要等待Adapay审核,审核状态可通过 查询商户审核状态 接口获取结果。

注:若storeId 需要传入多张门店pic_id时,请将pic_id以|进行分隔,格式如:123|234|456等

  • 请求参数说明

属性

类型

必填

描述

subApiKey

string

渠道商下商户的apiKey

socialCreditCodeId

string

统一社会信用代码的pic_id,企业商户必填,小微商户不填

legalCertIdFrontId

string

法人身份证正面的pic_id

legalCertIdBackId

string

法人身份证反面的pic_id

accountOpeningPermitId

string

开户许可证图片的pic_id

businessAdd

string

若入驻的费率类型为线上时,该字段必填,请传入商户的业务网址或者商城地址

storeId

string

门店的pic_id,若入驻的费率类型为线下时,该字段必填

testAccount

string

登录商户的业务网址或者商城地址使用到的测试用账号

testPwd

string

登录商户的业务网址或者商城地址使用到的测试用密码

transactionTestRecordId

string

商户在业务网址或商城地址上测试的交易记录截图的pic_id

webPicId

string

网站截图的pic_id

leaseContractId

string

租赁合同的pic_id,如经营场所照片无法体现经营内容时上传

settleAccountCertificateId

string

结算账号开户证明图片的pic_id

bussSupportMaterialsId

string

业务场景证明材料pic_id,如经营场所照片无法体现经营内容时上传

icpRegistrationLicenseId

string

icp备案许可证明或者许可证编码的pic_id

industryQualifyDocType

string

行业资质文件类型:1游戏类,2直播类,3小说图书类,4其他

industryQualifyDocLicenseId

string

行业资质文件的pic_id

shareholderInfoList

JSON List

股东信息

  • shareholderInfoList 内容如下

属性

类型

必填

描述

certBackImageId

string

股东身份证照片反面的pic_id

certFrontImageId

string

股东身份证照片正面(人脸面)的pic_id

certId

string

身份证号(字母“X”大写)

certName

string

身份证姓名

  • 参数示例:

[{"certBackImageId":"0064117794199872","certFrontImageId":"0064117011900736","certId":"321121198606115128","certName":"史万福"}]
  • 响应参数说明

属性

类型

必填

描述

sub_api_key

string

商户子apiKey

audit_status

string

成功提交后,提交状态为I,代表成功提交,等待后台审核

error_type

String

错误类型

error_code

String

错误码

error_msg

String

返回具体的错误描述

实名认证申请接口

通过 上传商户证照 接口将商户的各种实名认证所需的图片资料上传成功后,将Adapay生成的各种图片类型的pic_id值通过该接口上送至Adapay。 调用成功后,需要等待审核,实名认证状态可通过 查询商户实名认证状态接口获取结果。

  • 请求参数说明

属性

类型

必填

描述

request_id

string(64)

请求流水号

sub_api_key

string(64)

渠道商下商户的apiKey

real_name_type

string(3)

实名认证申请类型。A:支付宝,W:微信,ALL:两者都开通

contact_type

string(5)

LEGAL:法人;SUPER:经办人 (小微商户只能选择法人,企业可以选择法人或经办人,选择经办人需要在上传商户证照接口上传fileTye为19的法人授权函图片信息)

notify_url

string(128)

支付宝/微信实名异步结果通知地址

support_credentials

string

jsonObject格式。辅助证明材料信息;内容参考:support_credentials 商户为小微商户时,辅助证明材料信息必填

contact_person_info

string

jsonObject格式。联系人信息;内容参考:contact_person_info

legal_person_info

string

jsonObject格式。法人信息;内容参考:legal_person_info

  • support_credentials

属性

类型

必填

描述

micro_biz_type

string(18)

小微经营类型;MICRO_TYPE_STORE:门店场所;MICRO_TYPE_MOBILE:流动经营/便民服务;MICRO_TYPE_ONLINE:线上商品/服务交易(仅微信实名支持此类型);示例值:MICRO_TYPE_STORE

store_door_img

string(128)

门店门头照信息或摊位照 file_type为15的pic_id

store_inner_img

string(128)

门店店内照片或者摊位照侧面 file_type为16的pic_id

  • legal_person_info

属性

类型

必填

描述

legal_id_doc_copy

string(128)

法人身份证正面图片 file_type为02的pic_id

legal_id_doc_copy_back

string(128)

法人身份证背面图片 file_type为03的pic_id

licence_copy

string(128)

营业执照图片 file_type为01的pic_Id

legal_address

string(128)

法人居住地址(企业商户必填)

  • contact_person_info

属性

类型

必填

描述

id_card_number

string(20)

联系人身份证号

contact_period_begin

string(8)

联系人证件有效期开始时间;yyyymmdd格式

contact_period_end

string(8)

联系人证件有效期结束时间;yyyymmdd格式;如果是长期请填写20991231

contact_id_doc_copy

string(128)

联系人证件照正面 file_type为17的pic_id

contact_id_doc_copy_back

string(128)

联系人证件照反面 file_type为18的pic_id

business_authorization_letter

string(128)

业务授权函 file_type为19的pic_id

  • 响应参数说明

同步返回

属性

类型

必填

描述

request_id

string(64)

原请求ID

error_type

string

错误类型

error_code

string

错误码

error_msg

string

返回具体的错误描述

wx_status

string(10)

微信实名状态 pending: 处理中,failed:失败,successed:成功

ali_status

string(10)

支付宝实名状态 pending: 处理中,failed:失败,successed:成功

异步返回

属性

类型

必填

描述

request_id

string(64)

原请求ID

error_type

string

错误类型

error_code

string

错误码

error_msg

string

返回具体的错误描述

status

string(10)

succeeded: 成功,failed:失败

real_name_type

string(1)

实名认证申请类型。A支付宝,W微信

  • 响应示例

{
    "data": {
            "prod_mode": "false",
            "request_id": "realname_000000000000000000030",
            "wx_status": "pending",
            "ali_status": "pending"
    },
    "message": "成功"
}

实名认证查询接口

通过 实名认证申请接口进行实名认证的商户,可以通过实名认证请求的request_id作为实名认证查询接口的请参进行实名认证申请状态和授权状态的查询。

  • 请求参数说明

属性

类型

必填

描述

request_id

string(64)

提交实名认证申请的请求流水号

sub_api_key

string(64)

渠道商下商户的apiKey

  • 响应参数说明

属性

类型

必填

描述

request_id

string(64)

原请求ID

error_type

string

错误类型

error_code

string

错误码

error_msg

string

返回具体的错误描述

real_name_result

string

jsonArray格式;实名认证结果对象,请参考real_name_result

  • real_name_result

属性

类型

必填

描述

real_name_type

string(1)

实名认证申请类型。A支付宝,W微信

applement_stat

string(32)

微信/支付宝实名认证申请单状态(审核中;编辑中;待联系人确认;待法人确认;审核通过;审核失败;已冻结;已撤回)

authorize_stat

string(32)

微信/支付宝授权状态(未授权;已授权;已销户)

qrcode_data

string(256)

微信/支付宝授权二维码

fail_reason

string

实名失败原因

  • 响应示例

{
    "data": {
        "asyn_real_name_result": "[{\"applement_stat\":\"已撤回\",\"authorize_stat\":\"未授权\",\"real_name_type\":\"W\"}]",
        "prod_mode": "false",
        "request_id": "realname_0000000000000000004"
    },
    "message": "成功"
}

查询商户审核状态

商户可以查看提交的商户基础信息审核状态

  • 请求参数说明

属性

类型

必填

描述

subApiKey

string

商户子apiKey

  • 响应参数说明

属性

类型

必填

描述

audit_status

string

W -> 待补充,I -> 初始,P -> 通过,R -> 拒绝

sub_api_key

string

商户子apiKey

audit_desc

string

审核拒绝原因

创建应用

代理商帮商户创建应用

  • 请求参数说明

属性

类型

必填

描述

sub_api_key

string

商户子apiKey

app_name

string

应用名称,不能重复

  • 响应参数说明

属性

类型

必填

描述

app_id

string

应用id

查询应用

代理商查询商户应用列表

  • 请求参数说明

属性

类型

必填

描述

sub_api_key

string

商户子apiKey

  • 响应参数说明

属性

类型

必填

描述

application_list

string

"application_list":[{"app_name":"app1","app_id":"app_1"},{"app_name":"app2","app_id":"app2"}]

Event事件

类型

描述

queryEntryUser.succeeded

进件成功

userEntry.failed

进件失败(同步失败)

merchant.modify.succeeded

结算卡修改成功

merchant.modify.failed

结算卡修改失败

resident.succeeded

入驻成功

resident.failed

入驻失败

resident.modify.succeeded

入驻修改成功

resident.modify.failed

入驻修改失败

Event事件返回数据示例

  • queryEntryUser.succeeded - 进件成功

{
    "id": "202004038218089033333",
    "created_time": "1585888888",
    "prod_mode": "true",
    "type": "queryEntryUser.succeeded",
    "data": {
        "object": "queryEntryUser",
        "status": "succeeded",
        "prod_mode": "true",
        "request_id": "req_mer_20200403115903666666",
        "test_api_key": "api_test_364ac64b-xxxx-xxxx-xxxx-144411199999",
        "live_api_key": "api_live_bf636064-xxxx-xxxx-xxxx-ddd11ffe0000",
        "app_id_list": [{
            "app_id": "app_2fc6b8a4-xxxx-xxxx-xxxx-34eeee33bbbbb",
            "app_name": "test_17612762359",
            "cre_ts": 1585886351000,
            "cre_user": "0075757575757575",
            "id": 49045,
            "mer_cust_id": "0075757575757575",
            "remark": "",
            "stat": "N",
            "upd_ts": 1585886351000,
            "upd_user": "0075757575757575"
            }
        ],
        "sign_view_url": "https://xxx.xxxxxx.com/api/downloadContract?contractId=EieUFRY4eR6&digest=78F056245F32C28F5042781E66668888",
        "login_pwd": "Axxx6666"
    },
    "sign": "XMxvtaDk8b667s95/sxkw0PVsNyL4BR4c63xf+OseG1OCo7gYEQkTr5nvAyJ5Kn6fxnc/Z7lSkf4AisCPpcYHhgcpYBgWHtcuPmVA0P4Cv14+7A6ElN2+JxqjxwRzzbdVo6JCUEDRJR2CMhq6LIqX3RXwWyOHboEc1MtlCTKLHQ="
}
  • userEntry.failed - 进件失败

{
    "id": "0092021423952510000",
    "created_time": "1585891893",
    "prod_mode": "true",
    "type": "userEntry.failed",
    "data": {
        "object": "userEntry",
        "status": "failed",
        "error_type": "api_error",
        "error_msg": "营业执照认证失败",
        "prod_mode": "true",
        "request_id": "req_mer_20200403166666655555"
    },
    "sign": "i2Fi4MfCFkVC01FHSMTDuqfn6CiKUEwKLKNUTttfzR1AuHBdorHB6VJtm2QzHffUPibERsvO/NWNBEFSHfeZOc/QuXM0iHdvIsVKgehW30F5shPty6Vm9bUEMliEEPjUOP+YGzBa8Q8/zbRla1FVxZRYZUcPXcv503lAA9R39Cs="
}
  • merchant.modify.succeeded - 结算卡修改成功

{
    "created_time": "1681203753",
    "data": {
        "object": "merchant_modify",
        "status": "succeeded",
        "prod_mode": "false",
        "order_no": "test_bind_card_202304060011"
    },
    "prod_mode": "true",
    "sign": "test_Ly+foy6JYyK5Jmc8vZYig4Xc=",
    "id": "test_2023000088",
    "type": "merchant.modify.succeeded"
}
  • merchant.modify.failed - 结算卡修改失败

{
    "created_time": "1681203753",
    "data": {
        "object": "merchant_modify",
        "status": "failed",
        "prod_mode": "false",
        "order_no": "test_bind_card_202304060011"
    },
    "prod_mode": "true",
    "sign": "test_Ly+foy6JYyK5Jmc8vZYig4Xc=",
    "id": "test_2023000088",
    "type": "merchant.modify.failed"
}
  • resident.succeeded - 入驻成功

{
    "request_id": "20200221081000007999",
    "prod_mode": "true"
    "type": "resident.succeeded",
    "status": "succeeded",
    "object": "batchconf",
    "alipay_stat": {
        "message": "",
        "stat": "S"
    },
    "wx_stat": {
        "message": "",
        "stat": "S"
    },
    "wx_alipay_response": {
        "alipay": {
            "message": "",
            "stat": "S"
        },
        "alipay_lite": {
            "message": "",
            "stat": "S"
        },
        "alipay_qr": {
            "message": "",
            "stat": "S"
        },
        "alipay_scan": {
            "message": "",
            "stat": "S"
        },
        "alipay_wap": {
            "message": "",
            "stat": "S"
        },
        "wx_lite": {
            "message": "",
            "stat": "S"
        },
        "wx_pub": {
            "message": "",
            "stat": "S"
        },
        "wx_scan": {
            "message": "",
            "stat": "S"
        }
    }
}
  • resident.failed - 入驻失败

{
    "request_id": "req_cfg_20200220140530952000",
    "prod_mode": "true",
    "type": "resident.failed",
    "status": "failed",
    "object": "batchconf",
    "alipay_stat": {
        "message": "根据我公司风险监测系统的监测结果,你的账户可能存在风险,暂时不能创建。原因:黑名单校验不通过",
        "stat": "F"
    },
    "wx_stat": {
        "message": "",
        "stat": "S"
    },
    "wx_alipay_response": {
        "wx_lite": {
            "message": "",
            "stat": "F"
        },
        "wx_pub": {
            "message": "",
            "stat": "S"
        },
        "wx_scan": {
            "message": "",
            "stat": "S"
        }
    }
}
  • resident.modify.succeeded - 入驻修改成功

{
    "request_id": "",
    "prod_mode": "true",
    "type": "resident.modify.succeeded",
    "alipay_stat": "S",
    "wx_stat": "S",
    "object": "resident_modify",
    "status": "succeeded",
    "error_code": "",
    "error_msg": ""
}
  • resident.modify.failed - 入驻修改失败

{
    "request_id": "",
    "prod_mode": "true",
    "type": "resident.modify.failed",
    "alipay_stat": "S",
    "wx_stat": "F",
    "object": "resident_modify",
    "status": "failed",
    "error_code": "modify_err",
    "error_msg": "微信入驻修改失败原因:商户简称或商户全称距离上一次修改时间不足30天,暂不支持修改;"
}

附件