HostedCheckoutSpecificInput (connect-sdk-java 7.2.0 API)

java.lang.Object
- com.worldline.connect.sdk.java.v1.domain.HostedCheckoutSpecificInput

public class HostedCheckoutSpecificInput
extends Object

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
`Boolean`	`getIsRecurring()` true - Only payment products that support recurring payments will be shown.
`String`	`getLocale()` Locale to use to present the MyCheckout payment pages to the customer.
`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.
`RecurringPaymentsData`	`getRecurringPaymentsData()` The object containing reference data for the text that can be displayed on MyCheckout hosted payment page with subscription information. Note: The data in this object is only meant for displaying recurring payments-related data on your checkout page. You still need to submit all the recurring payment-related data in the corresponding payment product-specific input.
`Boolean`	`getReturnCancelState()` This flag affects the status of a Hosted Checkout when a customer presses the cancel button and is returned to you as a result. If set to true, then the status will be CANCELLED_BY_CONSUMER.
`String`	`getReturnUrl()` The URL that the customer is redirect to after the payment flow has finished.
`Boolean`	`getShowResultPage()` true - MyCheckout 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 checkout.
`Boolean`	`getValidateShoppingCart()` By default, validation is done for all the information required to display the shopping cart.
`String`	`getVariant()` Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages.
`void`	`setIsRecurring(Boolean value)` true - Only payment products that support recurring payments will be shown.
`void`	`setLocale(String value)` Locale to use to present the MyCheckout payment pages to the customer.
`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`	`setRecurringPaymentsData(RecurringPaymentsData value)` The object containing reference data for the text that can be displayed on MyCheckout hosted payment page with subscription information. Note: The data in this object is only meant for displaying recurring payments-related data on your checkout page. You still need to submit all the recurring payment-related data in the corresponding payment product-specific input.
`void`	`setReturnCancelState(Boolean value)` This flag affects the status of a Hosted Checkout when a customer presses the cancel button and is returned to you as a result. If set to true, then the status will be CANCELLED_BY_CONSUMER.
`void`	`setReturnUrl(String value)` The URL that the customer is redirect to after the payment flow has finished.
`void`	`setShowResultPage(Boolean value)` true - MyCheckout 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 checkout.
`void`	`setValidateShoppingCart(Boolean value)` By default, validation is done for all the information required to display the shopping cart.
`void`	`setVariant(String value)` Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages.

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
  - 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.
  - getLocale
```
public String getLocale()
```
    Locale to use to present the MyCheckout payment pages to the customer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.
  - setLocale
```
public void setLocale(String value)
```
    Locale to use to present the MyCheckout payment pages to the customer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.
  - 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.
  - getRecurringPaymentsData
```
public RecurringPaymentsData getRecurringPaymentsData()
```
    The object containing reference data for the text that can be displayed on MyCheckout hosted payment page with subscription information.
    
    Note:
    
    The data in this object is only meant for displaying recurring payments-related data on your checkout page.
    You still need to submit all the recurring payment-related data in the corresponding payment product-specific input. (example: cardPaymentMethodSpecificInput.recurring and cardPaymentMethodSpecificInput.isRecurring)
  - setRecurringPaymentsData
```
public void setRecurringPaymentsData(RecurringPaymentsData value)
```
    The object containing reference data for the text that can be displayed on MyCheckout hosted payment page with subscription information.
    
    Note:
    
    The data in this object is only meant for displaying recurring payments-related data on your checkout page.
    You still need to submit all the recurring payment-related data in the corresponding payment product-specific input. (example: cardPaymentMethodSpecificInput.recurring and cardPaymentMethodSpecificInput.isRecurring)
  - getReturnCancelState
```
public Boolean getReturnCancelState()
```
    This flag affects the status of a Hosted Checkout when a customer presses the cancel button and is returned to you as a result.
    If set to true, then the status will be CANCELLED_BY_CONSUMER. If set to false, then the status will be IN_PROGRESS.
    The default value is false. This flag was added to introduce the additional CANCELLED_BY_CONSUMER state as a non-breaking change.
  - setReturnCancelState
```
public void setReturnCancelState(Boolean value)
```
    This flag affects the status of a Hosted Checkout when a customer presses the cancel button and is returned to you as a result.
    If set to true, then the status will be CANCELLED_BY_CONSUMER. If set to false, then the status will be IN_PROGRESS.
    The default value is false. This flag was added to introduce the additional CANCELLED_BY_CONSUMER state as a non-breaking change.
  - 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.
  - getShowResultPage
```
public Boolean getShowResultPage()
```
    - true - MyCheckout will show a result page to the customer when applicable. Default.
    - false - MyCheckout will redirect the customer back to the provided returnUrl when this is possible.
    The default value for this property is true.
  - setShowResultPage
```
public void setShowResultPage(Boolean value)
```
    - true - MyCheckout will show a result page to the customer when applicable. Default.
    - false - MyCheckout will redirect the customer back to the provided returnUrl when this is possible.
    The default value for this property is true.
  - getTokens
```
public String getTokens()
```
    String containing comma separated tokens (no spaces) associated with the customer of this hosted checkout. 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 checkout.
  - setTokens
```
public void setTokens(String value)
```
    String containing comma separated tokens (no spaces) associated with the customer of this hosted checkout. 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 checkout.
  - getValidateShoppingCart
```
public Boolean getValidateShoppingCart()
```
    By default, validation is done for all the information required to display the shopping cart. Set this value to false if you would like to turn that feature off for a hosted checkout on the Ogone Payment Platform, in which case the rendering of the shopping cart will be skipped if any required information is missing. Use this when you want fraud-checks to be performed on the shopping cart, but do not want to suply all data needed for displaying it in the hosted checkout. The default value for this property is true.
  - setValidateShoppingCart
```
public void setValidateShoppingCart(Boolean value)
```
    By default, validation is done for all the information required to display the shopping cart. Set this value to false if you would like to turn that feature off for a hosted checkout on the Ogone Payment Platform, in which case the rendering of the shopping cart will be skipped if any required information is missing. Use this when you want fraud-checks to be performed on the shopping cart, but do not want to suply all data needed for displaying it in the hosted checkout. The default value for this property is true.
  - getVariant
```
public String getVariant()
```
    Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID of the variant.
  - setVariant
```
public void setVariant(String value)
```
    Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID of the variant.

Class HostedCheckoutSpecificInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HostedCheckoutSpecificInput

Method Detail

getIsRecurring

setIsRecurring

getLocale

setLocale

getPaymentProductFilters

setPaymentProductFilters

getRecurringPaymentsData

setRecurringPaymentsData

getReturnCancelState

setReturnCancelState

getReturnUrl

setReturnUrl

getShowResultPage

setShowResultPage

getTokens

setTokens

getValidateShoppingCart

setValidateShoppingCart

getVariant

setVariant