WorldFirst DocsWorldFirst DocsDOCS

Query card detailSignature required

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

Call this API to query the WorldCard details.

Structure

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

Request header

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.

Request parameters

assetId String  REQUIRED

The unique identifier of a card.

Response parameters

result Result  REQUIRED

The result of the API call.

Show child parameters

assetId String  REQUIRED

The unique identifier of a card.

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

cardHolderFirstName String  REQUIRED

The first name of the card holder.

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

cardHolderLastName String  REQUIRED

The last name of the card holder.

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

cardNickName String  

The card nickname.

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

maskedCardNo String  REQUIRED

The masked card number.

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

cardStatus String  REQUIRED

The card status. Valid values are:

  • ACTIVE
  • FROZEN
  • CALCEL

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

cardBrand String  REQUIRED

The card brand.

Valid value is: MASTERCARD

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

cardLimitDetail CardLimitDetail  REQUIRED

The detailed information of the card transaction limit.

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

Show child parameters

billAddress BillAddress  

The billing address.

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

result.resultCode

CodeValueMessageFurther action
SUCCESSSSuccess
SYSTEM_ERRORFSystem error.

Do not retry, and contact our Technical Support Team for more details.

PARAM_ILLEGALFIllegal 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_EXCEPTIONUAPI failed due to unknown reason.

The service might be down, retry later. If the issue persists, contact our Technical Support Team.

CONTRACT_NOT_EXISTFThe contract check has failed.

Ensure the Partner has already signed a contract and the input is correct.

USER_NOT_EXISTFThe user does not exist.

Retry with the correct user information.

ASSET_NOT_EXITFAsset not exit

Verify that the asset ID is correct and retry.

ASSET_STATUS_ERRORFAsset status error

Verify the asset is in good standing and retry.

ACCESS_TOKEN_EXPIREDFThe access token expired.

Refresh token to get a new access token or contact our Technical Support Team to address it.

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

@2024 WorldFirst