org.lightningj.paywall.paymenthandler.data

Interface MinimalPaymentData

All Superinterfaces:

PaymentData

All Known Subinterfaces:

FullPaymentData, PerRequestPaymentData, StandardPaymentData

All Known Implementing Classes:

DemoFullPaymentData, DemoMinimalPaymentData, DemoPerRequestPaymentData, DemoPerRequestPaymentData

public interface MinimalPaymentData
extends PaymentData

Interface defining the minimal amount of information that needs to be stored for a given payment flow. Should generally only be used in test environments or proof of concepts.

When only implementing the minimal payment data it is assumed that the order amount is the same as later invoice amount and settled amount.

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

See Also:

Created by Philip Vendil on 2018-12-09.

Method Summary

Modifier and Type	Method and Description
Amount	getOrderAmount()
byte[]	getPreImageHash() Unique identifier of a payment in the system and also used in LightningHandler to identify an invoice.
boolean	isSettled()
void	setOrderAmount(Amount orderAmount)
void	setPreImageHash(byte[] preImageHash)
void	setSettled(boolean settled)

Method Detail

getPreImageHash

byte[] getPreImageHash()

Unique identifier of a payment in the system and also used in LightningHandler to identify an invoice. Should be generated by TokenGenerator when creating an order and not set manually.

Returns:

the unique identifier of a payment.

setPreImageHash

void setPreImageHash(byte[] preImageHash)

Parameters:

preImageHash - unique identifier of a payment in the system and also used in LightningHandler to identify an invoice. Should be generated by TokenGenerator when creating an order and not set manually.

getOrderAmount

Amount getOrderAmount()

Returns:

the requested amount for payment. This can be either a FiatAmount or CryptoAmount but always make sure the systems configured CurrencyConverter supports this currency when converting into a currency accepted by the LightningHandler later in the payment flow.

setOrderAmount

void setOrderAmount(Amount orderAmount)

Parameters:

orderAmount - the requested amount for payment. This can be either a FiatAmount or CryptoAmount but always make sure the systems configured CurrencyConverter supports this currency when converting into a currency accepted by the LightningHandler later in the payment flow.

isSettled

boolean isSettled()

Returns:

true if related invoice have been settled in full.

setSettled

void setSettled(boolean settled)

Parameters:

settled - true if related invoice have been settled in full.