Estimate Lightning receive fee

curl --request GET \
  --url https://api.example.com/api/v1/fees/lightning/receive \
  --header 'Authorization: Bearer <token>'

{
  "fee_sat": 1,
  "gross_amount_sat": 1,
  "net_amount_sat": 1,
  "vtxos_spent": [
    "<string>"
  ]
}

GET

api

fees

lightning

receive

Estimate Lightning receive fee

curl --request GET \
  --url https://api.example.com/api/v1/fees/lightning/receive \
  --header 'Authorization: Bearer <token>'

{
  "fee_sat": 1,
  "gross_amount_sat": 1,
  "net_amount_sat": 1,
  "vtxos_spent": [
    "<string>"
  ]
}

Authorization

string

header

required

Base64url-encoded auth token

amount_sat

integer<int64>

required

The amount in satoshis to receive over Lightning

Required range: x >= 0

Returns the fee estimate

A fee estimate for an Ark wallet operation.

fee_sat

integer<int64>

required

The fee portion (in satoshis)

Required range: x >= 0

gross_amount_sat

integer<int64>

required

The total amount including fees (in satoshis)

Required range: x >= 0

net_amount_sat

integer<int64>

required

The amount excluding fees (in satoshis). For sends, this is the amount the recipient receives. For receives, this is the amount the user gets.

Required range: x >= 0

vtxos_spent

string[]

required

The VTXOs that would be spent for this operation

⌘I