alipay.intl.acquiring.cashier.payQuery

2021-06-21 10:08

The merchant can use this interface to query transaction status and other information.

Request

Request parameters

Header

No	Name	Description	Type	Length	Required	Remarks	Sample
1	version	API version	string	8	ME	As per the respective API reference.	2.0.0
2	function	API interface	string	128	ME	According to specifications defined by each business domain.	alipay.intl.function
3	clientId	Client ID	string	32	ME	Provided by Alipay, used to identify partner and application system.	211020000000000000044
4	reqTime	Request time	datetime	/	M	DateTime with timezone, which follows the ISO-8601 standard. Refer to: RFC 3339 Section 5.6	2001-07-04T12:08:56+05:30
5	reqMsgId	Request message ID	string	64	ME	Each request will be assigned with a unique ID (uuid). The reqMsgId identifies a unique system request, it is not used to identify a unique business request.	1234567asdfasdf1123fda
6	reserve	Reserved for future implementation	string	256	O	Key/Value	{}

Body

No	Name	Description	Type	Length	Required	Remarks	Sample
1	merchantId	Merchant ID, which identifies the settlement target that Alipay would settle to.	string	64	M		218820000000000000023
2	acquirementId	Unique Alipay transaction ID. Note: This field is required when merchantTransId is `NULL`.	string	64	C	Alipay transaction ID, identifying the transaction to be queried.	2015032412007101547201355678
3	merchantTransId	Unique merchant transaction ID. Note: This field is required when acquirementId is `NULL`.	string	64	C	The unique merchant transaction ID created by the merchant. The acquirementId would be favored over merchantTransId if both are provided.	51051001000000001234

Request sample

copy
{
    "request":{
        "head":{
            "version":"2.0.0",
            "function":"alipay.intl.acquiring.cashier.payQuery",
            "clientId":"211020000000000000044",
            "reqTime":"2001-07-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fda",
            "reserve":"{}"
        },
        "body":{
            "merchantId":"218820000000000000023",
            "acquirementId":"2015032412007101547201355678"
        }
    },
    "signature":"signature string"
}

Response

Response parameters

Header

No	Name	Description	Type	Length	Required	Remarks	Sample
1	version	API version	string	8	ME	As per the respective API reference.	2.0.0
2	function	API interface	string	128	ME	According to specifications defined by each business domain.	alipay.intl.function
3	clientId	Client ID	string	32	ME	Provided by Alipay, used to identify partner and application system.	211020000000000000044
4	respTime	Response time	datetime	/	M	DateTime with timezone, which follows the ISO-8601 standard. Refer to: RFC 3339 Section 5.6	2001-07-04T12:08:56+05:30
5	reqMsgId	Request message ID	string	64	ME	Each request will be assigned with a unique ID (uuid).	1234567asdfasdf1123fda
6	reserve	Reserved for future implementation	string	256	O	Key/Value	{}

Body

No	Name	Description	Type	Length	Required	Sample
1	resultInfo	Result information	ResultInfo	/	M	{ "resultStatus": "S", "resultCodeId": "00000000", "resultCode":"SUCCESS", "resultMsg": "result message" }
2	payment	The payment information, including transaction status and other information. Note: This field is required when resultInfo.resultCode is `SUCCESS`.	Payment	/	C	{ "acquirementId": "2015032412007101547201355678", "merchantTransId": "51051001000000001234", "payStatus": "PAY_SUCCESS", "orderAmount": { "currency": "CNY", "value": "2390"}, "paymentTime": "2001-07-04T12:08:56+05:30", "extendInfo": "{}" }
3	siteBuyerId	Site buyer ID Note: This field is required when resultInfo.resultCode is `SUCCESS` and authSiteCanProvide is `true`.	string	64	C	2088455609687485

Response sample

copy
{
    "response":{
        "head":{
            "version":"2.0.0",
            "function":"alipay.intl.acquiring.cashier.payQuery",
            "clientId":"211020000000000000044",
            "respTime":"2001-07-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fda",
            "reserve":"{}"
        },
        "body":{
            "resultInfo":{
                "resultStatus":"S",
                "resultCodeId":"00000000",
                "resultCode":"SUCCESS",
                "resultMsg":"success"
            },
            "payment":{
                "acquirementId":"2015032412007101547201355678",
                "merchantTransId":"51051001000000001234",
                "payStatus":"PAY_SUCCESS",
                "orderAmount":{
                    "currency":"USD",
                    "value":"239"
                },
                "paymentTime":"2001-07-04T12:08:56+05:30",
                "extendInfo":"{}"
            }
        }
    },
    "signature":"signature string"
}

Result codes

Functional logic result code

No	ResultCodeId	ResultCode	ResultStatus	Remarks
1	12005004	ORDER_NOT_EXIST	F	The order does not exist.

Basic result code

The following global result codes might be returned for all APIs.

No	ResultCodeId	ResultCode	ResultStatus	Remarks
1	00000000	SUCCESS	S	Success
2	00000019	PROCESS_FAIL	F	General business failure. No retry.
3	00000901	UNKNOWN_EXCEPTION	U	API failed due to unknown reasons.
4	00000004	PARAM_ILLEGAL	F	Illegal parameters. For example, non-numeric input, invalid date.
5	00000007	INVALID_SIGNATURE	F	The signature is invalid.
6	00000008	KEY_NO_FOUND	F	The key is not found.
7	00000013	NO_INTERFACE_DEF	F	API is not defined.
8	00000014	API_IS_INVALID	F	API is invalid or not active.
9	00000016	OAUTH_FAILED	F	oAuth authentication failed.
10	00000021	ACCESS_DENIED	F	Access denied
11	12014152	CLIENT_FORBIDDEN_ACCESS_API	F	The client is not authorized to use this API.
12	12014155	UNKNOWN_CLIENT	F	Unknown client
13	12014156	INVALID_CLIENT_STATUS	F	Invalid client status
14	00000024	REQUEST_TRAFFIC_EXCEED_LIMIT	F	Request traffic exceeds the limit.