Retrieve existing beneficiaries
POST: /amsin/api/v1/business/account/inquiryBeneficiaryList
After creating a beneficiary by binding the bank card to WorldFirst, the Partner can call this API to inquire about all the beneficiaries connected to a WorldFirst account.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:
Request parameters
Field | Data type | Required | Description |
customerId | String | Yes(Conditional) | The unique id that is assigned by WorldFirst to identify an account. Note:
More information:
|
accessToken | String | Yes(Conditional) | The access token that is used for OAuth authorization. Note:
More information:
|
beneficiaryToken | String | No | A ciphered text that contains information about the details of the beneficiary's bank account. Note:
More information:
|
beneficiaryNick | String | No | The nickname of the beneficiary. The nickname is defined by the Customer to identify the beneficiary easily. More information:
|
referenceBeneficiaryId | String | No | The unique ID defined by the Partner to identify a beneficiary. More information:
|
bankAccountNo | String | No | The domestic bank account number of the Beneficiary account. Rule:
More information:
|
bankAccountIBAN | String | No | International Bank Account Number (IBAN) of the Beneficiary account. Rule:
More information:
|
pageSize | Integer | Yes | How many items a page contains. More information:
|
pageNumber | Integer | Yes | The index of the page number. Format:
|
Response parameters
Field | Data type | Required | Description |
result | Result object | Yes | Indicates whether this API is called successfully. |
responseId | String | Yes | The unique ID that is assigned by WorldFirst to identify a response.
|
beneficiaries | List<Beneficiary object> | Yes | Describes details about the beneficiaries. |
totalCount | Long | Yes | The total item number of beneficiaries in this query result. More information:
|
totalPageNumber | Integer | Yes | The total page number of beneficiaries in this query result. More information:
|
currentPageNumber | Integer | Yes | The current page index number. More information:
|
Result processing logic
After calling the API, a response is returned. The possible responses for result.resultStatus are:
Result status | Description |
S | This indicates the API call succeeded. |
F | This indicates the API call failed. For more information on why the call failed, see |
U | This indicates the API call result is unknown. Partner can make a query when the returned status is
If none of the queries is successful, contact our Technical Support Team. |
Result codes
result.resultCode
System-related result codes
resultCode | resultStatus | resultMessage | Further action |
SUCCESS | S | Success | |
PROCESS_FAIL | F | A general business failure occurred. Do not retry. | Human intervention is usually needed. It is recommended that you contact our Technical Support Team to resolve the issue. |
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. For details on the fields of each API, see the specific API Structure section. |
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 our Technical Support Team. |
REQUEST_TRAFFIC_EXCEED_LIMIT | U | 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. |
METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | Ensure the HTTP method is |
Business-related result codes
resultCode | resultStatus | resultMessage | Further action |
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 user does not exist. | Retry with the correct user information. |
Samples
Samples using beneficiaryNick
Request
{
"beneficiaryNick": "NickABC",
"beneficiaryToken":"*****",
"customerId":"*****",
"bankAccountIBAN":"",
"bankAccountNo":"*****",
"pageNumber":"1",
"pageSize":"10"
}Response
{
"beneficiaries": [
{
"beneficiaryBankAccount": {
"bankAccountIBAN": "GB22GBGB123456123*****",
"bankAccountName": "shen***",
"bankBIC": "CHASGB*****"
},
"beneficiaryNick": "NickABC",
"beneficiaryToken": "ALIPAYLfIqcPI58*****",
"beneficiaryType": "THIRD_PARTY_COMPANY_BANK_ACCOUNT",
"countryCode": "GB",
"currency": "USD",
"status": "SUCCESS"
}
],
"currentPageNumber": 1,
"responseId": "*****",
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success",
"resultStatus": "S"
},
"totalCount": 1,
"totalPageNumber": 1
}Samples using referenceBeneficiaryId
Request
{
"referenceBeneficiaryId":"2022*****",
"customerId":"*****",
"pageNumber":"1",
"pageSize":"50"
}Response
{
"beneficiaries": [
{
"beneficiaryBankAccount": {
"bankAccountIBAN": "DE315001051765761*****",
"bankAccountName": "shen***",
"bankBIC": "CHASDE*****",
"beneficiaryPhone": ""
},
"beneficiaryNick": "NickABC",
"beneficiaryToken": "ALIPAYjIIt8*****",
"beneficiaryType": "THIRD_PARTY_COMPANY_BANK_ACCOUNT",
"countryCode": "DE",
"currency": "EUR",
"referenceBeneficiaryId": "2022*****",
"status": "SUCCESS"
}
],
"currentPageNumber": 1,
"responseId": "*****",
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success",
"resultStatus": "S"
},
"totalCount": 1,
"totalPageNumber": 1
}