ch.postfinance.sdk.model

Class PaymentLinkUpdate

java.lang.Object

ch.postfinance.sdk.model.PaymentLinkUpdate

Direct Known Subclasses:

PaymentLinkActive

public class PaymentLinkUpdate
extends Object

The payment link defines an URL to automatically create transactions.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<PaymentMethodConfiguration>	allowedPaymentMethodConfigurations
protected Long	appliedSpaceView
protected OffsetDateTime	availableFrom
protected OffsetDateTime	availableUntil
protected PaymentLinkAddressHandlingMode	billingAddressHandlingMode
protected String	currency
protected Long	id
protected String	language
protected List<LineItemCreate>	lineItems
protected Integer	maximalNumberOfTransactions
protected String	name
protected PaymentLinkAddressHandlingMode	shippingAddressHandlingMode
protected Long	version

Constructor Summary

Constructors

Constructor and Description
PaymentLinkUpdate()

Method Summary

Modifier and Type	Method and Description
PaymentLinkUpdate	addAllowedPaymentMethodConfigurationsItem(PaymentMethodConfiguration allowedPaymentMethodConfigurationsItem)
PaymentLinkUpdate	addLineItemsItem(LineItemCreate lineItemsItem)
PaymentLinkUpdate	allowedPaymentMethodConfigurations(List<PaymentMethodConfiguration> allowedPaymentMethodConfigurations)
PaymentLinkUpdate	appliedSpaceView(Long appliedSpaceView)
PaymentLinkUpdate	availableFrom(OffsetDateTime availableFrom)
PaymentLinkUpdate	availableUntil(OffsetDateTime availableUntil)
PaymentLinkUpdate	billingAddressHandlingMode(PaymentLinkAddressHandlingMode billingAddressHandlingMode)
PaymentLinkUpdate	currency(String currency)
boolean	equals(Object o)
List<PaymentMethodConfiguration>	getAllowedPaymentMethodConfigurations() The allowed payment method configurations restrict the payment methods which can be used with this payment link.
Long	getAppliedSpaceView() The payment link can be conducted in a specific space view.
OffsetDateTime	getAvailableFrom() The available from date defines the earliest date on which the payment link can be used.
OffsetDateTime	getAvailableUntil() The available from date defines the latest date on which the payment link can be used to initialize a transaction.
PaymentLinkAddressHandlingMode	getBillingAddressHandlingMode() The billing address handling mode controls if the address is collected or not and how it is collected.
String	getCurrency() The currency defines in which currency the payment is executed in.
Long	getId() The ID is the primary key of the entity.
String	getLanguage() The language defines the language of the payment page.
List<LineItemCreate>	getLineItems() The line items allows to define the line items for this payment link.
Integer	getMaximalNumberOfTransactions() The maximal number of transactions limits the number of transactions which can be created with this payment link.
String	getName() The payment link name is used internally to identify the payment link.
PaymentLinkAddressHandlingMode	getShippingAddressHandlingMode() The shipping address handling mode controls if the address is collected or not and how it is collected.
Long	getVersion() The version number indicates the version of the entity.
int	hashCode()
PaymentLinkUpdate	id(Long id)
PaymentLinkUpdate	language(String language)
PaymentLinkUpdate	lineItems(List<LineItemCreate> lineItems)
PaymentLinkUpdate	maximalNumberOfTransactions(Integer maximalNumberOfTransactions)
PaymentLinkUpdate	name(String name)
void	setAllowedPaymentMethodConfigurations(List<PaymentMethodConfiguration> allowedPaymentMethodConfigurations)
void	setAppliedSpaceView(Long appliedSpaceView)
void	setAvailableFrom(OffsetDateTime availableFrom)
void	setAvailableUntil(OffsetDateTime availableUntil)
void	setBillingAddressHandlingMode(PaymentLinkAddressHandlingMode billingAddressHandlingMode)
void	setCurrency(String currency)
void	setId(Long id)
void	setLanguage(String language)
void	setLineItems(List<LineItemCreate> lineItems)
void	setMaximalNumberOfTransactions(Integer maximalNumberOfTransactions)
void	setName(String name)
void	setShippingAddressHandlingMode(PaymentLinkAddressHandlingMode shippingAddressHandlingMode)
void	setVersion(Long version)
PaymentLinkUpdate	shippingAddressHandlingMode(PaymentLinkAddressHandlingMode shippingAddressHandlingMode)
String	toString()
PaymentLinkUpdate	version(Long version)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected Long id

version

protected Long version

allowedPaymentMethodConfigurations

protected List<PaymentMethodConfiguration> allowedPaymentMethodConfigurations

appliedSpaceView

protected Long appliedSpaceView

availableFrom

protected OffsetDateTime availableFrom

availableUntil

protected OffsetDateTime availableUntil

billingAddressHandlingMode

protected PaymentLinkAddressHandlingMode billingAddressHandlingMode

currency

protected String currency

language

protected String language

lineItems

protected List<LineItemCreate> lineItems

maximalNumberOfTransactions

protected Integer maximalNumberOfTransactions

name

protected String name

shippingAddressHandlingMode

protected PaymentLinkAddressHandlingMode shippingAddressHandlingMode

Constructor Detail

PaymentLinkUpdate

public PaymentLinkUpdate()

Method Detail

id

public PaymentLinkUpdate id(Long id)

getId

public Long getId()

The ID is the primary key of the entity. The ID identifies the entity uniquely.

Returns:

id

setId

public void setId(Long id)

version

public PaymentLinkUpdate version(Long version)

getVersion

public Long getVersion()

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.

Returns:

version

setVersion

public void setVersion(Long version)

allowedPaymentMethodConfigurations

public PaymentLinkUpdate allowedPaymentMethodConfigurations(List<PaymentMethodConfiguration> allowedPaymentMethodConfigurations)

addAllowedPaymentMethodConfigurationsItem

public PaymentLinkUpdate addAllowedPaymentMethodConfigurationsItem(PaymentMethodConfiguration allowedPaymentMethodConfigurationsItem)

getAllowedPaymentMethodConfigurations

public List<PaymentMethodConfiguration> getAllowedPaymentMethodConfigurations()

The allowed payment method configurations restrict the payment methods which can be used with this payment link.

Returns:

allowedPaymentMethodConfigurations

setAllowedPaymentMethodConfigurations

public void setAllowedPaymentMethodConfigurations(List<PaymentMethodConfiguration> allowedPaymentMethodConfigurations)

appliedSpaceView

public PaymentLinkUpdate appliedSpaceView(Long appliedSpaceView)

getAppliedSpaceView

public Long getAppliedSpaceView()

The payment link can be conducted in a specific space view. The space view may apply a specific design to the payment page.

Returns:

appliedSpaceView

setAppliedSpaceView

public void setAppliedSpaceView(Long appliedSpaceView)

availableFrom

public PaymentLinkUpdate availableFrom(OffsetDateTime availableFrom)

getAvailableFrom

public OffsetDateTime getAvailableFrom()

The available from date defines the earliest date on which the payment link can be used. When no date is specified there will be no restriction.

Returns:

availableFrom

setAvailableFrom

public void setAvailableFrom(OffsetDateTime availableFrom)

availableUntil

public PaymentLinkUpdate availableUntil(OffsetDateTime availableUntil)

getAvailableUntil

public OffsetDateTime getAvailableUntil()

The available from date defines the latest date on which the payment link can be used to initialize a transaction. When no date is specified there will be no restriction.

Returns:

availableUntil

setAvailableUntil

public void setAvailableUntil(OffsetDateTime availableUntil)

billingAddressHandlingMode

public PaymentLinkUpdate billingAddressHandlingMode(PaymentLinkAddressHandlingMode billingAddressHandlingMode)

getBillingAddressHandlingMode

public PaymentLinkAddressHandlingMode getBillingAddressHandlingMode()

The billing address handling mode controls if the address is collected or not and how it is collected.

Returns:

billingAddressHandlingMode

setBillingAddressHandlingMode

public void setBillingAddressHandlingMode(PaymentLinkAddressHandlingMode billingAddressHandlingMode)

currency

public PaymentLinkUpdate currency(String currency)

getCurrency

public String getCurrency()

The currency defines in which currency the payment is executed in. If no currency is defined it has to be specified within the request parameter 'currency'.

Returns:

currency

setCurrency

public void setCurrency(String currency)

language

public PaymentLinkUpdate language(String language)

getLanguage

public String getLanguage()

The language defines the language of the payment page. If no language is provided it can be provided through the request parameter.

Returns:

language

setLanguage

public void setLanguage(String language)

lineItems

public PaymentLinkUpdate lineItems(List<LineItemCreate> lineItems)

addLineItemsItem

public PaymentLinkUpdate addLineItemsItem(LineItemCreate lineItemsItem)

getLineItems

public List<LineItemCreate> getLineItems()

The line items allows to define the line items for this payment link. When the line items are defined they cannot be overridden through the request parameters.

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItemCreate> lineItems)

maximalNumberOfTransactions

public PaymentLinkUpdate maximalNumberOfTransactions(Integer maximalNumberOfTransactions)

getMaximalNumberOfTransactions

public Integer getMaximalNumberOfTransactions()

The maximal number of transactions limits the number of transactions which can be created with this payment link.

Returns:

maximalNumberOfTransactions

setMaximalNumberOfTransactions

public void setMaximalNumberOfTransactions(Integer maximalNumberOfTransactions)

name

public PaymentLinkUpdate name(String name)

getName

public String getName()

The payment link name is used internally to identify the payment link. For example the name is used within search fields and hence it should be distinct and descriptive.

Returns:

name

setName

public void setName(String name)

shippingAddressHandlingMode

public PaymentLinkUpdate shippingAddressHandlingMode(PaymentLinkAddressHandlingMode shippingAddressHandlingMode)

getShippingAddressHandlingMode

public PaymentLinkAddressHandlingMode getShippingAddressHandlingMode()

The shipping address handling mode controls if the address is collected or not and how it is collected.

Returns:

shippingAddressHandlingMode

setShippingAddressHandlingMode

public void setShippingAddressHandlingMode(PaymentLinkAddressHandlingMode shippingAddressHandlingMode)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object