PaymentLink (postfinancecheckout-java-sdk 4.0.2 API)

java.lang.Object
- ch.postfinance.sdk.model.PaymentLink

```
public class PaymentLink
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 String`	`externalId`
`protected Long`	`id`
`protected String`	`language`
`protected List<LineItem>`	`lineItems`
`protected Long`	`linkedSpaceId`
`protected Integer`	`maximalNumberOfTransactions`
`protected String`	`name`
`protected OffsetDateTime`	`plannedPurgeDate`
`protected PaymentLinkProtectionMode`	`protectionMode`
`protected PaymentLinkAddressHandlingMode`	`shippingAddressHandlingMode`
`protected CreationEntityState`	`state`
`protected String`	`url`
`protected Integer`	`version`

Constructor Summary

Constructors
Constructor and Description

PaymentLink()

Constructors
Constructor and Description
`PaymentLink()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`String`	`getExternalId()` A client generated nonce which identifies the entity to be created.
`Long`	`getId()` The ID is the primary key of the entity.
`String`	`getLanguage()` The language defines the language of the payment page.
`List<LineItem>`	`getLineItems()` The line items allows to define the line items for this payment link.
`Long`	`getLinkedSpaceId()` The linked space id holds the ID of the space to which the entity belongs to.
`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.
`OffsetDateTime`	`getPlannedPurgeDate()` The planned purge date indicates when the entity is permanently removed.
`PaymentLinkProtectionMode`	`getProtectionMode()` The protection mode determines if the payment link is protected against tampering and in what way.
`PaymentLinkAddressHandlingMode`	`getShippingAddressHandlingMode()` The shipping address handling mode controls if the address is collected or not and how it is collected.
`CreationEntityState`	`getState()`
`String`	`getUrl()` The URL defines the URL to which the user has to be forwarded to initialize the payment.
`Integer`	`getVersion()` The version number indicates the version of the entity.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - 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
```
  - externalId
```
protected String externalId
```
  - id
```
protected Long id
```
  - language
```
protected String language
```
  - lineItems
```
protected List<LineItem> lineItems
```
  - linkedSpaceId
```
protected Long linkedSpaceId
```
  - maximalNumberOfTransactions
```
protected Integer maximalNumberOfTransactions
```
  - name
```
protected String name
```
  - plannedPurgeDate
```
protected OffsetDateTime plannedPurgeDate
```
  - protectionMode
```
protected PaymentLinkProtectionMode protectionMode
```
  - shippingAddressHandlingMode
```
protected PaymentLinkAddressHandlingMode shippingAddressHandlingMode
```
  - state
```
protected CreationEntityState state
```
  - url
```
protected String url
```
  - version
```
protected Integer version
```
- Constructor Detail
  - PaymentLink
```
public PaymentLink()
```
- Method Detail
  - getAllowedPaymentMethodConfigurations
```
public List<PaymentMethodConfiguration> getAllowedPaymentMethodConfigurations()
```
    The allowed payment method configurations restrict the payment methods which can be used with this payment link.
    
    Returns:
    
    allowedPaymentMethodConfigurations
  - 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
  - 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
  - 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
  - getBillingAddressHandlingMode
```
public PaymentLinkAddressHandlingMode getBillingAddressHandlingMode()
```
    The billing address handling mode controls if the address is collected or not and how it is collected.
    
    Returns:
    
    billingAddressHandlingMode
  - 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
  - getExternalId
```
public String getExternalId()
```
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
    
    Returns:
    
    externalId
  - getId
```
public Long getId()
```
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
    
    Returns:
    
    id
  - 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
  - getLineItems
```
public List<LineItem> 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
  - getLinkedSpaceId
```
public Long getLinkedSpaceId()
```
    The linked space id holds the ID of the space to which the entity belongs to.
    
    Returns:
    
    linkedSpaceId
  - getMaximalNumberOfTransactions
```
public Integer getMaximalNumberOfTransactions()
```
    The maximal number of transactions limits the number of transactions which can be created with this payment link.
    
    Returns:
    
    maximalNumberOfTransactions
  - 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
  - getPlannedPurgeDate
```
public OffsetDateTime getPlannedPurgeDate()
```
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
    
    Returns:
    
    plannedPurgeDate
  - getProtectionMode
```
public PaymentLinkProtectionMode getProtectionMode()
```
    The protection mode determines if the payment link is protected against tampering and in what way.
    
    Returns:
    
    protectionMode
  - getShippingAddressHandlingMode
```
public PaymentLinkAddressHandlingMode getShippingAddressHandlingMode()
```
    The shipping address handling mode controls if the address is collected or not and how it is collected.
    
    Returns:
    
    shippingAddressHandlingMode
  - getState
```
public CreationEntityState getState()
```
    Returns:
    
    state
  - getUrl
```
public String getUrl()
```
    The URL defines the URL to which the user has to be forwarded to initialize the payment.
    
    Returns:
    
    url
  - getVersion
```
public Integer getVersion()
```
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
    
    Returns:
    
    version
  - 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

Class PaymentLink

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

allowedPaymentMethodConfigurations

appliedSpaceView

availableFrom

availableUntil

billingAddressHandlingMode

currency

externalId

id

language

lineItems

linkedSpaceId

maximalNumberOfTransactions

name

plannedPurgeDate

protectionMode

shippingAddressHandlingMode

state

url

version

Constructor Detail

PaymentLink

Method Detail

getAllowedPaymentMethodConfigurations

getAppliedSpaceView

getAvailableFrom

getAvailableUntil

getBillingAddressHandlingMode

getCurrency

getExternalId

getId

getLanguage

getLineItems

getLinkedSpaceId

getMaximalNumberOfTransactions

getName

getPlannedPurgeDate

getProtectionMode

getShippingAddressHandlingMode

getState

getUrl

getVersion

equals

hashCode

toString