本页内容
停用
停止把新的充值计入某个收款通道,同时不删除记录、不释放地址、不影响已经收到的付款。
POST/v1/payment-channels/:payment_channel_id/block
API 密钥: Payment
停用是让一个通道退出使用的方式。这里没有删除:付款人存下来的地址绝不能变成别人的,所以记录留着,路线也留着,只是不再通过它们给你入账。
无请求体。
停用会做什么
- —新的充值不再计入这个通道
- —
status变为blocked,is_accepting_payments变为false - —地址不释放、不重新分配,仍然永久属于这个通道
- —已经收到的充值不受影响。停用时仍在
confirming的那条照样走到confirmed,照样记账,照样发 webhook,照样出现在数据流里 - —开通不停止。还在建的网络继续建,因此以后恢复通道时,它是完整就绪的
对已经停用的通道重复调用是空操作,返回同一个通道和 200 OK。
响应 (200 OK)
完整的通道对象,形状与获取返回的一致,其中 status 现为 blocked,is_accepting_payments 现为 false。其余字段——包括整个 networks 数组——都没有变化。
错误
| 错误码 | HTTP | 何时出现 |
|---|---|---|
payment_channels_disabled |
503 | 本环境下你的账户未开通收款通道 |
payment_key_required |
403 | 请求用 Payout(rk_)key 签名 |
payment_channel_not_found |
404 | 该 id 解析不到这个凭证可以看到的任何东西 |
field_invalid_format |
400 | 路径段不是合法的 pc_ 标识 |