Skip to main content
POST
Order a channel

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

POST /v2/lsps1/order body — LSPS1 create_order params (snake_case).

channel_expiry_blocks
integer<int32>
required
Required range: x >= 0
lsp_balance_sat
string
required

Inbound liquidity (sats) the client wants. Decimal string per spec.

public_key
string
required

The client's node id (33-byte hex) — who the maker opens the channel to.

address
string | null

Optional host:port the maker connects to before opening. If omitted the client must already be peered with the maker.

announce_channel
boolean | null
client_balance_sat
string | null

Sats the LSP pushes to the client's side at open. Decimal string.

funding_confirms_within_blocks
integer<int32> | null
Required range: x >= 0
refund_onchain_address
string | null

Where to refund the on-chain payment if the order fails.

required_channel_confirmations
integer<int32> | null
Required range: x >= 0

Response

Order created; pay the returned address.

POST /v2/lsps1/order & GET /v2/lsps1/order/{id} response.

announce_channel
boolean
required
channel_expiry_blocks
integer<int32>
required
Required range: x >= 0
client_balance_sat
string
required
funding_confirms_within_blocks
integer<int32>
required
Required range: x >= 0
lsp_balance_sat
string
required
order_id
string
required
order_state
string
required

CREATED / COMPLETED / FAILED / EXPIRED.

payment
object
required
required_channel_confirmations
integer<int32>
required
Required range: x >= 0
channel
object | null
created_at
string | null
expired_at
string | null
expires_at
string | null