Skip to navigation
API ReferenceFunding

Get Lightning deposit invoice

Generate a Lightning Network invoice to deposit BTC. Only supported for the BTC currency, with 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.

Query parameters

ccystringRequired
Currency, only BTC is supported.
amtstringRequired
Deposit amount between 0.000001 and 0.1.
toenumOptional

Receiving account: 6=Funding account, 18=Trading account. Default is 6.

Allowed values:

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