Skip to navigation
API ReferenceFunding

Lightning withdrawal

Withdraw BTC over the Lightning Network. Only supported for the BTC currency, with withdrawal amounts between 0.000001 and 0.1 BTC.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
ccystringRequired
Currency, only BTC is supported.
invoicestringRequired
The Lightning Network invoice to pay.
memostringOptional
Lightning withdrawal memo.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional