取消订阅
订阅取消发起后,后续已计划的扣款也会一起被取消。如果取消是在扣款到期日的前一天(T-1)晚上 22:00 点之后发起的,那么次日已排程好的扣款不会被取消,仍然会继续扣费。扣款通知可以通过用于付款取消的异步通知机制来处理。
商户侧发起取消
步骤 1:发起取消请求 服务端
参数名 | 必需 | 描述 |
subscriptionId | 否 | |
subscriptionRequestId | 否 | 商户分配的唯一ID,用于标识订阅请求。 |
cancellationType | 是 | 订阅取消类型。有效值为:
|
public static void cancelSubscription() {
AlipayCancelSubscriptionRequest cancelSubscriptionRequest = new AlipayCancelSubscriptionRequest();
cancelSubscriptionRequest.setSubscriptionId(subscriptionId);
cancelSubscriptionRequest.setSubscriptionRequestId(subscriptionRequestId);
cancelSubscriptionRequest.cancellationType("CANCEL");
}以下代码展示了一个请求示例:
{
"subscriptionId": "20221215190000000000000040000",
"cancellationType": "CANCEL"
}注意: 对于 Pix Automático, cancellationType 不支持 TERMINATE。
以下代码展示了一个响应示例:
{
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success.",
"resultStatus": "S"
}
}下表展示了响应代码中 result.resultStatus 参数可能返回的值,请您根据指引进行处理:
resultStatus | 描述 | 后续操作 |
S | 取消请求已受理。 | |
F | 取消失败。 | |
U | 状态未知。 | 使用相同的 paymentRequestId 重新发送请求。如果在连续三次重试后,result.resultStatus 的值仍然为 U,请联系 Antom 技术支持。 |
步骤 2:获取取消结果
以下代码显示了异步通知请求的示例:
{
"periodRule": {
"periodType": "MONTH",
"periodCount": 1
},
"subscriptionEndTime": "2023-11-06T08:00:00-08:00",
"subscriptionId": "20221205190000000000000450000007269",
"subscriptionRequestId": "amsmdsubscription_20221206_033332_074",
"subscriptionStartTime": "2022-10-04T09:00:00-07:00",
"subscriptionNotificationType": "CANCEL"
}在银行 app 发起取消
当买家不再需要某项服务时,他们可以自由取消订阅,并根据自身需求决定是否续订,从而在账户管理中提供更大的灵活性和控制权。一旦订阅被取消,Antom将使用 notifySubscription 接口向您在注册请求中传入的subscriptionNotifyURL 发送异步通知,同时买家的钱包访问令牌也将过期。
以下代码显示了异步通知的示例,其中包含以下参数:
- subscriptionNotificationType: 订阅的通知类型。
- CREATE: 表示订阅已创建。
- CHANGE: 表示订阅已更改。
- CANCEL: 表示订阅已取消,当前订阅期结束后将不再提供服务。
- TERMINATE: 表示订阅已终止,将不再提供服务。
- UPDATE: 表示订阅已更新。
{
"periodRule": {
"periodType": "MONTH",
"periodCount": 1
},
"subscriptionEndTime": "2023-11-06T08:00:00-08:00",
"subscriptionId": "20221205190000000000000450000007269",
"subscriptionRequestId": "amsmdsubscription_20221206_033332_074",
"subscriptionStartTime": "2022-10-04T09:00:00-07:00",
"subscriptionStatus": "ACTIVE",
"subscriptionNotificationType": "CANCEL"
}