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

      线下二级商户报备信息查询接口(条码支付)

      调用此接口可查询境外线下二级商户的报备状态。


      #网关URL


      #请求参数

      参数描述
      基本参数

      service

      String 不可空

      接口名称

      示例:alipay.overseas.secmerchant.maintain.queryStatus

      partner

      String(16) 不可空

      支付宝分配的用于标识支付宝帐户的合作伙伴ID。合作伙伴ID是2088开头的16位数字。

      示例:2088*********662

      _input_charset

      String 不可空

      请求数据的编码集,支持UTF-8,GBK和GB2312。

      示例:UTF-8

      sign_type

      String 不可空

      签名类型。支持RSA,RSA2和MD5。请务必使用大写形式。

      示例:MD5

      sign

      String 不可空

      签名值

      示例:2118ac8fad6bc1d9e88a6cd017c18d37

      timestamp

      String 不可空

      商户服务器发出请求的北京时间,格式为yyyy-MM-dd HH:mm:ss。默认情况下,请求会在30分钟后过期。

      示例:2019-02-01 08:30:10

      业务参数

      secondary_merchant_id

      String(64) 不可空

      合作伙伴分配的用于标识二级商户的唯一ID。ID可以包含字母、数字和下划线。

      示例:MERCHANT_ID_0003

      store_id

      String(64) 不可空

      合作伙伴分配的用于标识二级商户商店的唯一ID。相同PID或MID下店铺ID需唯一。当payment_method字段的值为INSTORE_PAYMENT时,此字段必传。

      示例:STORE_ID_0003

      payment_method

      String 不可空

      二级商户支付方式。对于线下商户,此字段值为INSTORE_PAYMENT,表示线下支付。

      示例:INSTORE_PAYMENT


      #异步返回

      参数描述

      sign

      String

      签名值

      示例:2118ac8fad6bc1d9e88a6cd017c18d37

      sign_type

      String

      签名算法,支持RSA,RSA 2和MD5,使用大写字母。

      示例:MD5

      secondary_merchant_id

      String 不可空

      二级间连商户ID,相同PID下二级间连商户ID需唯一。ID可包含字母、数字和下划线。

      示例:MERCHANT_ID_0003

      store_id

      String 不可空

      店铺ID,相同PID或MID下店铺ID需唯一。当payment_method字段的值为INSTORE_PAYMENT时,此字段必传。

      示例:STORE_ID_0003

      status

      String 不可空

      二级商户最近一次报备或者更新的状态。如果二级商户报备或更新成功,值为SUCCESS;如果二级商户报备仍在处理中,值为UNDER_REVIEW;如果二级商户更新仍在处理中,值为MODIFICATION_REVIEW;如果二级商户报备或更新失败,值为FAILED。

      示例:SUCCESS

      reject_reason

      String 不可空

      商户未能成功报备的原因。报备失败的原因可能为高危商户或者由于安全原因。当报备状态为FAILED时,本字段不可空。

      示例:High risk merchant, registration reject.

      payment_method

      String 不可空

      二级商户的支付方式。对于线下商户,此字段值为INSTORE_PAYMENT,表示线下支付。

      示例:INSTORE_PAYMENT

      partner

      String(16) 不可空

      支付宝分配的用于标识支付宝帐户的合作伙伴ID。合作伙伴ID是2088开头的16位数字。

      示例:2088*********662

      secondary_merchant_name

      String(128) 不可空

      二级商户的法定注册名称,将显示在钱包和对账文件中,用于标识二级商户。

      注意:如果二级商户类型为个人,请在此字段中填写个体负责人的法定全名。

      示例:Alipay (China) Network Technology Co., Ltd

      secondary_merchant_type

      String 不可空

      二级商户类型,可填入的值如下:

      • INDIVIDUAL: 个人独资或个体户
      • ENTERPRISE: 有限公司、私人公司、合伙企业、有限责任合伙企业(LLP)、有限责任公司(LLC)、S类公司(S Corp)、C类公司(C Corp)、信托或非营利组织(NPO)

      示例:INDIVIDUAL

      registration_no

      String(128)

      商业注册文件上指定的商业登记号

      注意:当二级商户类型是INDIVIDUAL且没有登记号时,不需要填写此字段。

      示例:012345678

      register_country

      String(2) 不可空

      商店注册国家或地区,请使用ISO 3166中定义的两个字母的国家或地区代码。

      示例:HK

      register_address

      String(256)

      商业注册文件上指定的商业登记地址。使用邮政地址格式。

      示例:No.277, Road YinCheng, Shanghai, China

      shareholder_name

      String(128)

      二级商户主要股东的法定名称。仅当二级商户类型为ENTERPRISE时需填写此字段。

      示例:Jack Li (if the shareholder is an individual), Alipay.com Co.,Ltd (if the shareholder is an enterprise)

      shareholder_id

      String(128)

      二级商户主要股东的身份证号、护照号码或商业登记号码。仅当二级商户类型为ENTERPRISE时需填写此字段。

      示例:G53453888 (if the shareholder is an individual), 012345678 (if the shareholder is an enterprise)

      representative_name

      String(128)

      个体负责人的法定全名。仅当二级商户类型为INDIVIDUAL时指定此字段。如果二级商户类型为ENTERPRISE,则此字段非必填。

      示例:Tom Li

      representative_id

      String(128)

      个体负责人的身份证或护照号码。仅当二级商户类型为INDIVIDUAL时指定此字段。如果二级商户类型为ENTERPRISE,则此字段非必填。

      示例:123456789

      settlement_no

      String(64)

      二级商户的结算银行卡号,仅支持字母和数字。

      示例:2600100000

      contact_no

      String(64)

      二级商户联系电话,仅支持数字及特殊字符+-()

      示例:186xxxx0000

      contact_email

      String(128)

      二级商户联系邮箱

      示例:tomli@gmail.com

      cs_no

      String(64)

      二级商户的客服电话,仅支持数字及特殊字符+-()

      示例:952xx

      cs_email

      String(128)

      二级商户客服邮箱

      示例:customerservice@xxxcompany.com

      store_name

      String(256) 不可空

      商店名称。对于出租车和豪华轿车(MCC 4121),请填写车牌号。

      示例:Apple store

      store_country

      String(2) 不可空

      商店注册国家或地区,请使用ISO 3166中定义的两个字母的国家或地区代码。

      示例:HK

      store_address

      String(330) 不可空

      报备的商店地址。请使用邮政地址格式。

      示例:No.276, Road YinCheng, Shanghai

      store_industry

      String(4) 不可空

      商店的4位MCC代码。关于MCC代码,详情参见MCC list

      示例:4121

      internal_store_photo

      String(256)

      商店内部照片的URL

      示例:http://testmerchant.com/

      external_storefront_photo

      String(256)

      商店外部照片的URL

      示例:URL

      store_status

      String 不可空

      店铺状态。如果店铺归档,店铺信息无法审核,值为ARCHIVED;如果店铺注册成功,值为ACTIVATED;如果店铺尚未注册,值为INACTIVATE。

      示例:ACTIVATED


      #业务错误码

      返回结果描述
      PARAM_ILLEGAL

      参数校验错误,必填参数未填或者输入的参数不正确。错误参数太长或者格式不正确。

      解决方案:输入正确参数,并且重新发送请求。

      DATA_NOT_EXIST

      因为商户未报备,查询的二级商户数据不存在。

      解决方案:向支付宝系统报备该二级商户之后,再进行报备状态查询。

      SYSTEM_ERROR

      未知系统错误

      解决方案:请稍后再试。


      #示例

      #请求示例

      https://intlmapi.alipay.com/gateway.do?service=alipay.overseas.secmerchant.maintain.queryStatus&partner=208xxxxxxxxx8155&_input_charset=UTF-8&sign_type=MD5&secondary_merchant_id=1314520&store_id=1993&payment_method=INSTORE_PAYMENT&sign=25eb3ada4aed712cabc5fcbed4a58693


      #返回示例

      请求成功的返回示例:

      copy
      <?xml version="1.0" encoding="utf-8"?>
      <alipay>
          <is_success>T</is_success>
      <request>
          <param name="store_id">STORE_ID_0003</param>
          <param name="partner">2088101131367863</param>
          <param name="service">alipay.overseas.secmerchant.maintain.queryStatus</param>
          <param name="sign">9c4643447830d870b56c8181643da9e4</param>
          <param name="sign_type">MD5</param>
          <param name="_input_charset ">gbk</param>
          <param name="timestamp ">2012-12-21 17:11:16</param>
          <param name="_input_charset ">gbk</param>
          <param name="payment_method">INSTORE_PAYMENT</param>
          <param name="secondary_merchant_id">MERCHANT_ID_0003</param>
      </request>
      <response>
          <alipay>
              <secondary_merchant_id>MERCHANT_ID_0003</secondary_merchant_id>
              <status>UNDER_REVIEW</status>
              <store_id>STORE_ID_0003</store_id>
              <payment_method>OFFLINE_PAYMENT</payment_method>
              <partner_id>2088101142878662</partner_id>
              <secondary_merchant_name>Alipay (China) Network Technology Co., Ltd</secondary_merchant_name>
              <secondary_merchant_type>INDIVIDUAL</secondary_merchant_type>
              <registration_no>012345678</registration_no>
              <register_country>HK</register_country>
              <register_address>No.278, Road YinCheng, Shanghai, China</register_address>
              <shareholder_name>Jack Li</shareholder_name>
              <shareholder_id>G53453888</shareholder_id>
              <representative_name>Tom Wang</representative_name>
              <representative_id>3524674343326</representative_id>
              <settlement_no>2600100000</settlement_no>
              <contact_no>+86139xxxx7893</contact_no>
              <contact_email>tomli@gmail.com</contact_email>
              <store_name>Storename</store_name>
              <store_industry>4121</store_industry>
              <store_country>HK</store_country>
              <store_address>No.276, Road YinCheng, Shanghai</store_address>
              <store_status>ACTIVATED</store_status>
          </alipay>
      </response>
      <sign>a109ce66ba5b825759927c00be3259fa</sign>
      <sign_type>MD5</sign_type>
      </alipay>


      未能获取查询结果的返回示例:

      copy
      <?xml version="1.0" encoding="utf-8"?>
      <alipay>
      <is_success>F</is_success>
      <error>DATA_NOT_EXIST</error>
      <sign>6dff2d017f284ca0147fc8f6891b4cb2</sign>
      <sign_type>MD5</sign_type>
      </alipay>