Skip to main content
POST
Create LSPS1 order

Authorizations

Authorization
string
header
required

Pass a Kaleido API key such as kld_live_c_....

Body

application/json
client_pubkey
string
required
lsp_balance_sat
integer
required
Required range: x >= 0
client_balance_sat
integer
required
Required range: x >= 0
required_channel_confirmations
integer
required
Required range: x >= 0
funding_confirms_within_blocks
integer
required
Required range: x >= 1
channel_expiry_blocks
integer
required
Required range: x >= 1
token
string | null
refund_onchain_address
string | null
announce_channel
boolean
default:true
asset_id
string | null
lsp_asset_amount
integer | null
client_asset_amount
integer | null
rfq_id
string | null
email
string<email> | null

Optional email for notifications

Response

LSPS1 order created successfully.

order_id
string
required
client_pubkey
string
required
lsp_balance_sat
integer
required
client_balance_sat
integer
required
required_channel_confirmations
integer
required
funding_confirms_within_blocks
integer
required
channel_expiry_blocks
integer
required
announce_channel
boolean
required
order_state
enum<string>
required
Available options:
CREATED,
CHANNEL_OPENING,
COMPLETED,
FAILED,
PENDING_RATE_DECISION
payment
PaymentDetails · object
required
token
string | null
default:""
created_at
string<date-time>
channel
ChannelDetails · object | null
asset_id
string | null
lsp_asset_amount
integer | null
client_asset_amount
integer | null
rfq_id
string | null
asset_price_sat
integer | null
failure_reason
string | null
access_token
string | null