Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spark.money/llms.txt

Use this file to discover all available pages before exploring further.

Claims a deposit made to a static deposit address using quote information from getClaimStaticDepositQuote for the SparkWallet.

​
Method Signature

async claimStaticDeposit({
  transactionId,
  creditAmountSats,
  sspSignature,
  outputIndex,
}: {
  transactionId: string;
  creditAmountSats: number;
  sspSignature: string;
  outputIndex?: number;
}): Promise<ClaimStaticDepositOutput | null>

​
Parameters

​
transactionId
string
required
The Bitcoin transaction ID from the quote
​
creditAmountSats
number
required
The amount of sats from the quote
​
sspSignature
string
required
The SSP signature from the quote
​
outputIndex
number
The index of the output

​
Returns

​
result
ClaimStaticDepositOutput | null
required
The claim result or null if the operation fails

​
Example

const quote = await wallet.getClaimStaticDepositQuote(txId);
const claimResult = await wallet.claimStaticDeposit({
  transactionId: txId,
  creditAmountSats: quote.creditAmountSats,
  sspSignature: quote.signature,  // Note: quote returns 'signature', pass as 'sspSignature'
});
console.log("Claim result:", claimResult);