Query card listSignature required

2024-11-06 07:29

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

Call this API to query the list of WorldCards.

Structure

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

Request header

Request parameters

cardStatus String

The card status. Valid values are:

ACTIVE
FROZEN
CALCEL

cardNickName String

The card nickname.

More information:

Maximum length: 120 characters

cardNoLast4 String

The last four digits of the card number.

This parameter has a fixed length of 4 characters.

pageNumber Integer REQUIRED

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

pageSize Integer REQUIRED

The number of items on each page.

Value range: 1 to 100 (inclusive).

Recommended value is 10.

Response parameters

result Result REQUIRED

The result of the API call.

Show child parameters

currentPageNumber Integer REQUIRED

The currency page index number.

This field is returned only when the value of result.resultStatus is S.

totalCount Integer REQUIRED

The total number of items in the query result.

This field is returned only when the value of result.resultStatus is S.

totalPageNumber Integer REQUIRED

Number of the pages in total.

This field is returned only when the value of result.resultStatus is S.

cardList Array<CardInfo> REQUIRED

The list of card information.

This field is returned only when the value of result.resultStatus is S.

Show child parameters

API Explorer

Request

URL

Request Body

Response

Response Body

Result processing logic

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

result.resultCode

Code	Value	Message	Further action
SUCCESS	S	Success
SYSTEM_ERROR	F	System error.	Do not retry, and contact our Technical Support Team for more details.
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.
USER_NOT_EXIST	F	The user does not exist.	Retry with the correct user information.
ACCESS_TOKEN_EXPIRED	F	The access token expired.	Refresh token to get a new access token or contact our Technical Support Team to address it.
AUTHORIZATION_NOT_EXIST	F	The authorization does not exist.	Make sure that the input is correct. If the issue persists, contact our Technical Support Team to verify the authorization status.
CONTRACT_NOT_EXIST	F	Contract does not exist.	Ensure the Partner has already signed a contract and the input is correct.
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.

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	Conditional	`Connected-CustomerId: *****`	Attention Required when a partner manages a customer's account.
Access-Token	Conditional	`Access-Token: ******`	Attention Required for OAuth authorization.

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 query succeed, contact our Technical Support Team.