inquireSubscriptionPayment

2026-05-12 01:35

POST /v1/subscriptions/inquireSubscriptionPayment

调用此接口可获取订阅的支付列表信息。调用成功后，您将获得该订阅的交易信息，包括交易时间、账期编号、支付方式、金额及争议记录等。

结构

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

注意：将每个字段（除数组外）的数据类型设置为字符串。这意味字段值必须使用双引号（" "）括起来。例如：
如果字段的数据类型为整数属性，且其值为 20，设置为 "20"。
如果字段的数据类型为布尔属性，且其值为 true，设置为 "true"。

入参

merchantAccountId String

用于标识商户账户的专属 ID。

更多信息：

最大长度：64 字符

subscriptionId String REQUIRED

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

更多信息：

最大长度：64 字符

paymentStatuses Array<String>

筛选状态符合以下列表中任意值的交易：

SUCCESS：筛选成功的交易。
FAIL：筛选失败的交易。

若未指定此参数，默认返回所有状态的交易。

更多信息：

最大长度：32 字符
最多可包含元素个数：3

currentPage Integer

当前页码。

如果未指定此参数，则默认检索首页的所有订阅。

更多信息：

值范围： 1 - 2147483647

pageSize Integer

每页包含的条目数。

如果未指定此参数，则默认每页显示 10 条信息。

更多信息：

值范围： 1 - 10

出参

result Result REQUIRED

接口调用的结果。

Show child parameters

payments Array<SubscriptionTransaction> REQUIRED

指定 subscriptionId 的交易列表。

若未匹配到任何条件或 subscriptionId 不存在，可能返回空列表。

Show child parameters

paginator Paginator REQUIRED

分页信息。

Show child parameters

API Explorer

示例代码沙箱运行

请求

URL

Method

POST

请求体

响应

响应体

结果/错误码

结果码	值	结果码信息	行动建议
SUCCESS	S	Success.	The interface is called successfully.
ACCESS_DENIED	F	Access is denied.	Contact Antom Technical Support for detailed reasons.
PARAM_ILLEGAL	F	The required parameters are not passed, or illegal parameters exist. For example, a non-numeric input, an invalid date, or the length and type of the parameter are wrong.	Check and verify whether the required request fields (including the header fields and body fields) of the current API are correctly passed and valid.
UNKNOWN_EXCEPTION	U	An API call has failed, which is caused by unknown reasons.	Call the interface again to resolve the issue. If not resolved, contact Antom Technical Support.
INVALID_API	F	The called API is invalid or not active.	Contact Antom Technical Support to resolve the issue.
KEY_NOT_FOUND	F	The private key or public key of Antom or the merchant is not found.	Check whether the private key or public key exists. If not, upload the private key in Antom Dashboard.
NO_INTERFACE_DEF	F	API is not defined.	Check whether the URL is correct. Please refer to the endpoint in the API documentation.
PROCESS_FAIL	F	A general business failure occurred.	Do not retry. Human intervention is usually needed. It is recommended that you contact Antom Technical Support to troubleshoot the issue.
SYSTEM_ERROR	F	A system error occurred.	Contact Antom Technical Support for detailed reasons.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.	Call the interface again to resolve the issue. If not resolved, contact Antom Technical Support.