Alipay+ DocsAlipay+ Docs

cancelPaymentACQP → Alipay+

POST /aps/api/v1/payments/cancelPayment

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 closes the payment before receiving the payment result. 

A payment can be canceled before 00:15 UTC+8 of the T+1 day.

Note: In the following sections, the 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

paymentRequestId String  

The request ID of the payment to be canceled, assigned by the ACQP to identify the original payment order.

Specify this parameter if the value of the paymentId parameter is empty. 

More information about this field

  • This field is an API idempotency field.For requests that are initiated with the same paymentRequestId, Alipay+ returns the same result.
  • Maximum length: 64 characters

paymentId String  

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

Specify this parameter if the value of the paymentRequestId parameter is empty. 

More information about this field

  • 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. For more information about how to handle the result of the cancelPayment API, see How to handle the result

Show child parameters

pspId String  

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

This parameter is returned by Alipay+ if the value of the result.resultStatus parameter is S and Alipay+ knows the related MPP ID. 

More information about this field

  • Maximum length: 64 characters

acquirerId String  

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

This parameter is returned by Alipay+ if the value of the result.resultStatus parameter is S

More information about this field

  • Maximum length: 64 characters
API Explorer
Sample CodesRun in Sandbox

Request

URL
Request Body

Response

Response Body

More information

How to handle the result

You might receive different results from Alipay+. Follow the instructions below to handle the result. 

result.resultStatus

result.resultCode

Cancellation status

Further Actions

S

SUCCESS

Cancellation succeeds

The merchant can reinitiate a payment request.

F

Multiple possible values exist, such as

ACCESS_DENIED,

KEY_NOT_FOUND, etc.

Cancellation fails

Take actions according to the error code in result.resultCode.

Note: If the value of the result.resultCode parameter is CANCEL_WINDOW_EXCEED, call the refund API.

U

Multiple possible values exist, such as

ACCESS_DENIED,

KEY_NOT_FOUND, etc.

Unknown

Use the same parameter to retry the cancelPayment request.

  • In the first 60 seconds, you can retry the request with an interval of 5 to 10 seconds.
  • After 60 seconds, you can still retry the request before 00:15 UTC+8 of T+1 day.
  • If you keep receiving the same result indicating the unknown status, contact connect_support@service.alipay.com.

No result received after trying several times

Unknown

Contact connect_support@service.alipay.com.

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

The merchant can reinitiate a payment request.

ACCESS_DENIEDFAccess is denied.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

CANCEL_WINDOW_EXCEEDFExceed Cancel window.

Call the refund API to refund the payment.

INVALID_CLIENTFThe client is invalid.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

INVALID_SIGNATUREFThe signature is invalid.

Check whether the public key, signed message, and signature algorithm are as expected.

KEY_NOT_FOUNDFThe key is not found.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.

Use a media type that is accepted by Alipay+.

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTPS method. Ensure the HTTP method is POST.

Ensure the HTTP method is POST.

NO_INTERFACE_DEFFAPI is not defined.

Check whether the request URL is correct. Ensure that the endpoint of the called API is correct.

PARAM_ILLEGALFIllegal 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_FAILFA 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_LIMITUThe request traffic exceeds the limit.

Reduce the frequency of API calls.

UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.

Try to recall the API.