alipay.intl.merchant.common.indirectMerchant.query

Call this interface to query the registration status of secondary merchants for both online and offline payments.  

#Request

#Service address

#Request Parameters

ParameterDescription
Basic Parameter

function

String(128) Required

Service Name

Example:alipay.intl.merchant.common.indirectMerchant.query

version

String(8) Required

The API version 

Example:2.0.4

clientId

String(32) Required

A unique partner ID to identify a contracted Alipay Account.

Example:2014000014442

reqTime

Date time Required

Date time with timezone, see RFC 3339 Section 5.6 for details.

Example:2001-07-04T12:08:56+05:30

reqMsgId

String(64) Required

The unique ID assigned by the client to identify a request message. Note: The reqMsgId identifies a unique system request, but it is not used to identify a unique business request. 

Example:123xxxxxxxxxxxxxxx3fda

reserve

String(256)

Key-Value formatted parameter for future use. This parameter is required when you are an ISV. If you are an ISV, you need to provide the isvAccesstoken value. 

Example:{"isvAccesstoken":123123123sdfsddsf}

Business Parameter

merchantId

String(64) Required

A unique partner ID to identify a contracted Alipay Account.

Example:21020000001

sellerId

String(32)

A unique ID assigned by the partner to identify a secondary merchant. The ID can contain letters, numbers, and underscores. 

Example:83410102

storeId

String(32)

Store ID, need to be unique for each group of PID and MID. This parameter is only for the OFFLINE payment.

Example:STORE_ID_0003

paymentScene

String

Payment method of the secondary merchant, the value is ONLINE for online payments and is OFFLINE for offline payments.

Example:ONLINE


#Sync Response

ParameterDescription
Basic parameters

version

String(8) Required

The API version 

Example:2.0.4

function

String(128) Required

Service Name

Example:alipay.intl.merchant.common.indirectMerchant.query

clientId

String(32) Required

A unique partner ID to identify a contracted Alipay Account.

Example:2014000014442

reqTime

Date time Required

Date time with timezone, see RFC 3339 Section 5.6 for details.

Example:2001-07-04T12:08:56+05:30

reqMsgId

String(64) Required

The unique ID assigned by the client to identify a request message. Note: The reqMsgId identifies a unique system request, but it is not used to identify a unique business request. 

Example:123xxxxxxxxxxxxxxx3fda

reserve

String(256)

Key-Value formatted parameter for future use. This parameter is required when you are an ISV. If you are an ISV, you need to provide the isvAccesstoken value. 

Example:{"isvAccesstoken":123123123sdfsddsf}

Business parameters

resultInfo

ResultInfo Required

See resultInfo for details. 

Example:{ "resultStatus": "S", "resultCodeId": "00000000", "resultCode":"SUCCESS", "resultMsg": "result message" }

sellerInfo

SellerInfo Required

Seller information, see sellerInfo for details. 

Example:{ "sellerId": "58000001", "sellerName": "Alipay (China) Network Technology Co., Ltd", "sellerType":"ENTERPRISE", "registrationNo": "83720154037071","registrationCountry": "CN","registrationAddress": "Shanghai","representativeName": "Zhangsan","representativeId": "69833444422","settlementNo": "1551263547569833","contactNo": "086+13001720000","contactEmail": "Zhangsan@alipay.com"}

storeInfo

storeInfo

Store information. See storeInfo for details.Note:This field is only for offline merchants. 

Example:{"storeId": "569833","storeName": "ShopName","storeIndustry": "8501","internalStorePhoto": "www.alipay.com/internalStorePhoto.jpg","externalStorefrontPhoto": "www.alipay.com/externalStorePhoto.jpg","customerServiceNo": "086+13701720000","customerServiceEmail": "

registrationStatus

String(20)

The status of the latest registration or update.The value can be one of the following item.

  • SUCCESS: The latest registration or update succeeds.
  • UNDER_REVIEW: The latest registration is under review.
  • MODIFICATION_REVIEW: The latest update is under review.
  • FAILED: The latest registration or update is failed and the reject_reason field will be returned.

Note:This field is required when resultinfo.resultCode=SUCCESS. 

Example:SUCCESS

rejectReason

String(512)

The reason that the merchant is not registered successfully.

Example:High risk merchant, registration reject.

storeStatus

String

Store status. The value can be one of the following items.ARCHIVED: The store is archived, so that the store information cannot be viewed.ACTIVATED: The store is registered successfully.INACTIVATED: The store is not registered. 

Example:ACTIVATED

extendInfo

String(2048)

Reserved for extended information 

Example:{}


#Sub-parameters

#resultInfo

ParameterDescription

resultStatus

String(2) Required

The request status can be:S: successF: failureU: unknown

Example:S

resultCodeId

String(8) Required

An 8-digit code that is used to identify a result. When resultStatus is S, the value must be 00000000. When resultStatus is F or U, the value can be other result ID specified by the interface. 

Example:00000000

resultCode

String(64) Required

The result code 

Example:SUCCESS

resultMsg

String(256)

When resultCode is S, this value can be empty. When resultCodeis F or U, the error description is required.

Example:success

#

#sellerInfo

ParameterDescription

sellerId

String(32)

A unique ID assigned by the partner to identify a secondary merchant. The ID can contain letters, numbers, and underscores. 

Example:123456

sellerName

String(128) Required

The name of the secondary merchant 

Example:Alipay (China) Network Technology Co., Ltd

sellerMcc

String(10)

Merchant category code of the seller. This field is only for online merchants. 

Example:1402

paymentScene

String Required

Specify the payment scene. The value isONLINE if the payment is an online payment; The value isOFFLINE if the payment is an offline payment. 

Example:ONLINE

sellerType

String(20)

Secondary merchant type, the value can be INDIVIDUAL for the sole proprietorship or ENTERPRISE for the limited company, private company, partnership, limited liability partnership (LLP), limited liability company (LLC), S corporation (S Corp), C corporation (C Corp), trust, or nonprofit organization (NPO) 

Example:INDIVIDUAL

siteInfos

String

This field is in JSON format and can contain up to 5 website URLs or app download URLs. See site_infos for details.URLs in this field cannot be updated incrementally. To add or remove URLs, re-pass the value again.This field is only for online merchants. 

Example:[{"siteType":"WEB","siteUrl":"https://alipay.com","siteName":"websit"},{"siteType":"APP","siteUrl":"https://alipay.com","siteName":"websit"}]

registrationNo

String(128) Required

Business registration number specified on the business registration document.Note: This field is not required when the secondary merchant type is INDIVIDUAL and no registration number exists. 

Example:012345678

registrationCountry

String(2)

Registration country of the secondary merchant, specified by a 2-letter code defined in ISO 3166. For more details about the 2-letter country code, see ISO 3166. 

Example:HK

registrationAddress

String(800)

Business registration address specified on the business registration document. Use postal address format.

Example:No.278, Road YinCheng, Shanghai, China

shareholderName

String(128)

Legal name of the primary shareholder of the secondary merchant. Specify this field only when the secondary merchant type is ENTERPRISE. 

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

shareholder_id

String(128)

ID or passport number, or business registration number of the primary shareholder of the secondary merchant. Specify this field only when the secondary merchant type is ENTERPRISE.

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

representativeName

String(128)

Full legal name of the business owner. Specify this field only when the secondary merchant type is INDIVIDUAL. This field is optional if the secondary merchant type is ENTERPRISE. 

Example:Tom Li

representativeId

String(128)

ID or passport number of the business owner. Specify this field only when the secondary merchant type is INDIVIDUAL. This field is optional if the secondary merchant type is ENTERPRISE. 

Example:123456789

settlementNo

String(128)

Settlement bank account number of the secondary merchant, letters and numbers only 

Example:2600100000

contactNo

String(40)

Contact phone number of the secondary merchant, numbers and special characters +-() only 

Example:+86139xxxx7893

contactEmail

String(64)

Contact email address of the secondary merchant

Example:tomli@gmail.com

customerServiceNo

String(64)

Customer service phone number of the secondary merchant, numbers and special characters +-() only 

Example:0213355xxx89

customerServiceEmail

String(256)

Customer service email address of the secondary merchant

Example:customerservice@xxxcompany.com


#storeInfo

ParameterDescription

storeId

String(32) Required

Store ID. For taxicabs and limousines (MCC 4121), use the license plate number. 

Example:23372327348

storeName

String(128) Required

Store name. For taxicabs and limousines (MCC 4121), use the license plate number. 

Example:StoreName

storeMcc

String(10)

A 4-digit MCC code of the store. See MCC list for details.

Example:4121

storeCountry

String(10)

Store registration country. A 2-letter code defined in ISO 3166. 

Example:HK

storeAddress

String(1024)

Registered store address. Use postal address format.

Example:Store address

internal_store_photo

String(256)

URL of the store interior photo. 

Example:URL

external_storefront_photo

String(256)

URL of the store exterior photo. 

Example:URL


#Business Logic Errors

Returned resultDescriptionSolution

MERCHANT_DATA_NOT_FOUND

The merchant data not found.

Enter the correct parameters and send the request again.

#Result code

#Basic result code

resultCodeId

resultCode

resultStatus

Remarks

00000000

SUCCESS

S

Success

00000019

PROCESS_FAIL

F

General business failure

00000901

UNKNOWN_EXCEPTION

U

API failed because of unknown reasons

00000004

PARAM_ILLEGAL

F

The parameter is incorrect.

00000007

INVALID_SIGNATURE

F

The signature is invalid.

00000008

KEY_NO_FOUND

F

The key is not found.

00000014

API_IS_INVALID

F

The API is invalid or nonactivated.

00000016

OAUTH_FAILED

F

The oAuth authentication failed.

00000021

ACCESS_DENIED

F

Access denied

00000024

REQUEST_TRAFFIC_EXCEED_LIMIT

F

The request traffic exceeds the limit.

12014152

CLIENT_FORBIDDEN_ACCESS_API

F

The Client is not authorized to use this API.

12014155

UNKNOWN_CLIENT

F

Unknown client

12014156

INVALID_CLIENT_STATUS

F

Invalid client status

00000030

SIGN_TYPE_INVALID

F

The sign type is invalid

#Examples

#Request Sample

copy
{
    "request":{
        "head":{
            "version":"2.0.4",
            "function":"alipay.intl.merchant.common.indirectMerchant.query",
            "clientId":"2014000014442",
            "reqTime":"2001-07-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fda",
            "reserve":"{}"
        },
        "body":{
            "merchantId":"21020000001",
            "sellerId":"83410102",
            "storeId":"83401020001",
            "paymentScene":"ONLINE"
        }
    },
    "signature":"signature string"
}


#Response Sample

copy
{
    "response":{
        "head":{
            "version":"2.0.4",
            "function":"alipay.intl.merchant.common.indirectMerchant.query",
            "clientId":"2014000014442",
            "respTime":"2001-07-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fda",
            "reserve":"{}"
        },
        "body":{
            "resultInfo":{
                "resultStatus":"S",
                "resultCodeId":"00000000",
                "resultCode":"SUCCESS",
                "resultMsg":"success"
            },
            "sellerInfo":{
                "sellerId":"58000001",
                "sellerName":"Alipay (China) Network Technology Co., Ltd",
                "sellerMcc":"1402",
                "paymentScene":"ONLINE",
                "sellerType":"INDIVIDUAL",
                "siteInfos":[
                    {
                        "siteName":"Apple",
                        "siteUrl":"www.alipay.com",
                        "siteType":"APP"
                    }
                ],
                "registrationNo":"83720154037071",
                "registrationCountry":"CN",
                "registrationAddress":"Shanghai",
                "shareholderName":"Zhangsan",
                "shareholderId":"69833444422",
                "representativeName":"Zhangsan",
                "representativeId":"69833444422",
                "settlementNo":"1551263547569833",
                "contactNo":"086+13001720000",
                "contactEmail":"Zhangsan@alipay.com",
                "customerServiceNo":"086+13701720000",
                "customerServiceEmail":"customer_service@alipay.com"
            },
            "storeInfo":{
                "storeId":"569833",
                "storeName":"ShopName",
                "storeMcc":"8014",
                "storeCountry":"CN",
                "storeAddress":"Shanghai",
                "internalStorePhoto":"www.alipay.com/internalStorePhoto.jpg",
                "externalStorefrontPhoto":"www.alipay.com/externalStorePhoto.jpg"
            },
            "registrationStatus":"SUCCESS",
            "rejectReason":"incomplete information",
            "storeStatus":"ACTIVATED",
            "extendInfo":"{}"
        }
    },
    "signature":"signature string"
}