org.lightningj.paywall.paymenthandler.data

Interface StandardPaymentData

All Superinterfaces:

MinimalPaymentData, PaymentData

All Known Subinterfaces:

FullPaymentData

All Known Implementing Classes:

DemoFullPaymentData

public interface StandardPaymentData
extends MinimalPaymentData

A Standard PaymentData contains most of the needed data fields to be stored in a normal lightning related invoicing solution.

If system should support payPerRequest payments should the implementing data also implement the PerRequestPaymentData.

See Also:

PerRequestPaymentData, Created by Philip Vendil on 2018-12-10.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
CryptoAmount	getInvoiceAmount()
java.time.Instant	getInvoiceDate()
java.time.Instant	getInvoiceExpireDate()
CryptoAmount	getSettledAmount()
java.time.Instant	getSettlementDate()
java.time.Duration	getSettlementDuration() The settlement duration indicates how long time a generated settlement should be valid.
void	setDescription(java.lang.String description)
void	setInvoiceAmount(CryptoAmount invoiceAmount)
void	setInvoiceDate(java.time.Instant invoiceDate)
void	setInvoiceExpireDate(java.time.Instant invoiceExpireDate)
void	setSettledAmount(CryptoAmount settledAmount)
void	setSettlementDate(java.time.Instant settlementDate)
void	setSettlementDuration(java.time.Duration settlementDuration) The settlement duration indicates how long time a generated settlement should be valid.

Methods inherited from interface org.lightningj.paywall.paymenthandler.data.MinimalPaymentData

getOrderAmount, getPreImageHash, isSettled, setOrderAmount, setPreImageHash, setSettled

Method Detail

getDescription

java.lang.String getDescription()

Returns:

a short description of the payment used in the lightning invoice and might be displayed to the end user.

setDescription

void setDescription(java.lang.String description)

Parameters:

description - a short description of the payment used in the lightning invoice and might be displayed to the end user.

getInvoiceAmount

CryptoAmount getInvoiceAmount()

Returns:

the amount set in the lightning invoice, this is the same as orderAmount if the same currency is used in order as in lightning invoice, otherwise is the currency converted before creating the invoice in LightningHandler and the actual invoiced amount is specified here.

setInvoiceAmount

void setInvoiceAmount(CryptoAmount invoiceAmount)

Parameters:

invoiceAmount - the amount set in the lightning invoice, this is the same as orderAmount if the same currency is used in order as in lightning invoice, otherwise is the currency converted before creating the invoice in LightningHandler and the actual invoiced amount is specified here.

getInvoiceDate

java.time.Instant getInvoiceDate()

Returns:

the date the invoice was created in LightningHandler.

setInvoiceDate

void setInvoiceDate(java.time.Instant invoiceDate)

Parameters:

invoiceDate - the date the invoice was created in LightningHandler.

getInvoiceExpireDate

java.time.Instant getInvoiceExpireDate()

Returns:

the date a generated invoice should expire, this value will be used when creating invoice in LightningHandler. If null will default invoice validity be used to calculate an expire date automatically.

setInvoiceExpireDate

void setInvoiceExpireDate(java.time.Instant invoiceExpireDate)

Parameters:

invoiceExpireDate - the date a generated invoice should expire, this value will be used when creating invoice in LightningHandler. If null will default invoice validity be used to calculate an expire date automatically.

getSettledAmount

CryptoAmount getSettledAmount()

Returns:

the amount that was settled in the LightningHandlers supported crypto currency. Should be equal to invoiceAmount if fully settled. Null if invoice isn't settled yet.

setSettledAmount

void setSettledAmount(CryptoAmount settledAmount)

Parameters:

settledAmount - the amount that was settled in the LightningHandlers supported crypto currency. Should be equal to invoiceAmount if fully settled. Null if invoice isn't settled yet.

getSettlementDate

java.time.Instant getSettlementDate()

Returns:

the timestamp the invoice was settled in LightningHandler. Null if not settled yet.

setSettlementDate

void setSettlementDate(java.time.Instant settlementDate)

Parameters:

settlementDate - the timestamp the invoice was settled in LightningHandler. Null if not settled yet.

getSettlementDuration

java.time.Duration getSettlementDuration()

The settlement duration indicates how long time a generated settlement should be valid. If not set will a default settlement value be used. In FullPaymentData it is also possible to specifiy an expiration date of an settlement used if it's required to set a fixed time when the settlement should expire, for example if a settlement should be valid the entire day or month.

If settlement expire date is set it has precedence over settlementDuration.

Important: Data in this field is only set to instruct the settlement token generator of expiration date. the actual settlement date is not updated in this field.

Returns:

the duration the settlement should be valid, null if default settlement duration should be used or if a fixed expiration date should be used.

See Also:

FullPaymentData.getSettlementExpireDate()

setSettlementDuration

void setSettlementDuration(java.time.Duration settlementDuration)

The settlement duration indicates how long time a generated settlement should be valid. If not set will a default settlement value be used. In FullPaymentData it is also possible to specifiy an expiration date of an settlement used if it's required to set a fixed time when the settlement should expire, for example if a settlement should be valid the entire day or month.

If settlement expire date is set it has precedence over settlementDuration.

Parameters:

settlementDuration - the specific duration of this message.

See Also:

FullPaymentData.getSettlementExpireDate()