跳到正文

API

本页内容

取消

在交易签名开始前取消待处理的转出，了解哪些状态允许取消，并处理更新后的响应。

POST/v1/withdrawals/:withdrawal_id/cancel

API 密钥： Payout

取消尚未开始执行的转出。Paymos 一开始处理该付款，窗口就关闭——这发生在转出仍为 created、任何签名完成之前。因此 created 状态本身并不保证转出仍可取消：执行一旦开始，调用返回 409。取消已取消的转出是空操作：返回 200 和同一笔转出，不报错。

请求体

发送 reason（必填，最长 500 字符）。Paymos 会把它保存在转出记录上，并写入审计日志。它不会回传给你：取消响应和 withdrawal.cancelled webhook 携带的都是状态，不是原因。

{
  "reason": "Customer requested cancellation"
}

响应 (200 OK)

{
  "withdrawal_id": "wdr_2M8K6Q4P9X1Z7A3B",
  "external_order_id": "payout-001",
  "status": "cancelled",
  "is_final": true,
  "is_test": true,
  "amount": "100.00",
  "currency": "USDT",
  "network": "TRC20",
  "destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
  "created_at": 1739289600,
  "cancelled_at": 1739289660
}

错误

完整目录见 错误码。每个错误响应中的 type URI 直接链接到对应条目。

获取转出 模拟转出完成