getTransfer

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

string

required

The transfer ID to query

Returns

WalletTransfer | undefined

required

The transfer details, or undefined if not found

WalletTransfer Fields

Field	Type	Description
`id`	`string`	Unique transfer identifier
`status`	`string`	Transfer status (`TRANSFER_STATUS_SENDER_KEY_TWEAKED`, `TRANSFER_STATUS_COMPLETED`, etc.)
`totalValue`	`number`	Amount in satoshis
`senderIdentityPublicKey`	`string`	Sender’s identity public key
`receiverIdentityPublicKey`	`string`	Receiver’s identity public key
`transferDirection`	`string`	`INCOMING` or `OUTGOING` relative to this wallet
`createdTime`	`Date \| undefined`	When the transfer was created
`updatedTime`	`Date \| undefined`	When the transfer was last updated
`expiryTime`	`Date \| undefined`	When the transfer expires
`sparkInvoice`	`string \| undefined`	The Spark invoice associated with this transfer, if any

Example

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

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

Method Signature

Parameters

Returns

WalletTransfer Fields

Example