createDirectRefund

2026-06-12 15:31

POST /v1/aba/funds/createDirectRefund

调用此接口通过您的 Antom 商业账户向供应商发起退款。

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息，有关报文头的结构信息，请参阅：

注意：将每个字段（除数组外）的数据类型设置为字符串。这意味字段值必须使用双引号（" "）括起来。例如：

如果字段的数据类型为整数属性，且其值为 20，设置为 "20"。
如果字段的数据类型为布尔属性，且其值为 true，设置为 "true"。

入参

paymentId String REQUIRED

由 Antom 分配的用于标识支付的唯一 ID。

更多信息：

最大长度：32 字符

refundRequestId String REQUIRED

由商户分配的用于标识支付请求的唯一 ID。

更多信息：

最大长度：32 字符

referenceRefundId String

用于标识买家提交的退款申请的唯一 ID。该 ID 作为参考编号，用于在退款全过程中跟踪和管理退款。

更多信息：

最大长度：32 字符

refundFromMethod RefundFromMethod REQUIRED

退款时使用的扣款来源。

Show child parameters

refundAmount Amount

退款金额。

Show child parameters

memo String

向发起方展示的交易描述。

更多信息：

最大长度：128 字符

remark String

向扣款方展示的交易描述。

更多信息：

最大长度：128 字符

refundReason String

退款原因。

更多信息：

最大长度：256 字符

refundNotifyUrl String

您配置的用于接收支付状态更新的 URL。

更多信息：

最大长度：128 字符

出参

result Result REQUIRED

接口调用的结果。

Show child parameters

paymentId String

由 Antom 分配的用于标识支付的唯一 ID。

更多信息：

最大长度：32 字符

refundId String

商户为退款请求分配的唯一 ID。

更多信息：

最大长度：32 字符

refundTime Datetime

退款完成的时间。

更多信息：

值遵循 ISO 8601 标准格式。例如，“2019-11-27T12:01:01+08:00”。

refundFromMethod RefundFromMethod

退款时使用的扣款来源。

Show child parameters

refundFromAmount Amount

源账户退款金额。

Show child parameters

refundToAmount Amount

退还给发起方的金额。

Show child parameters

API Explorer

请求

URL

Method

POST

请求体

响应

Case

Success

响应体

结果码

结果码	值	结果码信息	行动建议
SUCCESS	S	成功。	调用接口成功。
PROCESSING	S	支付正在处理中。	付款已受理，请稍后查询结果。
PAYMENT_IN_PROCESS	F	支付处理中。	检查订单状态并执行相应操作。若交易仍在处理中，请等待。若交易已失败，请勿发起退款。具体原因请联系 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	U	请求流量超过限制。	再次调用接口以解决问题。如果问题未解决，请联系 Antom 技术支持。
REPEAT_REQ_INCONSISTENT	F	金额或币种与先前请求不同。	请检查您的请求，并使用正确的数值重试。
ORDER_IS_CANCEL	F	由于支付订单被取消导致退款订单取消。	请联系 Antom 技术支持。