Query sensitive card informationSignature required

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

Call this API to query sensitive information of the WorldCard.

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.

env Env  REQUIRED

The information of the environment.

Show child parameters

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.

cvv String  REQUIRED

The card CVV (Card Verification Value) number. This information needs to be obtained from Thredd because WorldFirst does not hold the CVV information.

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

cardNo String  REQUIRED

The card number.

expiredMonth String  

The month when the card will expire. Use numbers from 1 to 12 to represent months. For example: 07 represents July.

expiredYear String  

The year when the card will expire. Use two-digit numbers from 00 to 99 to represent the years between 2000 and 2099. For example: ​29​ represents 2029.

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.

USER_NOT_EXISTFThe user does not exist.

Retry with the correct user information.

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.

RISK_REJECTFSecurity reason error, please contact the account manager

Please contact our Technical Support team for help.

@2024 WorldFirst