Antom, leading provider of tailored payment solutions

inquireDirectPayment

POST /v1/aba/funds/inquireDirectPayment

使用此接口查询直接支付结果。

  • 您需要设置超时机制,以便在未获得明确结果的情况下停止轮询过程。
  • 如果在调用 createDirectPayment 接口后两小时内未收到来自 Antom 的任何通知,同时调用此接口返回的 paymentStatus 为 ​UNKNOWN​,请联系 Antom 技术支持团队寻求帮助。

结构

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

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

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


入参

paymentRequestId String  

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

注意:paymentRequestId 和 paymentId 不能同时为空。

更多信息:

  • 此为幂等字段。
  • 最大长度:64 字符

paymentId String  

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

注意:paymentRequestId 和 paymentId 不能同时为空。

更多信息:

  • 最大长度:64 字符

出参

result Result  REQUIRED

表示接口调用是否成功。

Show child parameters

paymentId String  

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

更多信息:

  • 最大长度:64 字符

paymentRequestId String  

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

更多信息:

  • 最大长度:64 字符

paymentStatus String  

支付状态。枚举值为:

  • SUCCESS:支付成功。
  • PROCESSING:支付已成功受理,当前正在处理。
  • FAIL:支付失败。
  • UNKNOWN:支付结果未知,请联系 Antom 获取支持。

更多信息:

  • 最大长度:32 字符

paymentResultMessage String  

用于说明支付结果代码的支付结果消息。

注意:只有当 paymentStatus 的值为 ​FAIL​ 时,才会返回此参数。

更多信息:

  • 最大长度:256 字符

paymentResultCode String  

支付结果码。可能返回的支付结果码列在本页的 支付结果码 表中。

注意:只有当 paymentStatus 的值为 FAIL 时,才会返回此参数。

更多信息:

  • 最大长度:64 字符

payToMethod PayToMethod  

支付方式详情。

Show child parameters

paymentAmount Amount  

商户请求以订单货币接收的付款金额。

Show child parameters

payToAmount Amount  

收款方实际收到的金额。

Show child parameters

paymentTime Datetime  

付款完成的时间。

更多信息:

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

请求

URL
Method
POST
Case
Query by paymentRequestId
请求体

响应

Case
Success
响应体

结果码

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

查询请求成功,无需进一步操作。

PARAM_ILLEGALF接收到非法参数。

请检查并确认请求中的各个字段(包括报文头字段和报文体字段)是否正确且有效。各接口字段详情请参阅相应的接口 结构 部分。

REQUEST_TRAFFIC_EXCEED_LIMITF请求流量超出限制。

请重新调用该接口以解决问题。

如果问题仍然存在,请联系 Antom 技术支持

PROCESS_FAILF系统发生常规业务故障,支付失败。

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

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

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

ORDER_NOT_EXISTF订单不存在。

检查 paymentId 是否正确。

Payment result codes

结果码值结果码信息行动建议
ACCESS_DENIEDF访问被拒绝。

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

BALANCE_NOT_ENOUGHF由于对应支付方式的用户余额不足,支付无法完成。

请充值账户或选择其他支付方式。

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

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

CURRENCY_NOT_SUPPORTF不支持该币种。

请使用有效的货币重试。

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

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

REQUEST_TRAFFIC_EXCEED_LIMITU请求流量超过限制。

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

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

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

USER_ACCOUNT_ABNORMALF用户的账户状态异常。

请联系 Antom 技术支持。

USER_STATUS_ABNORMALF用户状态异常。

请联系 Antom 技术支持。

RISK_REJECTF由于风险控制,交易无法进一步处理。如果用户已为交易付款,交易将被退款。

请联系 Antom 技术支持。

AMOUNT_EXCEED_LIMITF支付金额超过了合同或支付方式允许的最大金额。

检查支付金额是否超过限制,或使用较低金额再试一次。

ORDER_NOT_EXISTF订单不存在。

请检查您的订单 ID,并使用正确的数值重试。