Alipay+ DocsAlipay+ Docs

cancelPaymentAlipay+ → MPP

Alipay+ uses the cancelPayment API to cancel a payment.

Note: In the following sections, Mobile Payment Partner (MPP) is also known as PSP. For example, pspId refers to the ID that identifies an MPP. 

Structure

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

Note:

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

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

2. For optional parameters that are not required in your case, you can take one of the following actions:

  • Exclude the parameters from the request body. 
  • Set the parameter values as null (without the double quotation marks). 

Do NOT leave the optional parameters empty by setting their values as ""; otherwise, an error might occur.  

Request parameters

acquirerId String  REQUIRED

The unique ID that is assigned by Alipay+ to identify an Acquiring Partner (ACQP). 

More information about this field

  • Maximum length: 64 characters

pspId String  REQUIRED

The unique ID that is assigned by Alipay+ to identify an MPP. 

More information about this field

  • Maximum length: 64 characters

paymentRequestId String  REQUIRED

The request ID of the payment to be canceled, assigned by Alipay+ to identify the original payment request.

More information about this field

  • This field is an API idempotency field.For cancellation requests that are initiated with the same paymentRequestId, the MPP needs to return the same result.
  • Maximum length: 64 characters

Response parameters

result Result object REQUIRED

The result of the payment cancelation. If this API is successfully called, the cancelation succeeds. For more information about how to return the cancelation result, see How to return the result

Show child parameters
API Explorer

Request

Request Body

Response

Response Body

More information 

How to return the result 

According to the request processing result, the MPP needs to return the corresponding result (specified by the result parameter):

  • If the payment cancelation succeeds, set the value of result.resultStatus to S and the value of result.resultCode to SUCCESS.
  • If the payment cancelation fails, set the value of result.resultStatus to F and the value of result.resultCode accordingly.
  • If the payment cancelation result is unknown, set the value of result.resultStatus to U and the value of result.resultCode accordingly.

For more information about how to define your result codes, see the Result codes section below. 

Result/Error codes

CodeValueMessage
SUCCESSSSuccess
ACCESS_DENIEDFAccess is denied.
CANCEL_WINDOW_EXCEEDFExceed Cancel window.
INVALID_CLIENTFThe client is invalid.
INVALID_SIGNATUREFThe signature is invalid.
KEY_NOT_FOUNDFThe key is not found.
MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.
METHOD_NOT_SUPPORTED FThe server does not implement the requested HTTPS method.
NO_INTERFACE_DEFFAPI is not defined.
PARAM_ILLEGALFIllegal parameters. For example, non-numeric input, invalid date.
PROCESS_FAILFA general business failure occurred. Do not retry.
REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.
UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.