PaymentLinkResponse (onlinepayments-sdk-java 4.18.0 API)

java.lang.Object
- com.onlinepayments.domain.PaymentLinkResponse

public class PaymentLinkResponse
extends Object

An object representing a payment link.

Constructor Summary

Constructors
Constructor and Description

PaymentLinkResponse()

Constructors
Constructor and Description
`PaymentLinkResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getExpirationDate()` The date after which the payment link will not be usable to complete the payment.
`String`	`getPaymentId()` The unique payment transaction identifier.
`List<PaymentLinkEvent>`	`getPaymentLinkEvents()`
`String`	`getPaymentLinkId()` The unique link identifier.
`PaymentLinkOrderOutput`	`getPaymentLinkOrder()` An object containing the details of the related payment output.
`String`	`getRecipientName()` The payment link recipient name.
`String`	`getRedirectionUrl()` The URL that will redirect the customer to the Hosted Checkout page to process the payment.
`String`	`getStatus()` The state of the payment link: * ACTIVE: The payment link is ready to be used.
`void`	`setExpirationDate(String value)` The date after which the payment link will not be usable to complete the payment.
`void`	`setPaymentId(String value)` The unique payment transaction identifier.
`void`	`setPaymentLinkEvents(List<PaymentLinkEvent> value)`
`void`	`setPaymentLinkId(String value)` The unique link identifier.
`void`	`setPaymentLinkOrder(PaymentLinkOrderOutput value)` An object containing the details of the related payment output.
`void`	`setRecipientName(String value)` The payment link recipient name.
`void`	`setRedirectionUrl(String value)` The URL that will redirect the customer to the Hosted Checkout page to process the payment.
`void`	`setStatus(String value)` The state of the payment link: * ACTIVE: The payment link is ready to be used.
`PaymentLinkResponse`	`withExpirationDate(String value)` The date after which the payment link will not be usable to complete the payment.
`PaymentLinkResponse`	`withPaymentId(String value)` The unique payment transaction identifier.
`PaymentLinkResponse`	`withPaymentLinkEvents(List<PaymentLinkEvent> value)`
`PaymentLinkResponse`	`withPaymentLinkId(String value)` The unique link identifier.
`PaymentLinkResponse`	`withPaymentLinkOrder(PaymentLinkOrderOutput value)` An object containing the details of the related payment output.
`PaymentLinkResponse`	`withRecipientName(String value)` The payment link recipient name.
`PaymentLinkResponse`	`withRedirectionUrl(String value)` The URL that will redirect the customer to the Hosted Checkout page to process the payment.
`PaymentLinkResponse`	`withStatus(String value)` The state of the payment link: * ACTIVE: The payment link is ready to be used.

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

- Constructor Detail
  - PaymentLinkResponse
```
public PaymentLinkResponse()
```
- Method Detail
  - getExpirationDate
```
public String getExpirationDate()
```
    The date after which the payment link will not be usable to complete the payment. The date will contain the UTC offset.
  - setExpirationDate
```
public void setExpirationDate(String value)
```
    The date after which the payment link will not be usable to complete the payment. The date will contain the UTC offset.
  - withExpirationDate
```
public PaymentLinkResponse withExpirationDate(String value)
```
    The date after which the payment link will not be usable to complete the payment. The date will contain the UTC offset.
  - getPaymentId
```
public String getPaymentId()
```
    The unique payment transaction identifier. This id is only set when a payment was processed with this payment link.
  - setPaymentId
```
public void setPaymentId(String value)
```
    The unique payment transaction identifier. This id is only set when a payment was processed with this payment link.
  - withPaymentId
```
public PaymentLinkResponse withPaymentId(String value)
```
    The unique payment transaction identifier. This id is only set when a payment was processed with this payment link.
  - getPaymentLinkEvents
```
public List<PaymentLinkEvent> getPaymentLinkEvents()
```
  - setPaymentLinkEvents
```
public void setPaymentLinkEvents(List<PaymentLinkEvent> value)
```
  - withPaymentLinkEvents
```
public PaymentLinkResponse withPaymentLinkEvents(List<PaymentLinkEvent> value)
```
  - getPaymentLinkId
```
public String getPaymentLinkId()
```
    The unique link identifier.
  - setPaymentLinkId
```
public void setPaymentLinkId(String value)
```
    The unique link identifier.
  - withPaymentLinkId
```
public PaymentLinkResponse withPaymentLinkId(String value)
```
    The unique link identifier.
  - getPaymentLinkOrder
```
public PaymentLinkOrderOutput getPaymentLinkOrder()
```
    An object containing the details of the related payment output.
  - setPaymentLinkOrder
```
public void setPaymentLinkOrder(PaymentLinkOrderOutput value)
```
    An object containing the details of the related payment output.
  - withPaymentLinkOrder
```
public PaymentLinkResponse withPaymentLinkOrder(PaymentLinkOrderOutput value)
```
    An object containing the details of the related payment output.
  - getRecipientName
```
public String getRecipientName()
```
    The payment link recipient name.
  - setRecipientName
```
public void setRecipientName(String value)
```
    The payment link recipient name.
  - withRecipientName
```
public PaymentLinkResponse withRecipientName(String value)
```
    The payment link recipient name.
  - getRedirectionUrl
```
public String getRedirectionUrl()
```
    The URL that will redirect the customer to the Hosted Checkout page to process the payment.
  - setRedirectionUrl
```
public void setRedirectionUrl(String value)
```
    The URL that will redirect the customer to the Hosted Checkout page to process the payment.
  - withRedirectionUrl
```
public PaymentLinkResponse withRedirectionUrl(String value)
```
    The URL that will redirect the customer to the Hosted Checkout page to process the payment.
  - getStatus
```
public String getStatus()
```
    The state of the payment link: * ACTIVE: The payment link is ready to be used. * PAID: The payment has been completed. * CANCELLED: The payment link has been manually cancelled. * EXPIRED: The payment link is not usable anymore.
  - setStatus
```
public void setStatus(String value)
```
    The state of the payment link: * ACTIVE: The payment link is ready to be used. * PAID: The payment has been completed. * CANCELLED: The payment link has been manually cancelled. * EXPIRED: The payment link is not usable anymore.
  - withStatus
```
public PaymentLinkResponse withStatus(String value)
```
    The state of the payment link: * ACTIVE: The payment link is ready to be used. * PAID: The payment has been completed. * CANCELLED: The payment link has been manually cancelled. * EXPIRED: The payment link is not usable anymore.

Class PaymentLinkResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentLinkResponse

Method Detail

getExpirationDate

setExpirationDate

withExpirationDate

getPaymentId

setPaymentId

withPaymentId

getPaymentLinkEvents

setPaymentLinkEvents

withPaymentLinkEvents

getPaymentLinkId

setPaymentLinkId

withPaymentLinkId

getPaymentLinkOrder

setPaymentLinkOrder

withPaymentLinkOrder

getRecipientName

setRecipientName

withRecipientName

getRedirectionUrl

setRedirectionUrl

withRedirectionUrl

getStatus

setStatus

withStatus