Skip to content

API

On this page

Block

Stop attributing new deposits to a payment channel without deleting it, releasing its addresses or affecting payments already received.

POST/v1/payment-channels/:payment_channel_id/block

API key: Payment

Blocking is how you retire a channel. There is no delete: an address a payer has saved must never start belonging to someone else, so the record stays and the routes stay, and you simply stop being credited through them.

No request body.

What blocking does

  • —New deposits are no longer attributed to this channel.
  • —status becomes blocked and is_accepting_payments becomes false.
  • —Addresses are not released and not reassigned. They remain this channel's forever.
  • —Deposits already received are untouched. A deposit still confirming when you block still reaches confirmed, still books, still fires its webhook and still appears in the feed.
  • —Provisioning does not stop. Networks that were still being set up keep going, so unblocking later gives you a channel that is fully ready.

Repeating the call on an already-blocked channel is a no-op that returns the same channel with 200 OK.

Response (200 OK)

The full channel object, in the same shape Retrieve returns, with status now blocked and is_accepting_payments now false. Every other field, including the whole networks array, is unchanged.

Errors

Code HTTP When
payment_channels_disabled 503 Payment channels are not enabled for your account in this environment.
payment_key_required 403 The request was signed with a Payout (rk_) key.
payment_channel_not_found 404 The id resolves to nothing this credential may see.
field_invalid_format 400 The path segment is not a valid pc_ identifier.

See Error Codes for the full catalogue, and Unblock to reverse this.

Retrieve Payment Channel Unblock Payment Channel