Update card statusSignature required

2024-11-06 07:29

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

Call this API to change the card status, for example, freeze, unfreeze or cancel a card.

Structure

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

Request header

Request parameters

requestId String REQUIRED

The unique ID assigned by the partner to identify the status change request.

More information:

Maximum length: 32 characters

assetId String REQUIRED

The unique identifier of a card.

operateType String REQUIRED

The type of actions taken to change the card status.

Valid values:

FREEZE
UNFREEZE
CANCEL

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 status change request.

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

More information:

Maximum length: 32 characters

assetId String REQUIRED

The unique identifier of a card.

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

status String REQUIRED

The status of the application to update WorldCard status.

Valid values are:

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

This parameter is returned only if 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.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.
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.
REPEAT_REQUEST	F	Repeat request	Change the requestId and retry calling this API.
CONTRACT_NOT_EXIST	F	The contract check has failed	Ensure the Partner has already signed a contract and the input is correct.
USER_NOT_EXIST	F	The user does not exist.	Retry with the correct user information.
ASSET_NOT_EXIT	F	Asset not exit	Verify that the asset ID is correct and retry.
ASSET_STATUS_ERROR	F	Asset status error	Verify that the asset is in good standing and retry.
ASSET_PRIVILEGE_NOT_EXIT	F	Asset privilege not exit	Asset is not updated successfully. Please verify the asset status and retry.
ASSET_PRIVILEGE_REPEAT_OPERATE	F	Asset order repeat operate	Repeated action. Please do not retry.
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.

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.