Skip to main content
Gets a specific transfer by ID that the wallet is a participant of.
This returns Spark transfer data only. For Lightning-related transfer information, use getTransferFromSsp().

​
Method Signature

async getTransfer(id: string): Promise<WalletTransfer | undefined>

​
Parameters

​
id
string
required
The transfer ID to query

​
Returns

​
transfer
WalletTransfer | undefined
required
The transfer details, or undefined if not found

​
WalletTransfer Fields

FieldTypeDescription
idstringUnique transfer identifier
statusstringTransfer status (TRANSFER_STATUS_SENDER_KEY_TWEAKED, TRANSFER_STATUS_COMPLETED, etc.)
totalValuenumberAmount in satoshis
senderIdentityPublicKeystringSender’s identity public key
receiverIdentityPublicKeystringReceiver’s identity public key
transferDirectionstringINCOMING or OUTGOING relative to this wallet
createdTimeDate | undefinedWhen the transfer was created
updatedTimeDate | undefinedWhen the transfer was last updated
expiryTimeDate | undefinedWhen the transfer expires

​
Example

const transfer = await wallet.getTransfer("transfer-id-here");
if (transfer) {
  console.log("Transfer status:", transfer.status);
  console.log("Amount:", transfer.totalValue);
}