alipay.overseas.secmerchant.maintain.queryStatus
Call this interface to query the registration status of secondary merchants for in-store payments.
Request
Service address:
Environment | HTTPS request URL |
Production environment | https://intlmapi.alipay.com/gateway.do |
Test environment | https://mapi.alipaydev.com/gateway.do |
Request parameters
Parameter | Description |
Basic parameter | |
service String Required | Interface name
|
partner String(16) Required | The partner ID that is assigned by Alipay to identify an Alipay account. The partner ID is composed of 16 digits and begins with 2088.
|
_input_charset String Required | The charset with which the request data is encoded. UTF-8, GBK, and GB2312 are supported.
|
sign_type String Required | Sign type. RSA, RSA2 and MD5 are supported. Use uppercase.
|
sign String Required | Sign value
|
timestamp String Required | The time when the merchant server sends request. The time is in GMT+8, and in a format of yyyy-MM-dd HH:mm:ss.By default, the request expires in 30 minutes.
|
Business parameter | |
secondary_merchant_id String(64) Required | The unique ID assigned by the partner to identify a secondary merchant. The ID can contain letters, numbers, and underscores.
|
store_id String(64) Required | The store ID assigned by the partner to identify a store, which needs to be unique for each group of PID and MID. This field is required when the value of payment_method is INSTORE_PAYMENT.
|
payment_method String Required | Payment method of the secondary merchant, the value is INSTORE_PAYMENT for offline payments.
|
Note:
Do not use the halfwidth quotation mark (") in parameter values.
Response
Synchronous response
The response is in XML format.
Error codes
Business logic errors
Returned result | Description |
PARAM_ILLEGAL | Required parameters are not entered or illegal parameters entered. The illegal parameter might be too long, or with incorrect format. Enter the correct parameters and send the request again. |
DATA_NOT_EXIST | No data exists for the queried secondary merchant because the merchant is not registered. Register the secondary merchant to Alipay system before you query the registration status. |
SYSTEM_ERROR | Alipay system error. Try again later. |
Samples
Request
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
Response
The request succeeds and the query result is returned:
<?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>
Failed to get the query result:
<?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>