Query account detailsSignature required

2024-11-21 06:55

POST /amsin/api/v1/business/account/inquiryAccount

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

The unique ID assigned by the partner to identify a customer.

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

The access token used for OAuth authorization.

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.
ALIPAY_SHADOW_WALLET: indicates an alipay account associated with the related company in mainland China.

Note:

Specify referenceCustomerId when the value of accountType is RECEIVE_ACCOUNT or ALIPAY_WALLET.
Specify accessToken when the value of accountType is VIRTUAL_ACCOUNT.
Specify customerId when the value of accountType is ALIPAY_SHADOW_WALLET.

Response parameters

result Result REQUIRED

The result of the API call.

Show child parameters

responseId String REQUIRED

The unique ID that is assigned by WorldFirst to identify a response.

This parameter 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 , RECEIVE_ACCOUNT or ALIPAY_SHADOW_WALLET.

More information:

Maximum length: 64 characters

accountInfos Array <AccountInfo> 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 , RECEIVE_ACCOUNT or ALIPAY_SHADOW_WALLET.

Show child parameters

customer Customer REQUIRED

The information about the customer, such as the company name, certification number, and etc.

This parameter is returned only if the value of result.resultStatus is S.

Show child parameters

affiliatedCustomer AffiliatedCustomer CONDITIONAL

The information of the related company in mainland China.

This parameter is returned when the following conditions are met:
result.resultStatus is S
accountType is ALIPAY_SHADOW_WALLET.

Show child parameters

API Explorer

Request

URL

Case

When accountType=RECEIVE_ACCOUNT

Request Body

Response

Case

When accountType=RECEIVE_ACCOUNT

Response Body

Result processing logic

After calling the API, a response is returned. The possible responses for result.resultStatus are:

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 `POST`.

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.

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 result.resultCode.
`U`	This indicates the API call result is unknown. Partner can make a query when the returned status is `UNKNOWN`. Use the following query strategy: A Partner can make 7 queries at maximum. Intervals between queries: 5m, 10m, 20m, 40m, 80m, 160m, and 320m. If none of the queries is successful, contact our Technical Support Team.