Retrieve existing beneficiariesSignature required

2024-08-15 07:43

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.

Request header

Request parameters

accessToken String

The access token that is used for OAuth authorization.

More information:

Maximum length: 64 characters

beneficiaryToken String

A ciphered text that contains information about the details of the beneficiary's bank account.

The cipher is encoded in the Base64 algorithm. For more details about encoding, refer to the message encoding chapter.

More information:

Maximum length: 128 characters

beneficiaryNick String

The nickname of the beneficiary. The nickname is defined by the Customer to identify the beneficiary easily.

More information:

Maximum length: 70 characters

referenceBeneficiaryId String

The unique ID defined by the Partner to identify a beneficiary.

More information:

Maximum length: 64 characters

bankAccountNo String

The domestic bank account number of the Beneficiary account.

Rule:

{"checkRules": "^[A-Z0-9]{0,34}$"}.

More information:

Maximum length: 64 characters

bankAccountIBAN String

International Bank Account Number (IBAN) of the Beneficiary account.

Rule:

{"checkRules": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$"}.

More information:

Maximum length: 34 characters

relationFilter Array<String>

The type of beneficiary to be queried.

Valid values are:

SAME_NAME: indicates a same-name beneficiary
THIRD_PARTY: indicates a third-party beneficiary

When unspecified, all types of beneficiaries will be returned.

pageSize Integer REQUIRED

How many items a page contains.

More information:

Maximum length: 50 characters

pageNumber Integer REQUIRED

The index of the page number.

Format: 1,2,...

Response parameters

result Result object REQUIRED

Indicates whether this API is called successfully.

Show child parameters

responseId String REQUIRED

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

More information:

Maximum length: 32 characters

beneficiaries Array<Beneficiary> object REQUIRED

Describes details about the beneficiaries.

Show child parameters

totalCount Integer REQUIRED

The total item number of beneficiaries in this query result.

More information:

Maximum length: 8 characters

totalPageNumber Integer REQUIRED

The total page number of beneficiaries in this query result.

More information:

Maximum length: 8 characters

currentPageNumber Integer REQUIRED

The current page index number.

More information:

Maximum length: 8 characters

API Explorer

Request

URL

Case

Samples using beneficiaryNick

Request Body

Response

Case

Samples using beneficiaryNick

Case description

For inquiry with beneficiaryNick

Response Body

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

System-realted result codes

Code	Value	Message	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 `POST`.

Business-related result codes

Code	Value	Message	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.

Field	Required	Sample	Description
Client-Id	Yes	`Client-Id: *****`	For more information about these request header fields, see Request header.
Signature	Yes	`Signature: algorithm=RSA256, keyVersion=2, signature=*****`
Content-Type	Yes	`Content-Type: application/json; charset=UTF-8`
Request-Time	Yes	`Request-Time: 2019-04-04T12:08:56+08:00`
Connected-CustomerId	Optional	`Connected-CustomerId: *****`	Attention The unique id assigned by WorldFirst to identify an account. Note: This parameter replaces customerId in the request body. Both parameters serve the same function, and this change does not impact functionality. If you have already integrated this API, you may continue using customerId in the request body or re-integrate this API using Connected-CustomerId in the request header.