Cancel or refund a payment

After making a payment, further actions might be required, such as cancellation, and refund.

Cancel the transaction

The payment can be canceled within the agreed cancellable period, which is from the time when the transaction is initiated to 00:15 UTC+8 of T+1 day, regardless of the payment status.

The Acquiring Service Provider can call the cancelPayment interface to cancel a payment in one of the following scenarios:

• The merchant/Acquiring Service Provider cannot receive the payment result from Alipay+ for a long time, or cannot obtain the payment result via the inquiryPayment interface.
• The transaction is not completed after exceeding the maximum number of inquiries.

The following figure illustrates the flow of payment cancellation initiated by the Acquiring Service Provider:

Figure 1. Payment cancellation flow initiated by the Acquiring Service Provider

The payment cancellation initiated by the Acquiring Service Provider contains the following steps:

1. The Acquiring Service Provider submits the cancellation request to Alipay+ (step 1).
2. Alipay+ returns the cancellation result to the Acquiring Service Provider (step 1.1).

Processing logic

• The cancelPayment request only works on the payment, and cannot be used on refund.
• Before canceling the transaction, it is recommended that you use the inquiryPayment interface to inquire the payment result at least once. For more information about inquiryPayment, see inquiryPayment.
• After you request a cancelation, you cannot change the order status to status other than canceled. If payment notification comes later than the cancellation response, the Acquiring Service Provider handles the payment result based on the cancellation response. If the cancellation fails, you need to retry the cancelPayment request until the cancellation succeeds.
• You might receive different results from Alipay+, follow instructions below to handle the result:

Sample

Sample request:

{
 "paymentRequestId":"20200101234567897890"
}

Sample response:

{
 "acquirerId": "1111088000000000002",
 "pspId":"1022172000000000001",
 "result": {
    "resultCode":"SUCCESS",
    "resultStatus":"S",
    "resultMessage":"success"
  }
}

More information

For more information about how to use the interfaces (such as the field description), see cancelPayment.

Refund the payment

For successful payment transactions, the refund interface can be used to return funds to user.

Alipay+ support both full refund and multiple partial refunds. The total amount of multiple partial refunds cannot exceed the original amount paid by the user. The Acquiring Service Provider can initiate a refund transaction anytime within the refund expiration period (365 days by default) since the original payment transaction date.

The following figure illustrates the refund flow: 

Figure 2. Refund flow

The refund flow contains the following steps:

1. The Acquiring Service Provider sends the refund request to Alipay+ with the acquirer paymentRequestId.
2. Alipay+ returns the refund result to the Acquiring Service Provider.

Processing logic

When call the refund interface, pay attention to the following items:

• The refundRequestId need to be unique.
• You might receive different results from Alipay+, follow instructions below to handle the result:

Sample

The Acquiring Service Provider sends a request to Alipay+.

{
 "paymentRequestId":"20181129190741010007000000****",
 "refundRequestId":"20181129190741020007000000****",
 "refundAmount":{
    "value":"100",
    "currency":"JPY"
 } 
}

Alipay+ returns a response to the Acquiring Service Provider.

{
 "acquirerId": "102218800000000****",
 "pspId":"102217200000000****",
 "result": {
    "resultCode":"SUCCESS",
    "resultStatus":"S",
    "resultMessage":"Success"
  },
 "refundId":"20181129190741020007000000****",
 "refundTime": "2020-10-10T12:01:01+08:30"
}

More information

For more information about how to use the interfaces (such as the field description), see refund.