alipay.intl.merchant.common.indirectMerchant.archive

2020-10-17 03:23

This interface is used by the acquirer to archive secondary merchant and store information.

#Request

#Service address

Environment	URL
Production	https://open-sea.alipay.com/api/alipay/intl/merchant/common/indirectMerchant/archive.htm

#Request Parameters

Parameter Description

Basic Parameter

function

String(128) Required

Service Name

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

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

Parameter Description

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" }

#Sub-parameters

#resultInfo

Parameter Description

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

#Business Logic Errors

Returned result	Description	Solution
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.archive",
            "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.archive",
            "clientId":"2014000014442",
            "respTime":"2001-07-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fda",
            "reserve":"{}"
        },
        "body":{
            "resultInfo":{
                "resultStatus":"S",
                "resultCodeId":"00000000",
                "resultCode":"SUCCESS",
                "resultMsg":"success"
            }
        }
    },
    "signature":"signature string"
}