支付通知（订阅）

2024-11-14 08:45

Antom 使用此接口在支付成功或失败时，将每个订阅周期的支付结果发送给商家。

结构

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

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

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

入参

result Result REQUIRED

支付结果的详细信息，如支付状态、返回码和结果消息。

Show child parameters

paymentId String REQUIRED

Antom 为识别每个订阅周期支付而分配的专属 ID。

更多信息：

最大长度：64 字符

paymentAmount Amount REQUIRED

每个订阅周期的支付金额。

Show child parameters

paymentCreateTime Datetime REQUIRED

每个订阅周期的支付创建的日期和时间。

更多信息：

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

paymentTime Datetime

每个订阅周期的支付成功的日期和时间。

注意：当 result.resultStatus 的值为S时，返回此参数。

subscriptionRequestId String REQUIRED

商家为识别订阅请求而分配的订阅请求 ID。

更多信息：

最大长度：64 字符

subscriptionId String REQUIRED

Antom 为识别订阅而分配的订阅 ID。

更多信息：

最大长度：64 字符

periodStartTime Datetime REQUIRED

当前订阅周期的开始日期和时间。

更多信息：

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

periodEndTime Datetime REQUIRED

当前订阅周期的结束日期和时间。

更多信息：

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

phaseNo String REQUIRED

指示当前订阅期间所处的阶段。例如，如果订阅在 5 月生效，为一年的月度订阅，那么 6 月是第二个阶段，phaseNo 为 2。

更多信息：

最大长度：64 字符

出参

result Result REQUIRED

发送给 Antom 以确认收到通知的固定值。

Show child parameters

API Explorer

请求

请求体

响应

响应体

结果处理逻辑

在收到 Antom 通知后，发送以下固定值的消息给 Antom，以确认收到 Antom 的通知：

Sample Code

如果由于操作问题或网络问题没有将此类消息返回给 Antom，Antom 会反复发送通知，直到商家返回所需消息。首次通知发送后的 24 小时内会进行重试。通知将重试最多八次，间隔为 0 秒, 2 分钟, 10 分钟, 10 分钟, 1 小时, 2 小时, 6 小时, 和 15 小时。

注意：沙箱环境中，如果您没有按照固定格式返回信息，Antom 将不会重新发送异步通知给您。

结果码

结果码	值	结果码信息	行动建议
SUCCESS	S	成功	接口调用成功。
ACCESS_DENIED	F	访问被拒绝。	请联络 Antom 技术支持获取详细原因。
INVALID_ACCESS_TOKEN	F	访问令牌已过期、被撤销或不存在。	请联络 Antom 技术支持获取详细原因。
CURRENCY_NOT_SUPPORT	F	货币不受支持。	请联络 Antom 技术支持获取详细原因。
ORDER_IS_CLOSED	F	交易已关闭，无法再次支付。	请联络 Antom 技术支持获取详细原因。
PAYMENT_AMOUNT_EXCEED_LIMIT	F	支付金额超过了合同或支付方式允许的最大金额。	请检查支付金额是否超出限制，或尝试使用更低的金额重试。请联系 Antom 技术支持了解具体限制。
PAYMENT_COUNT_EXCEED_LIMIT	F	支付次数超过了支付方式规定的限制。	请联系 Antom 技术支持了解具体限制。
PROCESS_FAIL	F	发生了常见的业务失败。	获取 Antom 技术支持前请勿重试。
MERCHANT_BALANCE_NOT_ENOUGH	F	商户余额不足。	请在商户余额充足后再次调用接口。
UNKNOWN_EXCEPTION	U	由于未知原因，接口调用失败。	调用接口再次尝试解决问题。如果问题未解决，请联系 Antom 技术支持。
SYSTEM_ERROR	F	发生系统错误。	获取 Antom 技术支持前请勿重试。
USER_BALANCE_NOT_ENOUGH	F	用户的余额不足，无法完成支付。	请联络 Antom 技术支持获取详细原因。
USER_STATUS_ABNORMAL	F	用户在支付方式端的状态异常。	请联系 Antom 技术支持了解具体原因。