You can use the cancel API to actively cancel a transaction. The cancellation period is subject to the contract.

Before issuing a cancellation, you must be familiar with the following information:

• If the transaction is canceled before the payment is successful, the buyer will not be able to continue the payment.
• For transactions cancelled after successful payment, the funds will be returned to the user's account.
• Commission fee: There are no fees charged for canceled transactions.
• Partial cancellation: Only a full cancellation is allowed.
• Cancel period: See the following table for details:

Table 1. Payment method cancellation period

When to cancel a transaction

If you have business scenarios where there are transactions that need to be canceled (such as flash sales, hotel booking services, and ticket selling services). You can cancel a transaction by using the cancel API. After a transaction is canceled, the payment status is CANCELLED. Even if a notification of a successful payment is received after the transaction is canceled, the payment status remains CANCELLED. You can cancel a transaction in the following scenarios, and Antom handles the cancellation accordingly:

Table 2. Cancel transaction scenario and processing

Note:

• Refunded transactions (including full refund and partial refund) cannot be canceled. Canceling refunded transactions will return PROCESS_FAIL error code.
• Even if you receive a payment success asynchronous notification after the transaction is canceled, the system's transaction status should remain the CANCELLED.

How to cancel a transaction

Step 1: Call the cancel API

When you close an order and receive an asynchronous payment success notification from Antom, you need to call the cancel API to cancel the transaction. Pass in one of the following two IDs in the request:

Table 3. Details of the request parameters of the cancel API

public static void payCancel() {
    AlipayPayCancelRequest alipayPayCancelRequest = new AlipayPayCancelRequest();

    // replace with your paymentRequestId
    alipayPayCancelRequest.setPaymentRequestId("yourPaymentRequestId");

    AlipayPayCancelResponse alipayPayCancelResponse = null;
    try {
        alipayPayCancelResponse = CLIENT.execute(alipayPayCancelRequest);
    } catch (AlipayApiException e) {
        String errorMsg = e.getMessage();
        // handle error condition
    }
}
}

public static void payCancel() {
    AlipayPayCancelRequest alipayPayCancelRequest = new AlipayPayCancelRequest();

    // replace with your paymentId
    alipayPayCancelRequest.setPaymentId("yourPaymentId");

    AlipayPayCancelResponse alipayPayCancelResponse = null;
    try {
        alipayPayCancelResponse = CLIENT.execute(alipayPayCancelRequest);
    } catch (AlipayApiException e) {
        String errorMsg = e.getMessage();
        // handle error condition
    }
}
}

The following code shows a sample of the request message:

{
  "paymentId": "2019061218401080010018882020035****"
}

{
  "paymentRequestId": "paymentRequestId****"
}

The following code shows a sample of the response message:

{
  "cancelTime": "2019-06-12T19:07:11+08:00",
  "paymentId": "2019061218401080010018882020035****",
  "paymentRequestId": "pay_2089760038715669_20277574507****",
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "Success",
    "resultStatus": "S"
  }
}

Step 2: Obtain the cancellation result

After you call the cancel API, Antom will use the result.resultStatus field of the cancel response to synchronously return the transaction cancellation result.

The table below displays the possible returned values and please follow the corresponding instructions for handling:

Table 4. Possible values returned in the result.resultStatus

Note: If you do not receive a response message, it may be due to a network timeout. Keep the original request unchanged and re-call the API to solve the problem. If the problem is not resolved, contact Antom Technical Support.