Query account details
POST: /amsin/api/v1/business/account/inquiryAccount
Use this API to query account information, which includes:
- Account type
- Account number
- Currency
- Account activation status
Currently, you can query WorldFirst Receiving Accounts (RA).
For more details about the process to create an account with WorldFirst and the redirection URLs involved, refer to the Customer onboarding process chapter.
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 |
referenceCustomerId | String | Yes(Condutional) | The unique ID that is assigned by the Partner to identify a Customer. More information:
|
customerId | String | Yes(Condutional) | The unique ID that is assigned by WorldFirst to identify a Customer. More information:
|
accessToken | String | Yes(Condutional) | The access token that is used for OAuth authorization. More information:
|
accountType | String | No | Defines the type of account to inquire about. Currently, the value of this field can only be RECEIVE_ACCOUNT. Other possible values are:
|
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.
|
customerId | String | Yes | The unique ID that is assigned by WorldFirst to identify a Customer.
|
accountInfos | List<AccountInfo object> | Yes | Information with regard to the account that is being inquired. |
customer | Customer object | No | Information with regard to the Customer, such as the Customer's company name, certification number, etc. |
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 | |
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. |
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. |
UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 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 process 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 |
INVALID_ACCESS_TOKEN | F | Invalid access token | Check whether the accessToken is correct. |
KEY_NOT_FOUND | F | The key is not found. | This indicates that the client ID in the request has no matching key on the server, or the client ID exists but the RSA key is not configured. |
ACCESS_DENIED | F | The access is denied. | Contact Technical Support for detailed reasons. |
MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. | Retry with the correct media type. |
REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | Ensure all the fields in the requests are the same and retry. |
| UN_SUPPORT_BUSINESS | F | Unsupported business. | Invalid parameters are used e.g. currency is incorrect. Retry with the correct information. |
| ACCOUNT_NOT_EXIST | F | Account does not exist. | Retry the inquiry with another account. |
Samples
Request
Request body sample
{
"accountType": "RECEIVE_ACCOUNT",
"referenceCustomerId": "*****"
}Response
Response body sample
{
"accountInfos": [
{
"accountNo": "*****",
"accountStatus": "ACTIVE",
"accountType": "RECEIVE_ACCOUNT",
"currencyList": [
"EUR"
]
},
{
"accountNo": "*****",
"accountStatus": "ACTIVE",
"accountType": "RECEIVE_ACCOUNT",
"currencyList": [
"JPY"
]
},
{
"accountNo": "*****",
"accountStatus": "ACTIVE",
"accountType": "RECEIVE_ACCOUNT",
"currencyList": [
"USD"
]
}
],
"customer": {
"certificateList": [
{
"certificateNo": "*****",
"certificateType": "ENTERPRISE_REGISTRATION"
}
],
"customerCompanyName": "*****",
"customerId": "*****"
},
"customerId": "*****",
"responseId": "*****",
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success",
"resultStatus": "S"
}
}