inquireBeneficiaryTemplate

2026-10-01 14:45

POST /v1/aba/accounts/inquireBeneficiaryTemplate

调用此接口以获取收款人模板信息。

结构

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

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

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

入参

beneficiaryType String REQUIRED

收款人账户类型，该字段用于确定支付或转账逻辑以及资金流动路径，其值必须符合目标接口的允许选项。

对于 createPayout 接口，支持的值包括：

THIRD_PARTY_PERSONAL_BANK_ACCOUNT：表示收款人账户类型为第三方个人银行账户。
THIRD_PARTY_COMPANY_BANK_ACCOUNT：表示收款人账户类型为第三方对公银行账户。
PERSONAL_BANK_ACCOUNT：表示收款人账户类型为同名个人银行账户。
COMPANY_BANK_ACCOUNT：表示收款人账户类型为同名对公银行账户。

对于 createPayout 接口（中国区），支持的值包括：

RELATED_MERCHANT_COMPANY_BANK_ACCOUNT：表示收款人账户类型为关联企业对公银行账户。
RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT：表示收款人账户类型为关联企业支付宝对公账户。

对于 createTransfer 接口，支持的值包括：

ANTOM_BIZ_ACCOUNT：表示收款人账户类型为 Antom 全球商家账户。

countryCode String REQUIRED

银行所在国家或地区的 2 字母代码，遵循 ISO 3166 国家代码标准。

更多信息：

最大长度：2 字符

currency String REQUIRED

符合 ISO 4217 标准的 3 字母货币代码。

更多信息：

最大长度：3 字符

cnSettlementMode String

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

CNY_ONSHORE: 境内人民币账户。
CNH_OFFSHORE: 境外离岸人民币账户 (CNH)。

注意：当 beneficiaryType 的值为 ANTOM_BIZ_ACCOUNT，此字段非必填。

出参

result Object REQUIRED

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

Show child parameters

cardTemplateData Array<CardTemplateField>

收款人银行账户通用模板。

Show child parameters

antomBizAccountTemplateData Array<CardTemplateField>

收款人 Antom 全球商家账户模版。

Show child parameters

alipayTemplateData Array<CardTemplateField>

收款人支付宝账号模版。

Show child parameters

API Explorer

请求

URL

Method

POST

请求体

响应

响应体

结果码

结果码	值	结果码信息	行动建议
SUCCESS	S	成功。	接口调用成功，无需进一步操作。
UNKNOWN_EXCEPTION	U	接口调用失败，原因未知。	服务可能不可用，请稍后重试。如果问题仍然存在，请联系 Antom 技术支持团队。
PARAM_ILLEGAL	F	存在非法参数。例如，非数字输入、无效日期或参数长度和类型错误。	检查并验证请求字段（包括头部字段和正文字段）是否正确且有效。有关每个接口的字段详情，请参阅具体接口结构部分。
CONTRACT_CHECK_FAIL	F	合同检查失败。	在重试之前，请检查与 Antom 的合同状态。
ACCOUNT_NOT_EXIST	F	账户不存在。	检查账户是否有效并重试。
REQUEST_TRAFFIC_EXCEED_LIMIT	U	请求流量超过限制。	再次调用接口以解决问题。如果问题仍然存在，请联系 Antom 技术支持团队。
OAUTH_FAIL	F	OAuth 流程失败。	请联系 Antom 技术支持团队获取详细原因。
INVALID_API	F	调用的接口无效或未激活。	检查是否调用了正确的接口。
INVALID_CLIENT	F	客户端无效。	客户端 ID 不存在或无效。
INVALID_SIGNATURE	F	签名无效。	确保请求使用有效的签名正确签名。
METHOD_NOT_SUPPORTED	F	服务器不支持请求的 HTTP 方法。	确保 HTTP 方法是 POST。
PROCESS_FAIL	F	发生一般业务失败。不要重试。	通常需要人工干预。建议您联系 Antom 技术支持团队解决问题。
USER_NOT_EXIST	F	用户不存在。	使用正确的用户信息重试。
SYSTEM_ERROR	F	系统错误。	不要重试，并联系 Antom 技术支持团队获取更多详细信息。
SERVICE_NOT_ALLOWED	F	服务不允许。	使用正确的信息重试。如果问题仍然存在，请联系 Antom 技术支持团队。
CURRENCY_NOT_SUPPORT	F	不支持该货币。	确保货币输入正确并重试。
AUTHORIZATION_NOT_EXIST	F	授权不存在。	确保输入正确。如果问题仍然存在，请联系 Antom 技术支持团队验证授权状态。
ACCESS_TOKEN_EXPIRED	F	访问令牌已过期。	刷新令牌以获取新的访问令牌，或联系 Antom 技术支持团队解决。
UN_SUPPORT_BUSINESS	F	不支持的业务。	使用了无效参数，例如货币不正确。使用正确的信息重试。
CARD_TEMPLATE_NOT_EXIST	F	没有符合查询条件的卡模板。	调整查询并重试。