Antom, leading provider of tailored payment solutions

notifySubscription

当订阅创建成功或失败时,Antom 会使用此接口将订阅结果发送给商家。

结构

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

注意:将每个参数(除数组外)的数据类型设置为字符串,即参数的值必须使用英文双引号(" ")包裹起来。例如:

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


入参

subscriptionRequestId String  REQUIRED

商家为识别订阅请求而分配的专属 ID。

更多信息:

  • 最大长度:64 字符

subscriptionId String  REQUIRED

Antom 为识别订阅而分配的专属 ID。

更多信息:

  • 最大长度:64 字符

subscriptionStatus String  REQUIRED

订阅状态。有效值包括:

  • ACTIVE: 表示订阅已生效。
  • TERMINATED: 表示订阅已被终止。

更多信息:

  • 最大长度:32 字符

subscriptionNotificationType String  REQUIRED

关于订阅的通知类型。

  • CREATE: 表示订阅已创建。
  • CHANGE: 表示订阅已更改。
  • CANCEL: 表示订阅被取消,服务在当前订阅期结束后不再提供。
  • TERMINATE: 表示订阅被终止,不再提供服务。
  • UPDATE:表示订阅已更新。

更多信息:

  • 最大长度:32 字符

subscriptionStartTime Datetime  REQUIRED

订阅生效的日期和时间。

更多信息:

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

subscriptionEndTime Datetime  REQUIRED

订阅结束的日期和时间。

更多信息:

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

periodRule PeriodRule  REQUIRED

订阅周期规则,用于定义订阅的计费周期。

fixedAmount Amount  

固定订阅金额。

出参

result Result  REQUIRED

发送给 Antom 来确认已收到通知的固定值。

API Explorer

请求

Case
json
{
  "periodRule": {
    "periodCount": 1,
    "periodType": "MONTH"
  },
  "subscriptionEndTime": "2023-11-06T08:00:00-08:00",
  "subscriptionId": "20221205190000000000000450000007269",
  "subscriptionNotificationType": "CREATE",
  "subscriptionRequestId": "amsmdsubscription_20221206_033332_074",
  "subscriptionStartTime": "2022-10-04T09:00:00-07:00",
  "subscriptionStatus": "ACTIVE"
}

响应

json
{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success.",
    "resultStatus": "S"
  }
}

结果处理逻辑

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

json
{
  "result": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "success"
  }
}

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

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