Antom, leading provider of tailored payment solutions

取消支付

本篇将说明支付取消流程及场景,商户或用户均可取消已设定的扣款计划。取消规则如下:
  • 商户端取消支付:当商户因业务需求或其他原因需要停止某一次计划扣款时,可以发起支付取消请求。商户需在计划扣款日的前一天,即 T-1 日 22:00 前提交取消请求,才可成功取消下一次计划扣款。如果商户在 T-1 日 22:00 之后提交取消请求,取消请求仍会被受理,但不会影响已安排在次日执行的扣款;取消操作仅会对下一个扣款周期生效,且该操作只取消某一次计划扣款,不会取消整个订阅。
例如,如果计划扣款日为 11 月 10 日,商户在 11 月 9 日 23:00 提交取消请求,11 月 10 日的扣款会正常执行,下一个周期的扣款会被取消,后续周期的扣款仍会按原计划继续执行。若该付款计划为按周扣款,则 11 月 17 日的扣款将被取消,但 11 月 17 日之后的后续扣款不会受到影响,仍会继续正常执行。
  • 用户端取消支付:若用户希望终止交易,可在付款到期日前取消已设定的付款计划,取消将立即生效。

商户端取消支付

您可以按照以下步骤发起取消支付请求:

步骤 1:调用 cancel 接口

您可以通过调用 cancel 接口来发起取消支付请求。您的请求中必需包含以下参数之一:
注意:取消支付操作仅可在到期日之前发起。
参数名
是否必需
描述
paymentId
否
Antom为交易分配的唯一标识符。
paymentRequestId
否
您为请求分配的唯一标识符。
以下为请求报文示例:
{
  "paymentId": "2019061218401080010018882020035XXXX"
}
以下为响应报文示例:
{
  "result": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "Success"
  },
  "paymentRequestId": "pay_2089760038715669_20277574507XXXX",
  "paymentId": "2019061218401080010018882020035XXXX",
  "cancelTime": "2019-06-12T19:07:11+08:00"
}
下表展示了响应代码中 result.resultStatus 参数可能返回的值,请您根据指引进行处理:
resultStatus
描述
后续操作
S
取消请求已受理。
表示取消请求已成功发起。请参考“步骤 2:获取取消结果”查询取消结果。
F
取消失败。
请查看 cancel 接口的 Error codes 定位问题。
U
状态未知。
使用相同的 paymentRequestId 重新发送请求。如果在连续三次重试后,result.resultStatus 的值仍然为 U,请联系 Antom 技术支持。

步骤 2:获取取消支付结果

一旦订阅支付被取消,Antom 将使用 notifyPayment(订阅) 接口向您在后续扣款请求中传入的 paymentNotifyURL 发送异步通知。
以下代码显示了异步通知请求的示例:
{
  "paymentAmount": {
    "currency": "BRL",
    "value": "1406"
  },
  "paymentCreateTime": "2025-10-13T01:31:09-07:00",
  "paymentTime": "2025-10-13T03:10:47-07:00",
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success",
    "resultStatus": "S"
  },
  "paymentId": "2019061218401080010018882020035XXXX",
  "subscriptionId": "20251013110000000000000600000004616",
  "subscriptionOrderId": "20251013110000000000000600000005838",
  "subscriptionOrderStatus": "CANCEL",
  "subscriptionRequestId": "PAYMENT_21b774f2-84ed-4a7e-b2bd-5f5b2599eb52"
}

用户端取消支付

一旦用户取消订阅支付,Antom 将使用 notifyPayment(订阅) 接口向您在后续扣款请求中传入的 paymentNotifyURL 发送异步通知。
注意:对于支付成功的交易,用户不得发起支付取消。
以下代码显示了异步通知请求的示例:
{
  "paymentAmount": {
    "currency": "BRL",
    "value": "1406"
  },
  "notifyType": "CANCEL_RESULT",
  "paymentCreateTime": "2025-10-13T01:31:09-07:00",
  "paymentTime": "2025-10-13T03:10:47-07:00",
  "paymentId": "2019061218401080010018882020035XXXX",
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success",
    "resultStatus": "S"
  },
  "subscriptionId": "20251013110000000000000600000004616",
  "subscriptionOrderId": "20251013110000000000000600000005838",
  "subscriptionOrderStatus": "CANCEL",
  "subscriptionRequestId": "PAYMENT_21b774f2-84ed-4a7e-b2bd-5f5b2599eb52"
}