取消交易
下单后您可以在一定时间窗口期内通过使用 取消 接口主动关闭某笔交易。取消的窗口期、手续费等以您与收单机构的合约为准。
使用场景
如果商户有明确的主动关单场景,如闪购、酒店预订、机票购买等,则需要集成 取消 接口。可以针对以下情况之一发起交易取消,交易取消后,交易状态变为 CANCELLED
。即使交易取消后收到支付成功的异步通知,您系统中的交易状态仍然应保持 CANCELLED
。
集成步骤
步骤一:发起交易取消
您可以通过 取消 接口发起单笔交易的撤销。在请求中,你需要传入以下 2 种 ID 中的一个:
参数名 | 必填/选填 | 描述 |
paymentId |
| 下单时由 Antom 侧返回的唯一交易号。 |
paymentRequestId |
| 下单时由商家分配的唯一请求号。 |
表 1. 取消接口传参说明
步骤二:取消结果获取
在您调用 取消 接口后,Antom 会通过 result.resultStatus 字段同步返回该次交易的取消结果:
resultStatus | 解释 |
S | 取消成功。由 cancelTime 字段表示取消成功的时间。 |
F | 取消失败。错误码信息请参考 Error codes。 |
U | 取消结果未知,请使用相同的请求参数 paymentRequestId 发起取消重试。paymentRequestId 是取消的唯一标识,使用同一个 paymentRequestId 多次请求不会触发多次取消。如果重试三次仍返回 |
表 2. 取消结果解释