updateCard
Use this API to update specific properties of an existing card, including spending limits, cardholder details, expiration dates, and permissions without affecting the current card status. This enables seamless customization of card configurations, alignment with customer preferences, and ongoing operational maintenance.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see：
Note: Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:
- If the data type of a field is Integer and its value is
20, set it as "20". - If the data type of a field is Boolean and its value is
true, set it as "true".
Request parameters
assetId String REQUIRED
The unique identifier of a card.
More information:
- Maximum length: 64 characters
requestId String REQUIRED
The unique request ID specified by the merchant for this card application request.
More information:
- Maximum length: 32 characters
cardNickName String
The card nickname defined by the merchant, which can help to manage multiple cards more conveniently.
More information:
- Maximum length: 120 characters
note String
Provide additional information for the card application.
More information:
- Maximum length: 512 characters
purpose String
Purpose of the card. Valid values are:
AIRLINELODGING
More information:
- Maximum length: 32 characters
metadata Map<String, String>
Customer metadata in key-value format.
This parameter is only for customised merchants.
More information:
- Maximum length: 3096 characters
authorizationControl AuthorizationControl
Authorization control rules.
Response parameters
result Result REQUIRED
The result of the API call.
requestId String
The unique request ID specified by the merchant for this request.
This parameter is returned only when the value of result.resultStatus is S.
More information:
- Maximum length: 32 characters
status String
Indicates the outcome of this update operation. Valid values are:
SUCCESS: Indicates the update is successful.FAIL: Indicates the update has failed.
This parameter is returned only when the value of result.resultStatus is S.
More information:
- Maximum length: 16 characters
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | No further action is needed. |
| 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. |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. | Human intervention is usually needed. It is recommended that you contact Antom Technical Support Team to resolve the issue. |
| 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. |
| RISK_REJECT | F | Request rejected due to risk concerns. | Please contact our Technical Support Team for help. |
| 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_EXIST | F | Asset does not exist. | Check the asset ID and try again. |
| ASSET_STATUS_ERROR | F | Asset status error. | Check the status of your assets and try again. |
| AMOUNT_EXCEED_LIMIT | F | The amount exceeds the limit. | Confirm the amount is correct and try again. |
| 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. |