HostedCheckoutSpecificInput (onlinepayments-sdk-java 4.12.0 API)

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

public class HostedCheckoutSpecificInput
extends Object

Object containing hosted checkout specific data

Constructor Summary

Constructors
Constructor and Description

HostedCheckoutSpecificInput()

Constructors
Constructor and Description
`HostedCheckoutSpecificInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getAllowedNumberOfPaymentAttempts()` The maximum number of times a customer can try to pay before the payment is definitely declined.
`CardPaymentMethodSpecificInputForHostedCheckout`	`getCardPaymentMethodSpecificInput()` Object containing card payment specific data for hosted checkout
`Boolean`	`getIsRecurring()` * true - Only payment products that support recurring payments will be shown.
`String`	`getLocale()` Locale used in the GUI towards the consumer.
`PaymentProductFiltersHostedCheckout`	`getPaymentProductFilters()` Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
`String`	`getReturnUrl()` The URL that the customer is redirect to after the payment flow has finished.
`Integer`	`getSessionTimeout()` The number of minutes after which the session will expire.
`Boolean`	`getShowResultPage()` * true - Default - Hosted Checkout will show a result page to the customer when applicable.
`String`	`getTokens()` String containing comma separated tokens (no spaces) associated with the customer of this hosted session.
`String`	`getVariant()` Using the Back-Office it is possible to upload multiple templates of your HostedCheckout payment pages, including customized templates from Merchant Portal.
`void`	`setAllowedNumberOfPaymentAttempts(Integer value)` The maximum number of times a customer can try to pay before the payment is definitely declined.
`void`	`setCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInputForHostedCheckout value)` Object containing card payment specific data for hosted checkout
`void`	`setIsRecurring(Boolean value)` * true - Only payment products that support recurring payments will be shown.
`void`	`setLocale(String value)` Locale used in the GUI towards the consumer.
`void`	`setPaymentProductFilters(PaymentProductFiltersHostedCheckout value)` Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
`void`	`setReturnUrl(String value)` The URL that the customer is redirect to after the payment flow has finished.
`void`	`setSessionTimeout(Integer value)` The number of minutes after which the session will expire.
`void`	`setShowResultPage(Boolean value)` * true - Default - Hosted Checkout will show a result page to the customer when applicable.
`void`	`setTokens(String value)` String containing comma separated tokens (no spaces) associated with the customer of this hosted session.
`void`	`setVariant(String value)` Using the Back-Office it is possible to upload multiple templates of your HostedCheckout payment pages, including customized templates from Merchant Portal.
`HostedCheckoutSpecificInput`	`withAllowedNumberOfPaymentAttempts(Integer value)` The maximum number of times a customer can try to pay before the payment is definitely declined.
`HostedCheckoutSpecificInput`	`withCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInputForHostedCheckout value)` Object containing card payment specific data for hosted checkout
`HostedCheckoutSpecificInput`	`withIsRecurring(Boolean value)` * true - Only payment products that support recurring payments will be shown.
`HostedCheckoutSpecificInput`	`withLocale(String value)` Locale used in the GUI towards the consumer.
`HostedCheckoutSpecificInput`	`withPaymentProductFilters(PaymentProductFiltersHostedCheckout value)` Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
`HostedCheckoutSpecificInput`	`withReturnUrl(String value)` The URL that the customer is redirect to after the payment flow has finished.
`HostedCheckoutSpecificInput`	`withSessionTimeout(Integer value)` The number of minutes after which the session will expire.
`HostedCheckoutSpecificInput`	`withShowResultPage(Boolean value)` * true - Default - Hosted Checkout will show a result page to the customer when applicable.
`HostedCheckoutSpecificInput`	`withTokens(String value)` String containing comma separated tokens (no spaces) associated with the customer of this hosted session.
`HostedCheckoutSpecificInput`	`withVariant(String value)` Using the Back-Office it is possible to upload multiple templates of your HostedCheckout payment pages, including customized templates from Merchant Portal.

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

- Constructor Detail
  - HostedCheckoutSpecificInput
```
public HostedCheckoutSpecificInput()
```
- Method Detail
  - getAllowedNumberOfPaymentAttempts
```
public Integer getAllowedNumberOfPaymentAttempts()
```
    The maximum number of times a customer can try to pay before the payment is definitely declined. The value must be between 1 and 10. By default, the value is set to 10 attempts.
  - setAllowedNumberOfPaymentAttempts
```
public void setAllowedNumberOfPaymentAttempts(Integer value)
```
    The maximum number of times a customer can try to pay before the payment is definitely declined. The value must be between 1 and 10. By default, the value is set to 10 attempts.
  - withAllowedNumberOfPaymentAttempts
```
public HostedCheckoutSpecificInput withAllowedNumberOfPaymentAttempts(Integer value)
```
    The maximum number of times a customer can try to pay before the payment is definitely declined. The value must be between 1 and 10. By default, the value is set to 10 attempts.
  - getCardPaymentMethodSpecificInput
```
public CardPaymentMethodSpecificInputForHostedCheckout getCardPaymentMethodSpecificInput()
```
    Object containing card payment specific data for hosted checkout
  - setCardPaymentMethodSpecificInput
```
public void setCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInputForHostedCheckout value)
```
    Object containing card payment specific data for hosted checkout
  - withCardPaymentMethodSpecificInput
```
public HostedCheckoutSpecificInput withCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInputForHostedCheckout value)
```
    Object containing card payment specific data for hosted checkout
  - getIsRecurring
```
public Boolean getIsRecurring()
```
    * true - Only payment products that support recurring payments will be shown. Any transactions created will also be tagged as being a first of a recurring sequence. * false - Only payment products that support one-off payments will be shown. The default value for this property is false.
  - setIsRecurring
```
public void setIsRecurring(Boolean value)
```
    * true - Only payment products that support recurring payments will be shown. Any transactions created will also be tagged as being a first of a recurring sequence. * false - Only payment products that support one-off payments will be shown. The default value for this property is false.
  - withIsRecurring
```
public HostedCheckoutSpecificInput withIsRecurring(Boolean value)
```
    * true - Only payment products that support recurring payments will be shown. Any transactions created will also be tagged as being a first of a recurring sequence. * false - Only payment products that support one-off payments will be shown. The default value for this property is false.
  - getLocale
```
public String getLocale()
```
    Locale used in the GUI towards the consumer.
  - setLocale
```
public void setLocale(String value)
```
    Locale used in the GUI towards the consumer.
  - withLocale
```
public HostedCheckoutSpecificInput withLocale(String value)
```
    Locale used in the GUI towards the consumer.
  - getPaymentProductFilters
```
public PaymentProductFiltersHostedCheckout getPaymentProductFilters()
```
    Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
  - setPaymentProductFilters
```
public void setPaymentProductFilters(PaymentProductFiltersHostedCheckout value)
```
    Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
  - withPaymentProductFilters
```
public HostedCheckoutSpecificInput withPaymentProductFilters(PaymentProductFiltersHostedCheckout value)
```
    Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
  - getReturnUrl
```
public String getReturnUrl()
```
    The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected.
  - setReturnUrl
```
public void setReturnUrl(String value)
```
    The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected.
  - withReturnUrl
```
public HostedCheckoutSpecificInput withReturnUrl(String value)
```
    The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected.
  - getSessionTimeout
```
public Integer getSessionTimeout()
```
    The number of minutes after which the session will expire. By default, the value is set to 180 minutes.
  - setSessionTimeout
```
public void setSessionTimeout(Integer value)
```
    The number of minutes after which the session will expire. By default, the value is set to 180 minutes.
  - withSessionTimeout
```
public HostedCheckoutSpecificInput withSessionTimeout(Integer value)
```
    The number of minutes after which the session will expire. By default, the value is set to 180 minutes.
  - getShowResultPage
```
public Boolean getShowResultPage()
```
    * true - Default - Hosted Checkout will show a result page to the customer when applicable. * false - Hosted Checkout will redirect the customer back to the provided returnUrl when this is possible.
  - setShowResultPage
```
public void setShowResultPage(Boolean value)
```
    * true - Default - Hosted Checkout will show a result page to the customer when applicable. * false - Hosted Checkout will redirect the customer back to the provided returnUrl when this is possible.
  - withShowResultPage
```
public HostedCheckoutSpecificInput withShowResultPage(Boolean value)
```
    * true - Default - Hosted Checkout will show a result page to the customer when applicable. * false - Hosted Checkout will redirect the customer back to the provided returnUrl when this is possible.
  - getTokens
```
public String getTokens()
```
    String containing comma separated tokens (no spaces) associated with the customer of this hosted session. Valid tokens will be used to present the customer the option to re-use previously used payment details. This means the customer for instance does not have to re-enter their card details again, which a big plus when the customer is using their mobile phone to complete the operation.
  - setTokens
```
public void setTokens(String value)
```
    String containing comma separated tokens (no spaces) associated with the customer of this hosted session. Valid tokens will be used to present the customer the option to re-use previously used payment details. This means the customer for instance does not have to re-enter their card details again, which a big plus when the customer is using their mobile phone to complete the operation.
  - withTokens
```
public HostedCheckoutSpecificInput withTokens(String value)
```
    String containing comma separated tokens (no spaces) associated with the customer of this hosted session. Valid tokens will be used to present the customer the option to re-use previously used payment details. This means the customer for instance does not have to re-enter their card details again, which a big plus when the customer is using their mobile phone to complete the operation.
  - getVariant
```
public String getVariant()
```
    Using the Back-Office it is possible to upload multiple templates of your HostedCheckout payment pages, including customized templates from Merchant Portal. You can force the use of another template by specifying it in the variant field. This allows you to test out the effect of certain changes to your hostedcheckout pages in a controlled manner. Please note that you need to specify the filename of the template or customization.
  - setVariant
```
public void setVariant(String value)
```
    Using the Back-Office it is possible to upload multiple templates of your HostedCheckout payment pages, including customized templates from Merchant Portal. You can force the use of another template by specifying it in the variant field. This allows you to test out the effect of certain changes to your hostedcheckout pages in a controlled manner. Please note that you need to specify the filename of the template or customization.
  - withVariant
```
public HostedCheckoutSpecificInput withVariant(String value)
```
    Using the Back-Office it is possible to upload multiple templates of your HostedCheckout payment pages, including customized templates from Merchant Portal. You can force the use of another template by specifying it in the variant field. This allows you to test out the effect of certain changes to your hostedcheckout pages in a controlled manner. Please note that you need to specify the filename of the template or customization.

Class HostedCheckoutSpecificInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HostedCheckoutSpecificInput

Method Detail

getAllowedNumberOfPaymentAttempts

setAllowedNumberOfPaymentAttempts

withAllowedNumberOfPaymentAttempts

getCardPaymentMethodSpecificInput

setCardPaymentMethodSpecificInput

withCardPaymentMethodSpecificInput

getIsRecurring

setIsRecurring

withIsRecurring

getLocale

setLocale

withLocale

getPaymentProductFilters

setPaymentProductFilters

withPaymentProductFilters

getReturnUrl

setReturnUrl

withReturnUrl

getSessionTimeout

setSessionTimeout

withSessionTimeout

getShowResultPage

setShowResultPage

withShowResultPage

getTokens

setTokens

withTokens

getVariant

setVariant

withVariant