Antom, leading provider of tailored payment solutions
Contact Us
登 录

inquireDirectRefund

POST /v1/aba/funds/inquireDirectRefund

使用此接口在退款交易发起后查询其状态和详细信息。此接口的响应包括当前交易状态以及来自 ABA 的相关处理指示，帮助你跟踪退款进度并根据需要更新退款处理流程。

结构

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

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

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


入参

refundRequestId String  

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

更多信息：

  • 最大长度：32 字符

refundId String  

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

更多信息：

  • 最大长度：32 字符

出参

result Result  REQUIRED

接口调用的结果。

Show child parameters

paymentId String  

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

更多信息：

  • 最大长度：32 字符

refundId String  

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

更多信息：

  • 最大长度：32 字符

refundRequestId String  

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

更多信息：

  • 最大长度：32 字符

refundStatus String  

退款状态。有效值包括：

  • SUCCESS：退款成功。
  • PROCESSING：已接受退款请求，正在处理中。
  • UNKNOWN：退款结果未知，请联系 Antom 获取支持。
  • FAIL：退款失败。

refundResultCode String  

退款结果码。可参考后文退款结果码以获取可能的值。

注意：仅当 refundStatus 的值为 ​FAIL 时返回此参数。

refundResultMessage String  

用于说明退款结果码的退款结果信息。

注意：仅当 refundStatus 的值为 FAIL 时返回此参数。

更多信息：

  • 最大长度：256 字符

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
Query by refundRequestId
请求体

响应

Case
Success
响应体

结果码

结果码值结果码信息行动建议
SUCCESSS成功。

调用接口成功。

PARAM_ILLEGALF缺少必需的参数，或者存在非法参数。例如，非数字输入、无效的日期，或者参数的长度和类型错误。

检查并验证当前接口所需的请求字段（包括头部字段和正文字段）是否正确传递并有效。

REQUEST_TRAFFIC_EXCEED_LIMITF请求流量超过限制。

再次调用接口以解决问题。如果问题未解决，请联系 Antom 技术支持。

PROCESS_FAILF发生一般业务错误，支付失败。

通常需要人工介入。建议联系 Antom 技术支持以解决该问题。

UNKNOWN_EXCEPTIONU由于未知原因，接口调用失败。

再次调用接口以解决问题。如果问题未解决，请联系 Antom 技术支持。

ORDER_NOT_EXISTF订单不存在。

支付订单不存在。请使用正确的支付信息重试。

Refund result codes

结果码值结果码信息行动建议
PAYMENT_IN_PROCESSU支付处理中。

检查订单状态并执行相应操作。若交易仍在处理中，请等待。若交易已失败，请勿发起退款。具体原因请联系 Antom 技术支持。

REFUND_AMOUNT_EXCEEDF退款金额超出支付总金额。

请修正退款金额后重试。

REFUND_WINDOW_EXCEEDF超出退款允许时间范围。

请联系 Antom 技术支持。

ORDER_NOT_EXISTF订单不存在。

支付订单不存在。请使用正确的支付信息重试。

INVALID_ACCESS_TOKENF检查访问令牌是否已过期、已被撤销或不存在。

重新签署合同并重新启动授权签署流程。

PARAM_ILLEGALF缺少必需的参数，或者存在非法参数。例如，非数字输入、无效的日期，或者参数的长度和类型错误。

检查并验证当前接口所需的请求字段（包括头部字段和正文字段）是否正确传递并有效。

ACCESS_DENIEDF访问被拒绝。

请联络 Antom 技术支持获取详细原因。

USER_NOT_EXISTF用户在支付方式端不存在。

请使用有效的用户 ID 重试。如果问题仍然存在，请联系 Antom 技术支持。

PROCESS_FAILF系统发生常规业务故障，请勿重试。

需要人工介入。建议您联系 Antom 技术支持以解决该问题。

UNKNOWN_EXCEPTIONU由于未知原因，接口调用失败。

再次调用接口以解决问题。如果问题未解决，请联系 Antom 技术支持。

REQUEST_TRAFFIC_EXCEED_LIMITF请求流量超过限制。

再次调用接口以解决问题。如果问题未解决，请联系 Antom 技术支持。

ORDER_IS_CANCELF由于支付订单被取消导致退款订单取消。

请联系 Antom 技术支持。