Onerway
POST

取消订阅合同

查看 Markdown
该接口用于按 contractId 取消一份已存在的订阅合同，并指定取消生效方式。

请求

merchantNostring必填
Onerway 分配的商户号；获取方式参见接入准备。
示例：replace_with_merchant_no
contractIdstring必填
要取消的订阅合约号，通常来自初始订阅创建后的响应、Webhook，或通过查询订阅信息接口获取。
示例：sub_contract_demo_202606210001
expireModestring可选默认2
订阅取消的生效方式；不传且未提供 expireDate 时，订阅将在当前计费周期结束时取消。
示例：1
可选值
1
立即取消。立即触发订阅取消通知；托管订阅还会向客户发送邮件通知。
2
当前计费周期结束时取消。
3
指定日期取消；必须同时传入 expireDate，取消生效时才发送订阅取消通知。
expireDatestring条件必填
条件：当 expireMode=3，即指定日期取消时必填。
订阅取消生效日期，格式 yyyy-MM-dd。
示例：2026-07-31
signstring必填
请求签名字符串；生成方式详见请求签名。

请求示例

curl -X POST 'https://sandbox-acq.onerway.com/v1/txn/sub/cancel' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "contractId": "sub_contract_demo_202606210001",
  "expireMode": "1",
  "merchantNo": "replace_with_merchant_no",
  "sign": "{{SIGN}}"
}'

响应

respCodestring
响应码；20000 表示请求处理成功，其余为错误码。完整码表见响应码。
respMsgstring
响应码对应的可读消息。
datastring
取消后的订阅合约状态；本接口成功取消示例返回 3。
可选值
0
处理中。
1
生效。
2
不生效。

响应示例

示例代码暂不可用。

该接口暂未记录错误响应。

查询订阅信息

按订阅合约号查询订阅的计费、状态和 token 信息。

查询欺诈通知

按通知 ID、欺诈类型、原交易或生成时间范围查询欺诈通知。