Apply for cardSignature required

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

Call this API to apply for a 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

requestId String  REQUIRED

The unique ID assigned by the partner to identify the card application request.

More information:

  • Maximum length: 32 characters

cardNickName String  

The nickname of the WorldCard. This parameter is useful for managing multiple cards.

More information:

  • Maximum length: 120 characters

contactEntityId String  

The unique ID assigned by WorldFirst to identify a business contact.

If unspecified, the value of this parameter defaults to the current user ID.

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

requestId String  REQUIRED

The unique ID assigned by the partner to identify the card application request.

This parameter is returned only if the value of result.resultStatus is S.

More information:

  • Maximum length: 32 characters

status String  REQUIRED

The status of the application to open a WorldCard.

Valid values are:

  • PROCESSING: indicates the application is being processed.
  • SUCCESS: indicates the application is successful.
  • FAIL: indicates the application has failed.

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

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.

REPEAT_REQUESTFRepeat request

Change the requestId and retry calling this API.

USER_NOT_EXISTFThe user does not exist.

Retry with the correct user information.

USER_INFORMATION_INCOMPLETEFfirstName&lastName englishNameInfoResult is null

User information is incomplete. Please provide the complete user information and retry. If the call fails again, please reach out to our Technical Support Team.

APPLY_CARD_NUMBER_LIMITFApply card number limit

Please contact our Technical Support Team for help.

RISK_REJECTFRisk reject allow appeal

Please contact our Technical Support Team for help.

NOT_ENOUGH_AMOUNT_INFThe user's recent cash flow is insufficient

Please contact our Technical Support Team for help.

USER_LEVEL_NOT_MATCHFUser level not match

Please contact our Technical Support Team for help.

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