Query cardholder listSignature required

2026-05-26 12:34

POST /amsin/api/v1/business/worldcard/queryCardholderList

Partners can call this interface to query the list of all cardholders under a World Card account.

Structure

A message consists of a header and body. For details, see the following sections.

Field	Required	Sample	Description
Client-Id	Yes	`Client-Id: *****`	For more information about these request header fields, see Request structure. To generate`Signature`, see Sign a request and validate the signature.
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-AccountId	Conditional	`Connected-AccountId: *****`	Attention Required when a partner manages a customer's account.
Access-Token	Conditional	`Access-Token: ******`	Attention Required for OAUTH authorization. Refer to applyToken.

Status of the audit.

Valid values are:

The current page index. The first page index is 1.

Number of results per page.

Recommended value is 10.

More information:

The result of the API call.

Show child parameters

The current page index number.

This field is only returned when result.resultStatus = S.

The total number of items in the query result.

This field is only returned when result.resultStatus = S.

The total number of pages.

This field is only returned when result.resultStatus = S.

The list of all the cardholders.

Show child parameters

API Explorer

URL

Request Body

Response Body

After calling the API, a response is returned. Possible values for result.resultStatus are:

Result status	Description
`S`	Indicates that the API call succeeded.
`F`	Indicates that the API call failed. For additional information on the failure, refer to result.resultCode.
`U`	Indicates that the API call result is unknown. If this status is returned, the Partner may make a query. The querying strategy is as follows: Maximum 7 queries are allowed. Intervals between queries: 5 min, 10 min, 20 min, 40 min, 80 min, 160 min, and 320 min. If no queries succeed, contact our Technical Support Team.

Code	Value	Message	Further action
SUCCESS	S	Success
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.	Refer to the API documentation page and confirm whether the request headers and parameters are correct.
SYSTEM_ERROR	F	System error.	Do not retry. Contact WorldFirst technical support for details.
SERVICE_NOT_ALLOWED	F	Service not allowed.	Retry with the correct information. If the issue persists, contact WorldFirst technical support.
UNKNOWN_EXCEPTION	U	API failed due to unknown reason.	Server error. If retrying later does not resolve the issue, contact WorldFirst technical support.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.	Retry. If the issue persists, contact WorldFirst technical support.
OAUTH_FAIL	F	OAuth process failed.	Contact WorldFirst technical support for details.
INVALID_API	F	The called API is invalid or not active.	Confirm whether the correct API is being called.
INVALID_CLIENT	F	The client is invalid.	Client ID does not exist or is invalid.
INVALID_SIGNATURE	F	The signature is invalid.	Confirm that the request is correctly signed.
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTP method.	Confirm that the HTTP request method is POST.
CONTRACT_CHECK_FAIL	F	The contract check has failed.	Contact WorldFirst technical support to understand the contract status before retrying.