inquireBeneficiaryTemplate
Use this interface to help the merchant obtain a beneficiary template.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see：
Note: Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:
- If the data type of a field is Integer and its value is 20, set it as "20".
- If the data type of a field is Boolean and its value is
true, set it as "true".
Request parameters
beneficiaryType String REQUIRED
The type of the beneficiary's card. This field serves as a token to determine the payment or transfer logic and fund flow path. The value must match the allowed options for the target API.
For createPayout API, supported values include:
THIRD_PARTY_PERSONAL_BANK_ACCOUNT: Indicates the type of the beneficiary's card is the personal bank account of the third-party beneficiary.THIRD_PARTY_COMPANY_BANK_ACCOUNT: Indicates the type of the beneficiary's card is the company bank account of the third-party beneficiary.PERSONAL_BANK_ACCOUNT: Indicates the type of the beneficiary's card is the personal bank account of the same-name beneficiary.COMPANY_BANK_ACCOUNT: Indicates the type of the beneficiary's card is the company bank account of the same-name beneficiary.
For createPayout API (China-specific), supported values include:
RELATED_MERCHANT_COMPANY_BANK_ACCOUNT: Indicates the type of the beneficiary's card is the company bank account of the related company.RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT: Indicates the type of the beneficiary's card is the company alipay account of the related company.
For createTransfer API, supported value include:
ANTOM_BIZ_ACCOUNT: Indicates the type of the beneficiary's card is Antom Business Account.
countryCode String REQUIRED
The 2-letter country or region code where the bank is located, following the ISO 3166 Country Codes standard.
More information:
- Maximum length: 2 characters
currency String REQUIRED
The 3-letter currency code that follows the ISO 4217 standard.
More information:
- Maximum length: 3 characters
cnSettlementMode String
Currency for withdrawal to CNY. Valid values include:
CNY_ONSHORE: Indicates that beneficiary is located in mainland China.CNH_OFFSHORE: Indicates that beneficiary is located overseas (CNH).
Note: when the value of beneficiaryType is ANTOM_BIZ_ACCOUNT, The cnSettlementMode is not mandatory.
Response parameters
result Object REQUIRED
Indicates whether this API is called successfully.
cardTemplateData Array<CardTemplateField>
General template for the beneficiary's bank account.
antomBizAccountTemplateData Array<CardTemplateField>
Template for Antom Wallet.
alipayTemplateData Array<CardTemplateField>
Template for Alipay.
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | API is successfully called, not resembling order status |
| UNKNOWN_EXCEPTION | U | The API call is failed, which is caused by unknown reasons. | The service might be down, retry later. If the issue persists, contact Antom Technical Support. |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | Check and verify whether the request fields, including the header fields and body fields, are correct and valid. |
| CONTRACT_CHECK_FAIL | F | The contract check failed. | Check the contract status with Antom before retrying. |
| ACCOUNT_NOT_EXIST | F | The account does not exist. | Check if the account is valid and retry. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call the interface again to resolve the issue. If the issue persists, contact Antom Technical Support. |
| OAUTH_FAIL | F | OAuth process failed. | Contact Antom Technical Support for detailed reasons. |
| INVALID_API | F | The called API is invalid or not active. | Check whether the correct API is being called. |
| INVALID_CLIENT | F | The client is invalid. | The Client ID does not exist or is invalid. |
| INVALID_SIGNATURE | F | The signature is invalid. | Make sure the request is properly signed with a valid signature. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | Ensure the HTTP method is POST. |
| 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 resolve the issue. |
| USER_NOT_EXIST | F | The user does not exist. | Retry with the correct user information. |
| SYSTEM_ERROR | F | System error. | Do not retry, and contact Antom Technical Support for more details. |
| SERVICE_NOT_ALLOWED | F | Service not allowed | Retry with the correct information. If the issue persists, contact Antom Technical Support. |
| CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Make sure the currency input is correct and try again. |
| AUTHORIZATION_NOT_EXIST | F | The authorization does not exist. | Make sure that the input is correct. If the issue persists, contact Antom Technical Support to verify the authorization status. |
| ACCESS_TOKEN_EXPIRED | F | The access token expired. | Refresh token to get a new access token or contact Antom Technical Support to address it. |
| UN_SUPPORT_BUSINESS | F | Unsupported business. | Invalid parameters are used e.g. currency is incorrect. Retry with the correct information. |
| CARD_TEMPLATE_NOT_EXIST | F | No card templates met the query conditions. | Adjust the query and retry. |