payLightningInvoice

Pay a Lightning Network invoice from a Spark wallet.

POST /v1/wallets/{wallet_id}/rpc

curl --request POST \

  --url https://api.privy.io/v1/wallets/{wallet_id}/rpc \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'privy-app-id: <privy-app-id>' \
  --data '{
  "method": "payLightningInvoice",
  "network": "MAINNET",
  "params": {
    "invoice": "lnbc1230n1p...",
    "max_fee_sats": 5,
    "prefer_spark": true,
    "amount_sats_to_send": 5000
  }
}'

200

{
  "method": "payLightningInvoice",
  "data": {
    "id": "2fb0b49e-0aef-4726-a348-2dd0a9432c12",
    "created_at": "2025-07-24T16:43:12.509Z",
    "updated_at": "2025-07-24T16:43:12.509Z",
    "network": "MAINNET",
    "encoded_invoice": "lnbc1230n1p...",
    "fee": {
      "original_value": 3,
      "original_unit": "SATOSHI"
    },
    "status": "SUCCESS",
    "typename": "LightningSendRequest"
  }
}

Idempotency on errors: On 4xx or 5xx, Privy caches the response and replays it for the same key. Generate a new key to retry after a server error. Policy violations are an exception and allow same-key retries.

curl --request POST \

  --url https://api.privy.io/v1/wallets/{wallet_id}/rpc \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'privy-app-id: <privy-app-id>' \
  --data '{
  "method": "payLightningInvoice",
  "network": "MAINNET",
  "params": {
    "invoice": "lnbc1230n1p...",
    "max_fee_sats": 5,
    "prefer_spark": true,
    "amount_sats_to_send": 5000
  }
}'

200

{
  "method": "payLightningInvoice",
  "data": {
    "id": "2fb0b49e-0aef-4726-a348-2dd0a9432c12",
    "created_at": "2025-07-24T16:43:12.509Z",
    "updated_at": "2025-07-24T16:43:12.509Z",
    "network": "MAINNET",
    "encoded_invoice": "lnbc1230n1p...",
    "fee": {
      "original_value": 3,
      "original_unit": "SATOSHI"
    },
    "status": "SUCCESS",
    "typename": "LightningSendRequest"
  }
}

Headers

privy-app-id · string · required

ID of your Privy app.

privy-authorization-signature · string

Request authorization signature. If multiple signatures are required, they should be comma separated.

privy-request-expiry · string

Request expiry. Value is a Unix timestamp in milliseconds representing the deadline by which the request must be processed.

Path Parameters

wallet_id · string · required

ID of the wallet to get.

These wallet methods are modeled after the Spark Wallet SDK. For more information about this wallet method, check out the Spark Wallet documentation.

Body

method · string · required

Available options: payLightningInvoice

network · string · required

Available options: MAINNET, REGTEST

params · object · required

Hide child attributes

invoice · string · required

The BOLT11 Lightning invoice to pay.

max_fee_sats · number · required

Maximum fee (in sats) the payer is willing to pay.

prefer_spark · boolean

Whether to prefer paying on Spark. If true, will return a Transfer object. Defaults to false.

amount_sats_to_send · number

Amount to pay in sats. Required only for zero-amount invoices.

Returns

method · enum<string> · required

Available options: payLightningInvoice

data · object · required

If prefer_spark is false, a LightningSendRequest object with the following fields:

Hide child attributes

id · string · required

created_at · string · required

updated_at · string · required

network · string · required

encoded_invoice · string · required

fee · object · required

Hide child attributes

original_value · number

original_unit · string

status · string · required

typename · string · required

If prefer_spark is true, the response will be a Transfer object with the following fields:

Hide child attributes

id · string · required

sender_identity_public_key · string · required

receiver_identity_public_key · string · required

status · string · required

total_value · number · required

expiry_time · string

leaves · array<object> · required

Each item contains transfer metadata and encrypted leaf information.

Hide child attributes

leaf · object · required

Hide child attributes

id · string · required

tree_id · string · required

value · number · required

parent_node_id · string · required

node_tx · string · required

refund_tx · string · required

vout · number · required

verifying_public_key · string · required

owner_identity_public_key · string · required

signing_keyshare · object · required

Hide child attributes

owner_identifiers · array<string> · required

threshold · number · required

public_key · string · required

public_shares · object · required

A mapping from signer identifier to public share

updated_time · string · required

status · string · required

network · string · required

secret_cipher · string · required

signature · string · required

intermediate_refund_tx · string · required

created_time · string

updated_time · string

type · string

transfer_direction · string

encoding · string