Query account detailsSignature required
Use this API to query account information, which includes:
- Account type
- Account number
- Currency
- Account activation status
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
referenceCustomerId String CONDITIONAL
The unique ID assigned by the partner to identify a customer.
This parameter is required when accountType is
RECEIVE_ACCOUNT
orALIPAY_WALLET
.
More information:
- Maximum length: 64 characters
customerId String
The unique ID that is assigned by WorldFirst to identify a Customer.
More information:
- Maximum length: 64 characters
accessToken String CONDITIONAL
The access token used for OAuth authorization.
This parameter is required when accountType is
VIRTUAL_ACCOUNT
.
More information:
- Maximum length: 64 characters
accountType String REQUIRED
The type of the inquired account.
Valid values are:
RECEIVE_ACCOUNT
: indicates a WorldFirst Receiving Account used for monetary transfer between WorldFirst accounts.VIRTUAL_ACCOUNT
: indicates a WorldFirst Virtual Account used for monetary transfer into WorldFirst accounts.ALIPAY_WALLET
: indicates an Alipay Wallet.
Response parameters
result Result object REQUIRED
The result of the API call.
responseId String REQUIRED
The unique ID that is assigned by WorldFirst to identify a response.
This filed is returned only if the value of result.resultStatus is
S
.
More information:
- Maximum length: 32 characters
customerId String CONDITIONAL
The unique ID that is assigned by WorldFirst to identify a Customer.
This parameter is returned when the following conditions are met:
- result.resultStatus is S
- accountType is
VIRTUAL_ACCOUNT
orRECEIVE_ACCOUNT
.
More information:
- Maximum length: 64 characters
accountInfos Array <AccountInfo> object CONDITIONAL
The information of the inquired account.
This parameter is returned when the following conditions are met:
- result.resultStatus is S
- accountType is VIRTUAL_ACCOUNT or RECEIVE_ACCOUNT.
customer Customer object REQUIRED
The information about the customer, such as the company name, certification number, and etc.
This field is returned only if the value of result.resultStatus is S.
Request
Response
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. |
System-related result codes
Code | Value | Message | 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. |
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
Code | Value | Message | Further action |
---|---|---|---|
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. |
ACCOUNT_NOT_EXIST | F | Account does not exist. | Retry the inquiry with another account. |
ACCESS_TOKEN_EXPIRED | F | The access token has expired. | Refresh token to get a new access token or contact out Technical Support Team to address it. |
AUTHORIZATION_NOT_EXIST | F | OAUTH does not exist. | The current token authorization does not exist. Please contact our Technical Support Team to verify token authorization. |