退款
退款的手续费、执行汇率、退款期限、是否支持部分退款以您和收单机构的约定为准。
调用退款接口退款
退款的流程请参考下图:
图 1. 退款流程
发起退款
使用 退款 接口发起退款需满足以下要求,否则将收到 APO 返回的对应错误码:
退款信息 | 要求 | 对应错误码 |
退款的币种 | 退款请求中的币种 refundAmount.currency 需要与发起交易时的币种 paymentAmount.currency 保持一致。 | CURRENCY_NOT_SUPPORT |
退款金额 | 退款申请的金额 refundAmount.value 需要大于等于最小退款金额(通常与最小支付金额一致),且小于等于交易剩余可退金额。 | REFUND_AMOUNT_EXCEED |
交易状态 | 对于卡支付方式:
| ORDER_STATUS_INVALID |
退款期限 | 在支付方式支持的退款期限内允许发起退款,超过则不允许发起退款。 | REFUND_WINDOW_EXCEED |
表 1. 退款请求要求
退款请求中关键字段如下(具体内容请参见 退款 接口):
字段名 | 注意点 |
refundRequestId | 在商户侧唯一的退款 ID。 |
paymentId | 该笔退款所对应的 Antom 分配的原始交易的 ID。 |
refundAmount | 退款金额,需要大于等于最小退款金额(通常为最小支付金额),且小于等于交易剩余可退金额。 |
表 2. 退款请求关键字段
获取退款结果
在发起退款请求后,您可以通过以下方式获取退款结果:
退款接口获取退款状态
在您调用 退款 接口后,APO 会返回该次退款的受理结果。响应中的 resultStatus 字段代表该笔交易的退款状态,不同状态码及解释如下表所示:
resultStatus | 解释 |
| 退款成功。 |
| 退款失败。请参考退款接口的 resultCode 进行问题排查。 |
| 退款受理中。您可以通过 查询退款结果 获取最终的退款结果。 |
表 3. 退款接口 resultStatus 状态码解释
调用接口查询退款
在您发起退款请求后,无论买家付款时使用的是何种支付方式,您均可以通过调用 查询退款结果 查询该退款的执行状态。返回结果中的 refundStatus 字段代表该笔交易的退款状态,不同状态码及其解释如下表所示:
refundStatus | 解释 |
| 退款处理成功。 |
| 退款处理中。 |
| 退款执行失败。 |
表 4. 查询退款接口 refundStatus 状态码解释
通过 APO 门户退款
您可以通过 APO 门户进行退款,欲知如何发起退款并查看退款结果,可参见通过门户交易中心退款。