Antom, leading provider of tailored payment solutions
Contact Us
登 录

notifyCardStatus

此 API 用于通知商户或合作伙伴卡的状态发生变化。

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息，有关报文头的结构信息，请参阅：

注意：将每个字段（除数组外）的数据类型设置为字符串。这意味字段值必须使用双引号（" "）括起来。例如：

  • 如果字段的数据类型为整数属性，且其值为 20，设置为 "20"。
  • 如果字段的数据类型为布尔属性，且其值为 true，设置为 "true"。


入参

requestId String  REQUIRED

针对本次申卡请求，由商户指定的唯一请求号。Antom 使用此字段进行幂等性控制。

更多信息：

  • 此为幂等字段。对于使用相同 requestId ，且最终状态为S或F发起的支付请求，应返回相同的结果。
  • 最大长度：32 字符

assetId String  REQUIRED

银行卡的唯一标识符。

更多信息：

  • 最大长度：32 字符

operateType String  REQUIRED

更改卡状态所采取的操作类型。有效值为：

  • FREEZE：冻结卡。
  • UNFREEZE：解冻卡。
  • CANCEL：删除卡。

cardStatus String  REQUIRED

卡的状态。有效值为：

  • ACTIVE：卡已激活，可以正常使用。
  • FROZEN：该卡已被冻结，无法使用。
  • CANCEL：该卡被注销，不再有效。

更多信息：

  • 最大长度：32 字符

createdTime String  REQUIRED

创建时间。

更多信息：

  • 值遵循 ISO 8601 标准格式。例如，“2019-11-27T12:01:01+08:00”。

updatedTime String  REQUIRED

更新时间。

更多信息：

  • 值遵循 ISO 8601 标准格式。例如，“2019-11-27T12:01:01+08:00”。

cardBrand String  

卡组。

注意：如果未指定该字段，默认使用 ​MASTERCARD。

出参

result Result  REQUIRED

接口调用的结果。

Show child parameters
API Explorer

请求

请求体

响应

响应体

结果处理逻辑

在收到 Antom 通知后，发送以下固定值的消息给 Antom，以确认收到 Antom 的通知：

Sample Code

如果由于操作问题或网络问题没有将此类消息返回给 Antom，Antom 会反复发送通知，直到商家返回所需消息。首次通知发送后的 24 小时内会进行重试。通知将重试最多八次，间隔为 0 秒, 2 分钟, 10 分钟, 10 分钟, 1 小时, 2 小时, 6 小时, 和 15 小时。

注意：沙箱环境中，如果您没有按照固定格式返回信息，Antom 将不会重新发送异步通知给您。