境外二级线上商户报备接口
境外线上二级商户同步接口用于机构同步二级商户到支付宝系统中完成商户信息报备。
网关URL
环境 | HTTPS请求URL |
生产环境 | https://intlmapi.alipay.com/gateway.do |
测试环境 | https://mapi.alipaydev.com/gateway.do |
Note:
如果您使用的是POST方法, 需在请求URL当中标明_input_charset的编码格式。例如,https://mapi.alipaydev.com/gateway.do?_input_charset=UTF-8
请求参数
参数 | 类型(字节长度) | 描述 | 可选 | 示例 |
基本参数 | ||||
service | String | 接口名称 | 不可空 | alipay.overseas.secmerchant.online.maintain |
partner | String(16) | 合作者身份ID。签约的支付宝账号对应的支付宝唯一用户号。 以2088开头的16位纯数字组成。 | 不可空 | 2088101142878662 |
_input_charset | String | 参数编码字符集。商户网站使用的编码格式,如utf-8、gbk、gb2312等。 | 不可空 | gbk |
sign_type | String | 签名方式。 RSA、RSA2、MD5三个值可选,必须大写。 | 不可空 | MD5 |
sign | String | 签名 | 不可空 | 2118ac8fad6bc1d9e88a6cd017c18d37 |
timestamp | String | 时间戳。接口的调用时间,支付宝会在一定时间内失效此调用(默认半小时)。此时间目前以北京时间为准,格式为 :yyyy-MM-dd HH:mm:ss。 | 不可空 | 2012-12-21 17:11:16 |
业务参数 | ||||
secondary_merchant_name | String(64) | 二级商户的法定注册名称,该名称会出现在钱包和对账文件当中,用来识别二级商户。备注:如果二级商户类型是个人(INDIVIDUAL),请填写该负责人的法定全名于本字段。 | 不可空 | Alipay.com Co.,Ltd |
secondary_merchant_id | String(64) | 二级间连商户ID,支持字母,数字及下划线(_)。 | 不可空 | 63472327348 |
secondary_merchant_industry | String(4) | 行业类型,用于区分不同行业。详情请参见 MCC list。 | 不可空 | MCC list |
register_country | String(2) | 注册国家,由ISO3166二位字母编码表示。请参见 ISO 3166。 | 不可空 | HK |
register_address | String(256) | 二级商户注册地址。务必使用邮寄地址形式。 | 不可空 | No.278, Road YinCheng, Shanghai, China |
site_infos | String | 商户网址名称,json格式,最长5个网站或app url。详见 site_infos。 添加或删除URL,请重新传入此参数。 | 不可空 | 二级商户网站或APP URL,格式: [{"site_type":"WEB","site_url":"https://alipay.com","site_name":"w ebsit"}, {"site_type":"APP","site_url":"https://alipay.com","site_name":"we bsit"}] |
secondary_merchant_type | String | 二级商户类型:
| 不可空 | INDIVIDUAL |
registration_no | String(128) | 企业注册号 备注: 若二级商户类型为个人(INDIVIDUAL)且无注册号,本字段可为空。 | 可空 | 012345678 |
shareholder_name | String(64) | 二级商户主要股东的法定全名。本字段仅在二级商户类型为ENTERPRISE时,才需填写。 | 可空 | Jack Li (股东为个人), Alipay.com Co.,Ltd (股东为企业) |
shareholder_id | String(128) | 二级商户主要股东的身份证件号、护照号、或企业注册号码。本字段仅在二级商户类型为ENTERPRISE时,才需填写。 | 可空 | G53453888 (股东为个人), 012345678 (股东为企业) |
representative_name | String(64) | 负责人法定全名。仅当二级商户类型为INDIVIDUAL时,本字段为必填;如果二级商户类型为ENTERPRISE, 本字段可为空。 | 可空 | Tom Li |
representative_id | String(128) | 负责人的身份证件号或护照号。仅当二级商户类型为INDIVIDUAL时,本字段为必填;如果二级商户类型为ENTERPRISE, 本字段可为空。 | 可空 | 123456789 |
settlement_no | String(64) | 二级商户结算卡银行卡号,仅支持字母和数字。 | 可空 | 2600100000 |
contact_no | String(64) | 二级商户的联系人电话, 仅支持数字和+-()等特殊字符。 | 可空 | +86139xxxx7893 |
contact_email | String(128) | 二级商户的联系人邮箱 | 可空 | tomli@gmail.com |
cs_no | String(64) | 二级商户的客服电话,仅支持数字和+-()等特殊字符。 | 可空 | 0213355xxx89 |
cs_email | String(128) | 二级商户的客服邮箱 | 可空 | customerservice@xxxcompany.com |
二级参数
site_infos
参数 | 类型(字节长度) | 描述 | 可选 | 示例 |
site_type | String | 网站类型,网址或者APP下载地址只能是WEB或者APP,字母区分大小写。 | 不可空 | WEB |
site_url | String(256) | 网址URL。
| 不可空 | https://www.alipay.com |
site_name | String(512) | 站点名称 | 可空 | xx 店 |
Note:
部分参数类型为String,未指明长度范围,表明系统不校验该参数的长度。
同步返回
响应将以XML格式返回。
Note:
同步返回的参数随支付宝服务端的演化,可能会返回更多的节点,需要程序使用方对文档说明以外的节点予以忽略。
返回示例
业务正常受理并报备成功:
<?xml version="1.0" encoding="utf-8"?>
<alipay>
<is_success>T</is_success>
<request>
<param name="secondary_merchant_industry">5935</param>
<param name="_input_charset">UTF-8</param>
<param name="sign">8457f906bf89a5e444a6e5c28f8da499</param>
<param name="site_infos">
[{"site_type":"WEB","site_url":"https://alipay.com","site_name":"websit"}]
</param>
<param name="secondary_merchant_id">100510000031</param>
<param name="register_address">No.278, Road YinCheng, Shanghai, China</param>
<param name="partner">2088131089302823</param>
<param name="service">alipay.overseas.secmerchant.online.maintain</param>
<param name="secondary_merchant_name">test1</param>
<param name="register_country">HK</param>
<param name="sign_type">MD5</param>
<param name="timestamp">2018-10-09 16:04:16</param>
<param name="secondary_merchant_type">INDIVIDUAL</param>
<param name="registration_no">012345678</param>
<param name=“representative_name”>Tom Li</param>
<param name=“representative_id”>123456789 Li</param>
<param name="settlement_no">2600100000</param>
<param name="contact_no">+86139xxxx7893 </param>
<param name="contact_email">tomli@gmail.com </param>
</request>
<response>
<alipay>
<result_code>SUCCESS</result_code>
</alipay>
</response>
<sign>744a87f0e3b40e6a8cd8f9705ce61511</sign>
<sign_type>MD5</sign_type>
</alipay>
请求成功,业务处理失败:
<alipay>
<is_success>F</is_success>
<error>PARAM_ILLEGAL</error>
<sign>ba101b7ffb43afde9ba63c0de335218e</sign>
<sign_type>MD5</sign_type>
</alipay>
请求失败或者接入数据错误时输出:
<?xml version="1.0" encoding="utf-8"?>
<alipay>
<is_success>F</is_success>
<error>ILLEGAL_PARTNER</error>
</alipay>
错误码
业务错误码
错误代码 | 描述 |
REGISTER_COUNTRY_FORBIDDEN | 如果注册国家在反洗钱国家范围内,则不允许报备。 |
PARAM_ILLEGAL | 参数格式不合法,如超长或者非空的参数未传等。请根据接口文档检查参数格式。 |
SYSTEM_ERROR | 支付宝系统错误 |
DUPLICATE_REQUEST | 重复请求,报备审核还未处理结束。 |
MERCHANT_TYPE_ILLEGAL | 二级商户类型不正确。secondary_merchant_type字段的值仅能为ENTERPRISE或INDIVIDUAL。 |
BUSINESS_NAME_UPDATE_FORBIDDEN | 公司名称不允许修改 |
REGISTRATION_NO_UPDATE_FORBIDDEN | 公司注册号不允许修改 |
REGISTER_COUNTRY_UPDATE_FORBIDDEN | 公司注册国家不允许修改 |
MERCHANT_TYPE_UPDATE_FORBIDDEN | 公司属性不允许修改 |
REPRESENTATIVE_NAME_UPDATE_FORBIDDEN | representative_name不允许修改 |
REPRESENTATIVE_ID_UPDATE_FORBIDDEN | representative_id不允许修改 |
接入错误
错误代码 | 描述 |
ILLEGAL_SIGN | 签名不正确 |
ILLEGAL_DYN_MD5_KEY | 动态密钥信息错误 |
ILLEGAL_ENCRYPT | 加密不正确 |
ILLEGAL_ARGUMENT | 参数不正确 |
ILLEGAL_SERVICE | Service参数不正确 |
ILLEGAL_USER | 用户ID不正确 |
ILLEGAL_PARTNER | 合作伙伴ID不正确 |
ILLEGAL_EXTERFACE | 接口配置不正确 |
ILLEGAL_PARTNER_EXTERFACE | 合作伙伴接口信息不正确 |
ILLEGAL_SECURITY_PROFILE | 未找到匹配的密钥配置 |
ILLEGAL_AGENT | 代理ID不正确 |
ILLEGAL_SIGN_TYPE | 签名类型不正确 |
ILLEGAL_CHARSET | 字符集不合法 |
HAS_NO_PRIVILEGE | 无权访问 |
INVALID_CHARACTER_SET | 字符集无效 |
系统错误
当出现系统错误提示时,请联系支付宝技术支持 。
错误代码 | 描述 |
SYSTEM_ERROR | 支付宝系统错误 |
SESSION_TIMEOUT | session超时 |
ILLEGAL_TARGET_SERVICE | 错误的target_service |
ILLEGAL_ACCESS_SWITCH_SYSTEM | 商户不允许访问该类型的系统 |
EXTERFACE_IS_CLOSED | 接口已关闭 |