Spark prepare Lightning receive

Generate a random payment preimage inside the Turnkey enclave, Feldman-split it for Spark Operators, and return only the payment hash — the raw preimage never leaves the enclave.

type · enum<string> · required

Enum options: ACTIVITY_TYPE_SPARK_PREPARE_LIGHTNING_RECEIVE

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

The parameters object containing the specific intent data for this activity.

Show details

parameters.lightningReceive · object · required

Configuration for the Lightning receive operation: how many Spark Operators share the preimage and who they are.

Show lightningReceive details

parameters.lightningReceive.operatorRecipients · array · required

The Spark Operators that will each hold an encrypted Feldman share of the preimage. When a Lightning payment arrives, threshold operators reconstruct the preimage and reveal it to the Spark Service Provider (SSP) to settle the payment.

Show item details

generateAppProofs · boolean

Enable to have your activity generate and return App Proofs, enabling verifiability.

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/spark_prepare_lightning_receive \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_SPARK_PREPARE_LIGHTNING_RECEIVE",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "signWith": "<spark-address>",
        "lightningReceive": {
            "threshold": 2,
            "operatorRecipients": [
                { "operatorId": "SO1", "encryptionPublicKey": "<so1-pubkey-hex>" },
                { "operatorId": "SO2", "encryptionPublicKey": "<so2-pubkey-hex>" }
            ]
        }
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SPARK_PREPARE_LIGHTNING_RECEIVE",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "sparkPrepareLightningReceiveIntent": {
            "signWith": "<spark-address>",
            "lightningReceive": "<object>"
          }
        },
        "result": {
          "sparkPrepareLightningReceiveResult": {
            "operatorPackages": [
              { "operatorId": "SO1", "encryptedPackage": "<hex>" },
              { "operatorId": "SO2", "encryptedPackage": "<hex>" }
            ],
            "paymentHash": "<32-byte-hex>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}