Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

境外二级线上商户报备接口

境外线上二级商户同步接口用于机构同步二级商户到支付宝系统中完成商户信息报备。

网关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

请求参数

参数类型(字节长度)描述可选示例

基本参数

serviceString接口名称不可空alipay.overseas.secmerchant.online.maintain
partnerString(16)

合作者身份ID。签约的支付宝账号对应的支付宝唯一用户号。

以2088开头的16位纯数字组成。

不可空2088101142878662
_input_charsetString参数编码字符集。商户网站使用的编码格式,如utf-8、gbk、gb2312等。不可空gbk
sign_typeString签名方式。

RSA、RSA2、MD5三个值可选,必须大写。

不可空MD5
signString签名不可空2118ac8fad6bc1d9e88a6cd017c18d37
timestampString时间戳。接口的调用时间,支付宝会在一定时间内失效此调用(默认半小时)。此时间目前以北京时间为准,格式为 :yyyy-MM-dd HH:mm:ss。不可空2012-12-21 17:11:16
业务参数
secondary_merchant_nameString(64)二级商户的法定注册名称,该名称会出现在钱包和对账文件当中,用来识别二级商户。备注:如果二级商户类型是个人(INDIVIDUAL),请填写该负责人的法定全名于本字段。不可空Alipay.com Co.,Ltd
secondary_merchant_idString(64)二级间连商户ID,支持字母,数字及下划线(_)。不可空63472327348
secondary_merchant_industryString(4)行业类型,用于区分不同行业。详情请参见 MCC list不可空MCC list
register_countryString(2)注册国家,由ISO3166二位字母编码表示。请参见 ISO 3166不可空HK
register_addressString(256)二级商户注册地址。务必使用邮寄地址形式。不可空No.278, Road YinCheng, Shanghai, China
site_infosString

商户网址名称,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_typeString

二级商户类型:

  • 若二级商户为个体户,字段值为INDIVIDUAL。
  • 若二级商户为企业、公司、信托或非盈利组织等,字段值为ENTERPRISE。
不可空INDIVIDUAL
registration_noString(128)

企业注册号

备注: 若二级商户类型为个人(INDIVIDUAL)且无注册号,本字段可为空。

可空012345678
shareholder_nameString(64)二级商户主要股东的法定全名。本字段仅在二级商户类型为ENTERPRISE时,才需填写。可空Jack Li (股东为个人), Alipay.com Co.,Ltd (股东为企业)
shareholder_idString(128)二级商户主要股东的身份证件号、护照号、或企业注册号码。本字段仅在二级商户类型为ENTERPRISE时,才需填写。可空G53453888 (股东为个人), 012345678 (股东为企业)
representative_nameString(64)负责人法定全名。仅当二级商户类型为INDIVIDUAL时,本字段为必填;如果二级商户类型为ENTERPRISE, 本字段可为空。可空Tom Li
representative_idString(128)负责人的身份证件号或护照号。仅当二级商户类型为INDIVIDUAL时,本字段为必填;如果二级商户类型为ENTERPRISE, 本字段可为空。可空123456789
settlement_noString(64)二级商户结算卡银行卡号,仅支持字母和数字。可空2600100000
contact_noString(64)二级商户的联系人电话, 仅支持数字和+-()等特殊字符。可空+86139xxxx7893
contact_emailString(128)二级商户的联系人邮箱可空tomli@gmail.com
cs_noString(64)二级商户的客服电话,仅支持数字和+-()等特殊字符。可空0213355xxx89
cs_emailString(128)二级商户的客服邮箱可空customerservice@xxxcompany.com

二级参数

site_infos

参数类型(字节长度)描述可选示例
site_typeString网站类型,网址或者APP下载地址只能是WEB或者APP,字母区分大小写。不可空WEB
site_urlString(256)

网址URL。

  • 当site_type为WEB时,传入的URL格式为:http/https + SLD + TLD,例如: https://www.alipay.com;
  • 当site_type为APP时,传入以http/https开始的APP下载URL,例如:https://itunes.apple.com/cn/app/id333206289。
不可空https://www.alipay.com
site_nameString(512)站点名称可空xx 店

 Note:

部分参数类型为String,未指明长度范围,表明系统不校验该参数的长度。

同步返回

响应将以XML格式返回。

参数类型(字节长度)描述可选示例
基本参数
is_successString

请求是否成功。请求成功不代表业务处理成功。

  • T代表成功
  • F代表失败
不可空T
sign_typeString签名方式,RSA、RSA2、MD5三个值可选,必须大写。可空MD5
signString签名可空3afc92ac4708425ab74ecb2c4e58ef56
errorString
  • 请求成功时,不存在本参数;
可空PARAM_ILLEGAL
result_codeString请求结果码。此字段仅在is_success字段值为T时会被返回。可空SUCCESS

Note:

同步返回的参数随支付宝服务端的演化,可能会返回更多的节点,需要程序使用方对文档说明以外的节点予以忽略。

返回示例

业务正常受理并报备成功:

copy
<?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>

请求成功,业务处理失败:

copy
<alipay>
<is_success>F</is_success>
<error>PARAM_ILLEGAL</error>
<sign>ba101b7ffb43afde9ba63c0de335218e</sign>
<sign_type>MD5</sign_type>
</alipay>

请求失败或者接入数据错误时输出:

copy
<?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_SERVICEService参数不正确
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_TIMEOUTsession超时
ILLEGAL_TARGET_SERVICE错误的target_service
ILLEGAL_ACCESS_SWITCH_SYSTEM商户不允许访问该类型的系统
EXTERFACE_IS_CLOSED接口已关闭