org.lightningj.paywall.paymenthandler.data

Interface FullPaymentData

All Superinterfaces:

MinimalPaymentData, PaymentData, PerRequestPaymentData, StandardPaymentData

All Known Implementing Classes:

DemoFullPaymentData

public interface FullPaymentData
extends StandardPaymentData, PerRequestPaymentData

Interface defining the complete set of fields in a payment data and can be implemented for best performance of the system.

If the payment contains all fields necessary in a payment flow it will not perform look-ups of invoices in LightningHandler to the same extent which may boost performance.

See Also:

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBolt11Invoice()
java.time.Instant	getSettlementExpireDate() The settlement expire date sets the timestamp when a generated settlement token should expire.
java.time.Instant	getSettlementValidFrom()
void	setBolt11Invoice(java.lang.String bolt11Invoice)
void	setSettlementExpireDate(java.time.Instant settlementExpireDate) The settlement expire date sets the timestamp when a generated settlement token should expire.
void	setSettlementValidFrom(java.time.Instant settlementValidFrom)

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

getDescription, getInvoiceAmount, getInvoiceDate, getInvoiceExpireDate, getSettledAmount, getSettlementDate, getSettlementDuration, setDescription, setInvoiceAmount, setInvoiceDate, setInvoiceExpireDate, setSettledAmount, setSettlementDate, setSettlementDuration

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

isExecuted, isPayPerRequest, setExecuted, setPayPerRequest

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

getOrderAmount, getPreImageHash, isSettled, setOrderAmount, setPreImageHash, setSettled

Method Detail

getBolt11Invoice

java.lang.String getBolt11Invoice()

Returns:

the bolt11 lightning invoice displayed to the end user before paying and invoice.

setBolt11Invoice

void setBolt11Invoice(java.lang.String bolt11Invoice)

Parameters:

bolt11Invoice - the bolt11 lightning invoice displayed to the end user before paying and invoice.

getSettlementValidFrom

java.time.Instant getSettlementValidFrom()

Returns:

the valid from timestamp used in generated settlement tokens. If null is no valid from used, only validUntil.

setSettlementValidFrom

void setSettlementValidFrom(java.time.Instant settlementValidFrom)

Parameters:

settlementValidFrom - the valid from timestamp used in generated settlement tokens. If null is no valid from used, only validUntil.

getSettlementExpireDate

java.time.Instant getSettlementExpireDate()

The settlement expire date sets the timestamp when a generated settlement token should expire. If not set will a settlementDuration be used, and if that is also null will default duration be set. This field is useful 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 date the settlement will expire used to indicate how long a settlement token should be valid. If null will default settlement validity be used. If settlementExpireDate is set it will override the settlement duration value.

See Also:

StandardPaymentData.getSettlementDuration()

setSettlementExpireDate

void setSettlementExpireDate(java.time.Instant settlementExpireDate)

The settlement expire date sets the timestamp when a generated settlement token should expire. If not set will a settlementDuration be used, and if that is also null will default duration be set. In FullPaymentData it is also possible This field is useful 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.

Parameters:

settlementExpireDate - the date the settlement will expire used to indicate how long a settlement token should be valid. If null will default settlement validity be used. If settlementExpireDate is set it will override the settlement duration value.

See Also:

StandardPaymentData.getSettlementDuration()