v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB

Deposit via Lightning

Add funds to a Bitcoin account using the Lightning Network

post/wallets/account/lightning/topup

Headers

api-keystring required

api-key is available on the dashboard

Authorizationstring required

Request body

userIdstring required

The Id of the user who is sending this transaction

accountIdstring required

The Id of the account to credit

memostring

An optional memo

amountstring required

Amount in satoshis

ttlinteger

LN Invoice expiry in minutes (Between 10 and 1440)

proposedRatestring

Used ONLY for Standing Orders -> A rate to honor when converting BTC into EUR. Example: "97175.19"

fillOrKillAtProposedRateboolean

Used ONLY for Standing Orders -> If this value is true and the provided proposedRate cannot be honored (i.e. outside tolerance threshold), the swap will not be executed.

Response

200

idstring

descriptionstring

amountinteger

invoicestring

expiryinteger

Example response

{
  "id": "85c0f778-388d-4828-9066-8de60eb8c035",
  "description": "extend methodologies clicks-and-mortar",
  "amount": 500,
  "invoice": "lntb5u1p30y64npp5w5lp9v25yz4trdc204l2he262jywaehymnqx0mtel0l6lk3r8m9qdpav4u8getwvssx6et5dphkgmmvdankjetnyp3kc6trddej6ctwvskk6mmjw3shycqzpgxqzjhsp5cnstd43825ttacu682m39d6frdttz7wkucx3lr8je9p2yhtqtvvs9qyyssqr5m7s4x8a9efvumqcynj30jaf05pkd0d7f0a8jplgqqyvg7um8lxqp6y63m7mmvc2qvx93lr0tvvyjarmpapcnfcqaz23as5q8r99sspguqp9z",
  "expiry": 1660054794
}