inquireBeneficiary
Use this interface to inquire about all the beneficiaries connected to Antom business account after creating a beneficiary by binding the information to Antom.
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
beneficiaryToken String
A Base64-encoded ciphertext encapsulating the beneficiary's bank account information.
More information:
- Maximum length: 64 characters
beneficiaryNick String
The nickname of the beneficiary.
More information:
- Maximum length: 70 characters
referenceBeneficiaryId String
The unique ID assigned by the merchant to identify a beneficiary.
More information:
- Maximum length: 64 characters
bankAccountNo String
The domestic bank account number or Alipay+ payment method account number of the Beneficiary's account.
More information:
- Maximum length: 64 characters
bankAccountIBAN String
International Bank Account Number (IBAN) of the beneficiary's account.
More information:
- Maximum length: 34 characters
currencyList Array<Currency>
A list containing 3-character ISO-4217 currency codes representing the currency that the merchant queries.
Currently, the following currencies are supported:
SGDAUDCADEURGBPHKDJPYNZDUSDCNY
assetType String
The type of assets. Valid values include:
-
BANK_ACCOUNT: Indicates the bank account. -
ALIPAY_ACCOUNT: Indicates the alipay account. ANTOM_BIZ_ACCOUNT: Returns only the Antom business account.
Note: if this parameter is null, all values will be returned.
More information:
- Maximum length: 64 characters
accountName String
The account name used to filter results based on fuzzy matching.
More information:
- Maximum length: 128 characters
relationFilter Array<String>
The type of beneficiary used to filtering results through fuzzy matching. Valid values include:
SAME_NAME: Indicates a beneficiary with the same name.THIRD_PARTY: Indicates a third-party beneficiary.
pageSize Integer REQUIRED
Number of items per results page.
More information:
- Value range: [0, 50]
pageNumber Integer REQUIRED
Page index to retrieve results for.
More information:
- Value range: [0, 50]
cnSettlementMode String CONDITIONAL
Currency for withdrawal to CNY. Valid values include:
CNY_ONSHORE: beneficiary in mainland China.CNH_OFFSHORE: beneficiary overseas (CNH).BOTH_CNY_CNH: both CNY recipients.
Note: if this parameter is null, all values will be returned.
Response parameters
result Object REQUIRED
Indicates whether this API call is successful.
beneficiaries Array<Beneficiary>
Details about the beneficiaries.
totalCount Integer
The total item number of beneficiaries in this query result.
More information:
- Value range: [0, 50]
totalPageNumber Integer
The total page number of beneficiaries in this query result.
More information:
- Value range: [0, 50]
currentPageNumber Integer
The current page index number.
More information:
- Value range: [0, 50]
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | success. | The API is called successfully, and no further action is needed. |
| PARAM_ILLEGAL | F | Illegal parameters exist. | Check and verify whether the request fields, including the header fields and body fields, are correct and valid. For details on the fields of each API, see the specific API Structure section. |
| PROCESS_FAIL | F | A general business failure occurred. Don't retry. | Human intervention is usually needed. It is recommended that you contact Antom Technical Support Team to resolve the issue. |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | The service might be down, retry later. If the issue persists, contact Antom Technical Support. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | F | The request traffic exceeds the limit. | Call the interface again to resolve the issue. If the issue persists, contact our Technical Support Team. |
| OAUTH_FAIL | F | oAuth authentication failed. | Contact our Technical Support Team 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. |
| CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Make sure the currency input is correct and try again. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | Ensure the HTTP method is |
| UN_SUPPORT_BUSINESS | F | Unsupported business. | Invalid parameters are used e.g. currency is incorrect. Retry with the correct information. |
| SYSTEM_ERROR | F | System error. | Do not retry, and contact our Technical Support Team for more details. |
| USER_NOT_EXIST | F | The order does not exist. | Retry with the correct user. |