cancelPaymentACQP → Alipay+
The Acquiring Partner (ACQP) uses the cancelPayment API to proactively cancel a payment when no payment result is received after the payment expires, or when the ACQP has closed the payment already.
A payment can be canceled before 00:15 UTC+8 of the T+1 day.
Note: In the following sections, the Mobile Payment Provider (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:
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".
Request parameters
paymentRequestId String
The request ID of the payment to be canceled, assigned by the ACQP to identify the original payment order.
Note: Required if the value of the paymentId parameter is empty.
More information:
- This field is an API idempotency field.This parameter is used for idempotency control. For requests that are initiated with the same paymentRequestId, Alipay+ regards the requests as repeated and processes the requests only once.
- Maximum length: 64 characters
paymentId String
The ID of the payment to be canceled, assigned by Alipay+ to identify the original payment order.
Note: Required if the value of the paymentRequestId parameter is empty.
More information:
- Maximum length: 64 characters
Response parameters
result Result object REQUIRED
The result of the payment cancelation. If the value of the result.resultCode parameter is SUCCESS, the cancelation succeeds. See Result processing logic for details.
pspId String
The unique ID that is assigned by Alipay+ to identify an MPP.
Note:
Returned by Alipay+ if the value of the result.resultStatus parameter is S and Alipay+ knows the related MPP ID.
More information:
- Maximum length: 64 characters
acquirerId String
The unique ID that is assigned by Alipay+ to identify an ACQP.
Note:
Returned by Alipay+ if the value of the result.resultStatus parameter is S.
More information:
- Maximum length: 64 characters
Request
Response
More information
Result processing logic
For different results returned by Alipay+, take actions as below:
result.resultStatus | result.resultCode | Cancellation status | Further Actions |
S | SUCCESS | Cancellation succeeds | The merchant can reinitiate a payment request. |
F | ... | Cancellation fails | Take actions according to the error code in result.resultCode. Note: If the result.resultCode value returns as
|
U | ... | Unknown | Use the same parameter to retry the cancelPayment request.
|
No result received after trying several times | Unknown | Contact connect_support@service.alipay.com. | |
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | The merchant can reinitiate a payment request. |
| ACCESS_DENIED | F | Access is denied. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| CANCEL_WINDOW_EXCEED | F | Exceed Cancel window. | Call the refund API to refund the payment. |
| INVALID_CLIENT | F | The client is invalid. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| INVALID_SIGNATURE | F | The signature is invalid. | Check whether the public key, signed message, and signature algorithm are as expected. |
| KEY_NOT_FOUND | F | The key is not found. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. | Use a media type that is accepted by Alipay+. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTPS method. Ensure the HTTP method is POST. | Ensure the HTTP method is POST. |
| NO_INTERFACE_DEF | F | API is not defined. | Check whether the request URL is correct. Ensure that the endpoint of the called API is correct. |
| PARAM_ILLEGAL | F | Illegal parameters. For example, non-numeric input, invalid date. | Check whether the request parameters, including the header parameters and body parameters, are correct and valid. For more information about the parameters of each API, see the Structure section of the specific API reference topic. |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Reduce the frequency of API calls. |
| UNKNOWN_EXCEPTION | U | An API call failed, which is caused by unknown reasons. | Try to recall the API. |