Use the cancel API to cancel a payment if the payment result is not returned for a long time, or to cancel a payment authorization after the authorization is completed. 

A couple of things to note before calling this API:

To cancel the payment, you must provide one of the following parameters:

• paymentId: The original payment ID of the payment request to be canceled, generated by Alipay when the merchant initiates the original payment.
• paymentRequestId: The original payment request ID of the payment request to be canceled.   

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see： 

• Request header
• Response header

Note: Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:

• If the data type of a field is Integer and its value is 20, set it as "20". 
• If the data type of a field is Boolean and its value is true, set it as "true". 

Result process logic

For different request results, different actions are to be performed. See the following list for details:

• If the value of result.resultStatus is S, the cancellation succeeds.
• If the value of result.resultStatus is F, the cancellation fails. See the returned error code and determine further actions.
• If the value of result.resultStatus is U, the cancellation result is unknown. Use the same request parameters to retry the cancellation request.
• If no response is returned, use the same request parameters to retry the cancellation request. 

Error codes

Error codes are usually classified into the following categories:

• Common error codes: common for all online and in-store payment APIs.
• API-specific error codes: listed in the following table.  

Result/Error codes