alipay.intl.acquiring.cashier.notify.pay

2021-06-21 10:08

Alipay sends a notification to the merchant after the order is paid successfully or unsuccessfully.

Request

Request parameters

Header

No	Name	Description	Type	Length	Required	Remarks	Sample
1	version	SPI version	string	8	ME	As per the respective SPI reference.	2.0.0
2	function	SPI 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.	2014000014442
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	resultInfo	Result information	ResultInfo	/	M	Result information, result codes refer to Request Result Code below.	{ "resultStatus": "S", "resultCodeId": "00000000", "resultCode":"SUCCESS", "resultMsg": "result message" }
2	acquirementId	Unique Alipay transaction ID Note: This field is required when resultInfo.resultCode is `SUCCESS`.	string	64	C		2015032412007101547201352747
3	merchantTransId	Unique merchant transaction ID	string	64	M	The unique merchant transaction id, copied from the original payment request.	51051001000000000002
4	orderAmount	Order amount Note: This field is required when resultInfo.resultCode is `SUCCESS`.	Money	/	C	The transaction amount, copied from the original payment request. The orderAmount should be provided in the smallest common currency unit. For example, to create a charge for $1.00, you would set orderAmount.value as 100 (100 cents).	{"value":"10000", "currency":"USD" }
5	paymentTime	The payment time of the transaction. Note: This field is required when resultInfo.resultCode is `SUCCESS`.	datetime	/	C	DateTime with timezone, which follows the ISO-8601 standard. Refer to: RFC 3339 Section 5.6	2016-07-04T12:08:56+05:30
6	payStatus	Status of the payment. WAIT_PAY PAY_SUCCESS PAY_FAILED PAY_CANCELLED Note: This field is required when resultInfo.resultCode is `SUCCESS`.	enum<PayStatusEnum >	32	C		PAY_SUCCESS
7	siteBuyerId	Site buyer ID Note: This field is required when resultInfo.resultCode is `SUCCESS` and authSiteCanProvide is `true`,	string	64	C		2088455609687485
8	extendInfo	Reserved for extended information	string	2048	O	Key/Value	{}

Request sample

copy
{
    "request":{
        "head":{
            "version":"2.0.0",
            "function":"alipay.intl.acquiring.cashier.notify.pay",
            "clientId":"2014000014442",
            "reqTime":"2001-07-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fda",
            "reserve":"{}"
        },
        "body":{
            "resultInfo":{
                "resultStatus":"S",
                "resultCodeId":"00000000",
                "resultCode":"SUCCESS",
                "resultMsg":"success"
            },
            "acquirementId":"2015032412007101547201352747",
            "merchantTransId":"51051001000000000002",
            "orderAmount":{
                "currency":"USD",
                "value":"239"
            },
            "paymentTime":"2016-07-04T12:08:56+05:30",
            "payStatus":"PAY_SUCCESS",
            "extendInfo":"{}"
        }
    },
    "signature":"signature string"
}

Response

Response parameters

Header

No	Name	Description	Type	Length	Required	Remarks	Sample
1	version	SPI version	string	8	ME	As per the respective SPI reference.	2.0.0
2	function	SPI 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.	2014000014442
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" }

Response sample

copy
{
    "response":{
        "head":{
            "version":"2.0.0",
            "function":"alipay.intl.acquiring.cashier.notify.pay",
            "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"
}

Result codes

Request result codes

Functional logic result codes

No	ResultCodeId	ResultCode	ResultStatus	Remarks
1	00000025	REPEAT_REQ_INCONSISTENT	F	Repeated submit, and requests are inconsistent.
2	00000011	RISK_REJECT	F	Risk reject
3	12002005	USER_NOT_EXIST	F	User does not exist
4	12002006	USER_STATUS_ABNORMAL	F	User status is not normal.
5	12005001	CURRENCY_NOT_SUPPORT	F	Transaction currency is invalid
6	12005104	AMOUNT_EXCEED_LIMIT	F	The amount exceeds the limit.
7	12005128	COUNT_EXCEED_LIMIT	F	Count exceeds the limit.
8	12006004	USER_BALANCE_NOT_ENOUGH	F	User balance is not enough

Basic result codes

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.

Response result codes

No	ResultCodeId	ResultCode	ResultStatus	Remarks
1	00000000	SUCCESS	S	success
2	00000901	UNKNOWN_EXCEPTION	U	API failed due to unknown reasons.
3	00000004	PARAM_ILLEGAL	F	Illegal parameters. For example, non-numeric input, invalid date.
4	00000007	INVALID_SIGNATURE	F	The signature is invalid.