Struct GetPaymentCommandResult 

pub struct GetPaymentCommandResult {
    pub payment_hash: Hash256,
    pub payment_preimage: Option<Hash256>,
    pub status: PaymentStatus,
    pub created_at: u64,
    pub last_updated_at: u64,
    pub failed_error: Option<String>,
    pub fee: u128,
    pub custom_records: Option<PaymentCustomRecords>,
    pub routers: Vec<SessionRoute>,
}

The result of a get_payment command, which includes the payment hash, status, timestamps, error message if failed, fee paid, and custom records.

Fields

payment_hash: Hash256

The payment hash of the payment

payment_preimage: Option<Hash256>

The preimage learned from a successful payment attempt.

status: PaymentStatus

The status of the payment

created_at: u64

The time the payment was created at, in milliseconds from UNIX epoch

last_updated_at: u64

The time the payment was last updated at, in milliseconds from UNIX epoch

failed_error: Option<String>

The error message if the payment failed

fee: u128

fee paid for the payment

custom_records: Option<PaymentCustomRecords>

The custom records to be included in the payment.

routers: Vec<SessionRoute>

The router is a list of nodes that the payment will go through. We store in the payment session and then will use it to track the payment history. If the payment adapted MPP (multi-part payment), the routers will be a list of nodes. For example: A(amount, channel) -> B -> C -> D means A will send amount with channel to B.

Trait Implementations

impl Clone for GetPaymentCommandResult

fn clone(&self) -> GetPaymentCommandResult

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetPaymentCommandResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetPaymentCommandResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for GetPaymentCommandResult

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for GetPaymentCommandResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.