On this page
Unblock
Resume attributing deposits to a payment channel; the server returns it to active or provisioning depending on whether an address exists.
POST/v1/payment-channels/:payment_channel_id/unblock
API key: Payment
Reverses a block. The channel resumes accepting deposits on every route it has.
No request body.
Which status you get back
You do not choose it — the server resolves it from what the channel actually has:
| Condition | Resulting status |
|---|---|
| At least one network already has an address | active |
| No address exists yet | provisioning |
Because provisioning keeps running while a channel is blocked, a channel blocked early and unblocked later usually comes back active with more networks ready than it had before.
Repeating the call on a channel that is not blocked 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 resolved as above.
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.