OutgoingPayment

data class OutgoingPayment(id: UUID, recipientAmount: MilliSatoshi, recipient: PublicKey, details: OutgoingPayment.Details, parts: List<OutgoingPayment.Part>, status: OutgoingPayment.Status, createdAt: Long) : WalletPayment

An outgoing payment sent by this node. The payment may be split in multiple parts, which may fail, be retried, and then either succeed or fail.

Parameters

internal payment identifier.

recipientAmount

total amount that will be received by the final recipient (NB: it doesn't contain the fees paid).

recipient

final recipient nodeId.

details

details that depend on the payment type (normal payments, swaps, etc).

parts

partial child payments that have actually been sent.

status

current status of the payment.

Constructors

OutgoingPayment

common

fun OutgoingPayment(id: UUID, amount: MilliSatoshi, recipient: PublicKey, details: OutgoingPayment.Details)

OutgoingPayment

common

fun OutgoingPayment(id: UUID, recipientAmount: MilliSatoshi, recipient: PublicKey, details: OutgoingPayment.Details, parts: List<OutgoingPayment.Part>, status: OutgoingPayment.Status, createdAt: Long = currentTimestampMillis())

Types

Details

common

sealed class Details

Part

common

data class Part(id: UUID, amount: MilliSatoshi, route: List<HopDesc>, status: OutgoingPayment.Part.Status, createdAt: Long)

An child payment sent by this node (partial payment of the total amount).

Status

common

sealed class Status

Functions

completedAt

common

fun completedAt(): Long

Absolute time in milliseconds since UNIX epoch when the payment was completed.

Properties

amount

common

open override val amount: MilliSatoshi

Amount actually sent for this payment. It does include the fees.

createdAt

common

val createdAt: Long

details

common

val details: OutgoingPayment.Details

fees

common

open override val fees: MilliSatoshi

Fees applied to complete this payment.

common

val id: UUID

parts

common

val parts: List<OutgoingPayment.Part>

paymentHash

common

val paymentHash: ByteVector32

recipient

common

val recipient: PublicKey

recipientAmount

common

val recipientAmount: MilliSatoshi

status

common

val status: OutgoingPayment.Status