notifyCardStatus
This API is used to notify the merchant or partner about the change in status of card.
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
requestId String REQUIRED
The unique request ID specified by the merchant for this card application request. Antom uses this field for idempotence control.
More information:
- This field is an API idempotency field. For requests that are initiated with the same value of requestId and reach a final status of S or F, the same result is to be returned for the request.
- Maximum length: 32 characters
assetId String REQUIRED
The unique identifier of a card.
More information:
- Maximum length: 32 characters
operateType String REQUIRED
The type of actions taken to change the card status. Valid values are:
FREEZE: Freeze the card.UNFREEZE: Unfreeze the card.CANCEL: Delete the card.
cardStatus String REQUIRED
The card status. Valid values are:
ACTIVE: The card is active and can be used normally.FROZEN: The card is frozen and cannot be used.CANCEL: The card is canceled and no longer valid.
More information:
- Maximum length: 32 characters
createdTime String REQUIRED
Creation time.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
updatedTime String REQUIRED
Update time.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
cardBrand String
Card scheme.
Note: If this field is not specified, MASTERCARD is used by default in this phase.
Response parameters
result Result REQUIRED
The result of the API call.
Request
Response
Result process logic
Send the following message with fixed values to Antom after receiving the notification, to acknowledge that the notification from Antom is received:
If no such message is returned to Antom due to operation issues or network issues, Antom will intermittently send the notification until the required message is returned by the merchant. Resending of the notification will be performed within 24 hours after the first notification is sent. The notification will be resent up to eight times, with an interval of 0s, 2min, 10min, 10min, 1h, 2h, 6h, and 15h.
Note: In the sandbox environment, if you do not return information in the specified format, Antom will not resend asynchronous notifications to you.