notifyDirectRefund
Antom 通过此接口发送直接退款结果。商户可以在调用 createDirectRefund 时通过指定 notifyUrl 字段,或在 Antom Dashboard 上设置 URL,用于接收付款通知。
入参
notifyType String REQUIRED
退款状态通知的类型。有效值为:
REFUND_RESULT:表示该通知与退款结果相关。
更多信息:
- 最大长度:32 字符
paymentId String
由 Antom 分配的用于标识付款的唯一 ID。
更多信息:
- 最大长度:32 字符
refundId String
由商户分配的用于标识退款请求的唯一 ID。
更多信息:
- 最大长度:32 字符
refundRequestId String
由商户分配的用于标识付款请求的唯一 ID。
更多信息:
- 最大长度:32 字符
refundStatus String REQUIRED
退款状态。有效值包括:
SUCCESS:退款成功。FAIL:退款失败。
refundResultCode String
退款结果码。可参考后文退款结果码以获取可能的值。
c
refundResultMessage String
用于说明退款结果码的退款结果信息。
注意:仅当 refundStatus 的值为 FAIL 时返回此参数。
更多信息:
- 最大长度:256 字符
refundFromMethod RefundFromMethod
退款时使用的扣款来源。
refundFromAmount Amount
源账户退款金额。
refundToAmount Amount
退还给发起方的金额。
出参
result Result REQUIRED
接口调用结果。
API Explorer
请求
Case
Success
响应
Refund result codes
| 结果码 | 值 | 结果码信息 | 行动建议 |
|---|---|---|---|
| PAYMENT_IN_PROCESS | U | 支付处理中。 | 检查订单状态并执行相应操作。若交易仍在处理中,请等待。若交易已失败,请勿发起退款。具体原因请联系 Antom 技术支持。 |
| REFUND_AMOUNT_EXCEED | F | 退款金额超出支付总金额。 | 请修正退款金额后重试。 |
| REFUND_WINDOW_EXCEED | F | 超出退款允许时间范围。 | 请联系 Antom 技术支持。 |
| ORDER_NOT_EXIST | F | 订单不存在。 | 支付订单不存在。请使用正确的支付信息重试。 |
| INVALID_ACCESS_TOKEN | F | 检查访问令牌是否已过期、已被撤销或不存在。 | 重新签署合同并重新启动授权签署流程。 |
| PARAM_ILLEGAL | F | 缺少必需的参数,或者存在非法参数。例如,非数字输入、无效的日期,或者参数的长度和类型错误。 | 检查并验证当前接口所需的请求字段(包括头部字段和正文字段)是否正确传递并有效。 |
| ACCESS_DENIED | F | 访问被拒绝。 | 请联络 Antom 技术支持获取详细原因。 |
| USER_NOT_EXIST | F | 用户在支付方式端不存在。 | 请使用有效的用户 ID 重试。如果问题仍然存在,请联系 Antom 技术支持。 |
| PROCESS_FAIL | F | 系统发生常规业务故障,请勿重试。 | 需要人工介入。建议您联系 Antom 技术支持以解决该问题。 |
| UNKNOWN_EXCEPTION | U | 由于未知原因,接口调用失败。 | 再次调用接口以解决问题。如果问题未解决,请联系 Antom 技术支持。 |
| REQUEST_TRAFFIC_EXCEED_LIMIT | F | 请求流量超过限制。 | 再次调用接口以解决问题。如果问题未解决,请联系 Antom 技术支持。 |