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

inquireBeneficiary

POST /v1/aba/accounts/inquireBeneficiary

通过绑定信息创建收款人后，使用此接口查询与 Antom 全球商家账户关联的所有收款人信息。

结构

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

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

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

入参

beneficiaryToken String  

包含收款人银行账户详情的加密信息，采用 Base64 算法进行编码。

更多信息：

  • 最大长度：64 字符

beneficiaryNick String  

收款人昵称。

更多信息：

  • 最大长度：70 字符

referenceBeneficiaryId String  

商户分配的用于识别收款人的专属 ID。

更多信息：

  • 最大长度：64 字符

bankAccountNo String  

收款人国内银行账户号或 Alipay+ 支付账户号。

更多信息：

  • 最大长度：64 字符

bankAccountIBAN String  

收款人账户的国际银行账号（IBAN）。

更多信息：

  • 最大长度：34 字符

currencyList Array<Currency>  

包含 3 位 ISO 4217 货币代码的列表，用于表示商户查询的货币类型。目前支持的货币包括：

  • SGD
  • AUD
  • CAD
  • EUR
  • GBP
  • HKD
  • JPY
  • NZD
  • USD
  • CNY

assetType String  

资产类型，有效值包括：

  • ​BANK_ACCOUNT​：表明资产类型为银行账户。
  • ​ALIPAY_ACCOUNT：表明资产类型为支付宝账户。
  • ​ANTOM_BIZ_ACCOUNT：表明资产类型为 Antom 全球商家账户。

注意: 若为空则返回所有类型。

更多信息：

  • 最大长度：64 字符

accountName String  

用于通过模糊匹配筛选结果的账户名称。

更多信息：

  • 最大长度：128 字符

relationFilter Array<String>  

用于通过模糊匹配筛选受益人类型的参数。有效值包括：

  • ​SAME_NAME​：同名收款人。
  • ​THIRD_PARTY​：第三方收款人。

pageSize Integer  REQUIRED

每个结果页返回条目数。

更多信息：

  • 值范围： [0, 50]

pageNumber  Integer  REQUIRED

用于获取结果的页码索引。

更多信息：

  • 值范围： [0, 50]

cnSettlementMode String  CONDITIONAL

人民币提现的结算模式。有效值包括：

  • CNY_ONSHORE: 境内人民币账户。
  • CNH_OFFSHORE: 境外离岸人民币账户 (CNH)。
  • BOTH_CNY_CNH: 同时支持境内外人民币账户。

注意： 如果该参数为空，则返回所有值。

出参

result Object  REQUIRED

表明此接口是否调用成功。

Show child parameters

beneficiaries Array<Beneficiary>  

收款人详情。

Show child parameters

totalCount Integer  

本次查询结果中收款人的总数。

更多信息：

  • 值范围： [0, 50]

totalPageNumber Integer  

本次查询结果的总页数。

更多信息：

  • 值范围： [0, 50]

currentPageNumber Integer  

当前页码。

更多信息：

  • 值范围： [0, 50]
API Explorer

请求

URL

Method
POST
请求体

响应

响应体

结果码

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

接口调用成功，无需进一步操作。

PARAM_ILLEGALF存在非法参数。

检查并验证请求字段（包括头部字段和正文字段）是否正确且有效。有关每个接口 的字段详情，请参阅具体的接口结构部分。

PROCESS_FAILF发生了一般的业务失败。

通常需要人工干预。建议联系 Antom 技术支持团队解决问题。

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

服务可能不可用，请稍后重试。如果问题仍然存在，请联系 Antom 技术支持团队。

REQUEST_TRAFFIC_EXCEED_LIMITF请求流量超过限制。

再次调用接口以解决问题。如果问题仍然存在，请联系 Antom 技术支持团队。

OAUTH_FAILFOAuth 认证失败。

请联系 Antom 技术支持团队以获取详细原因。

INVALID_APIF调用的接口无效或未激活。

检查是否调用了正确的接口。

INVALID_CLIENTF客户端无效。

客户端 ID 不存在或无效。

INVALID_SIGNATUREF签名无效。

确保请求已使用有效签名正确签名。

CURRENCY_NOT_SUPPORTF不支持该货币。

确保货币输入正确并重试。

METHOD_NOT_SUPPORTEDF服务器不支持请求的 HTTP 方法。

确保 HTTP 方法是 POST。

UN_SUPPORT_BUSINESSF不支持的业务。

使用了无效参数，例如货币不正确。使用正确信息重试。

SYSTEM_ERRORF系统错误。

请勿重试，并联系我们的技术支持团队以获取更多详细信息。

USER_NOT_EXISTF订单不存在。

使用正确的用户重试。