alipay.intl.acquiring.common.payCancel_2.0.2

2021-02-26 07:48

The merchant can use this API to cancel a transaction when the PAY API call did NOT return a clear result. For example, when the 'pay' API call times out or an UNKNOWN_EXCEPTION is returned. Upon the success of payCancel API call, the merchant can cancel the transaction.

Request

Service address

Environment	URL
Production	https://open-na.alipay.com/api/alipay/intl/acquiring/common/paycancel.htm

Request head

Parameter	Name	Type	Length	Required	Description	Sample
version	API version	String	8	Y	The API version	2.0.2
function	API name	String	128	Y	The API name	alipay.intl.acquiring.common.payCancel
clientId	Client ID	String	32	Y	The unique ID assigned by Alipay to identify a client that makes API calls	211xxxxxxxxxxxxxxx044
reqTime	Request time	Datet ime	/	Y	Date time with timezone, see RFC 3339 Section 5.6 for details.	2001-07-04T12:08:56+05:30
reqMsgId	Request message ID	String	64	Y	The unique ID assigned by client to identify a request message	1234567asdfasdf1123fda
reserve	Reserved parameter	String	256	N	Key/Value formatted parameter for future use	{key/value}
signType	Sign type	String	64	N	The signature type	RSA2

Request body

Parameter	Name	Type	Length	Required	Description	Sample
partnerId	Partner ID	String	32	Y	The unique partner ID assigned by Alipay. This parameter identifies the settlement target that Alipay settles to.	211xxxxxxxxxxxxxxxx512
acquirementId	Alipay transaction ID	String	64	C	The unique Alipay transaction ID. Note: This parameter is required when `merchantTransId` is `NULL`.	2015xxxxxxxxxxxxxxxxxxxxx747
merchantTransId	Merchant transaction ID	String	64	C	The unique ID assigned by the merchant to identify a transaction. If both `acquirementId` and `merchantTransId` are provided, `acquirementId` is preferred. Note: This parameter is required when `acquirementId` is `NULL`.	510xxxxxxxxxxxxxx002

Response

Response head

Parameter	Name	Type	Length	Required	Description	Sample
version	API version	String	8	Y	The API version	2.0.2
function	API name	String	128	Y	The API name	alipay.intl.acquiring.common.payCancel
clientId	Client ID	String	32	Y	The unique ID assigned by Alipay to identify a client that makes API calls	211xxxxxxxxxxxxxxx044
respTime	Response time	Date time	/	Y	Date time with timezone, see RFC 3339 Section 5.6 for details.	2001-07-04T12:08:56+05:30
reqMsgId	Request message ID	String	64	Y	The unique ID assigned by client to identify a request message	1234567asdfasdf1123fda
reserve	Reserved parameter	String	256	N	Key/Value formatted parameter for future use	{key/value}

Response body

Parameter	Name	Type	Length	Required	Description	Sample
resultInfo	Result info	ResultInfo	/	Y	See resultInfo for details.	{ "resultStatus": "S", "resultCodeId": "00000000", "resultCode":"SUCCESS", "resultMsg": "result message" }
acquirementId	Alipay transaction ID	String	64	C	The unique Alipay transaction ID. Note: This parameter is required when `reultCode` is `SUCCESS`.	2015xxxxxxxxxxxxxxxxxxxxx747
merchantTransId	Merchant transaction ID	String	64	C	The unique ID assigned by the merchant to identify a transaction. Note: This parameter is required when `reultCode` is `SUCCESS`.	510xxxxxxxxxxxxxx002
cancelTime	The time when the transaction is cancelled.	Date time	/	N	Date time with timezone, see RFC 3339 Section 5.6 for details.	2001-07-04T12:08:56+05:30

Sub-parameters

resultInfo

Parameter	Name	Type	Length	Required	Description	Sample
resultStatus	Result status	String	2	Y	The request status can be:	`S`: success	`F`: failure	`U`: unknown	S
resultCodeId	Result ID	String	8	Y	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.	00000000
resultCode	Result code	String	64	Y	The result code	SUCCESS
resultMsg	Result message	String	256	N	When `resultCode` is `S`, this value can be empty. When `resultCode` is `F` or `U`, the error description is required.	success

Result code

Functional logic result code

ResultID	ResultCode	ResultStatus	Remarks
12002005	USER_NOT_EXIST	F	The user does not exist.
12002006	USER_STATUS_ABNORMAL	F	Abnormal user status
12005003	ORDER_STATUS_INVALID	F	The transaction status is invalid.
12005004	ORDER_NOT_EXIST	F	The transaction does not exist.
12006009	MERCHANT_BALANCE_NOT_ENOUGH	F	Insufficient balance of the merchant
12002018	ORDER_CANCEL_WINDOW_EXPIRED	F	Expired to cancel the transaction.
12005134	SIGN_TYPE_INVALID	F	The signature type is invalid.
12005135	SIGN_TYPE_NOT_SUPPORT	F	The signature type is not supported.

Basic result code

ResultID	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.
00000013	NO_INTERFACE_DEF	F	The API is undefined.
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
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
00000024	REQUEST_TRAFFIC_EXCEED_LIMIT	F	The request traffic exceeds the limit.

Sample

Sample request

copy

{ 
    "request":{ 
        "head":{ 
            "version":"2.0.2", 
            "function":"alipay.intl.acquiring.common.payCancel", 
            "clientId":"211xxxxxxxxxxxxxxx044", 
            "reqTime":"2001-07-04T12:08:56+05:30", 
            "reqMsgId":"1234567asdfasdf1123fda", 
            "reserve":"{}",
            "signType":"RSA2"
        }, 
        "body":{ 
            "partnerId":"218820000000000000023", 
            "acquirementId":"2015xxxxxxxxxxxxxxxxxxxxx747"
        } 
    }, 
    "signature":"signature string" 
}

Sample response

copy

{ 
    "response":{ 
        "head":{ 
            "version":"2.0.2", 
            "function":"alipay.intl.acquiring.common.payCancel", 
            "clientId":"211xxxxxxxxxxxxxxx044", 
            "respTime":"2001-07-04T12:08:56+05:30", 
            "reqMsgId":"1234567asdfasdf1123fda", 
            "reserve":"{}" 
        }, 
        "body":{ 
            "resultInfo":{ 
                "resultStatus":"S", 
                "resultCodeId":"00000000", 
                "resultCode":"SUCCESS", 
                "resultMsg":"success" 
            }, 
            "acquirementId":"2015xxxxxxxxxxxxxxxxxxxxx747", 
            "merchantTransId":"510xxxxxxxxxxxxxx002", 
            "cancelTime":"2001-07-04T12:08:56+05:30" 
        } 
    }, 
    "signature":"signature string" 
}