PaymentProduct (connect-sdk-java 7.2.0 API)

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

Direct Known Subclasses:

PaymentProductResponse
```
public class PaymentProduct
extends Object
```

Constructor Summary

Constructors
Constructor and Description

PaymentProduct()

Constructors
Constructor and Description
`PaymentProduct()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AccountOnFile>`	`getAccountsOnFile()` List of tokens for that payment product
`String`	`getAcquirerCountry()` ISO 3166-1 alpha-2 country code which indicates the most likely country code of the acquirer that will process the transaction.
`Boolean`	`getAllowsInstallments()` Indicates if the product supports installments true - This payment supports installments false - This payment does not support installments
`Boolean`	`getAllowsRecurring()` Indicates if the product supports recurring payments true - This payment product supports recurring payments false - This payment product does not support recurring transactions and can only be used for one-off payments
`Boolean`	`getAllowsTokenization()` Indicates if the payment details can be tokenized for future re-use true - Payment details from payments done with this payment product can be tokenized for future re-use false - Payment details from payments done with this payment product can not be tokenized
`AuthenticationIndicator`	`getAuthenticationIndicator()` Indicates if the payment product supports 3D Security (mandatory, optional or not needed).
`Boolean`	`getAutoTokenized()` Indicates if the payment details can be automatically tokenized for future re-use true - Payment details from payments done with this payment product can be automatically tokenized for future re-use false - Payment details from payments done with this payment product can not be automatically tokenized
`Boolean`	`getCanBeIframed()` This property is only relevant for payment products that use third party redirects.
`Boolean`	`getDeviceFingerprintEnabled()` Indicates if device fingerprint is enabled for the product true false
`PaymentProductDisplayHints`	`getDisplayHints()` Object containing display hints like the order in which the product should be shown, the name of the product and the logo
`List<PaymentProductField>`	`getFields()` Object containing all the fields and their details that are associated with this payment product.
`String`	`getFieldsWarning()` If one or more of the payment product fields could not be constructed, no payment product fields will be returned and a message will be present in this property stating why.
`Integer`	`getId()` The ID of the payment product in our system
`Boolean`	`getIsAuthenticationSupported()` Indicates if the payment product supports 3D-Secure.
`Boolean`	`getIsJavaScriptRequired()` This property indicates if the payment product requires JavaScript to be enabled on the customer's browser.
`Long`	`getMaxAmount()` Maximum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
`Long`	`getMinAmount()` Minimum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
`String`	`getMobileIntegrationLevel()` This provides insight into the level of support for payments using a device with a smaller screen size.
`String`	`getPaymentMethod()` Indicates which payment method will be used for this payment product.
`PaymentProduct302SpecificData`	`getPaymentProduct302SpecificData()` Apple Pay (payment product 302) specific details.
`PaymentProduct320SpecificData`	`getPaymentProduct320SpecificData()` Google Pay (payment product 320) specific details.
`PaymentProduct863SpecificData`	`getPaymentProduct863SpecificData()` WeChat Pay (payment product 863) specific details.
`String`	`getPaymentProductGroup()` The payment product group that has this payment product, if there is any.
`Boolean`	`getSupportsMandates()` Indicates whether the payment product supports mandates.
`Boolean`	`getUsesRedirectionTo3rdParty()` Indicates whether the payment product requires redirection to a third party to complete the payment.
`void`	`setAccountsOnFile(List<AccountOnFile> value)` List of tokens for that payment product
`void`	`setAcquirerCountry(String value)` ISO 3166-1 alpha-2 country code which indicates the most likely country code of the acquirer that will process the transaction.
`void`	`setAllowsInstallments(Boolean value)` Indicates if the product supports installments true - This payment supports installments false - This payment does not support installments
`void`	`setAllowsRecurring(Boolean value)` Indicates if the product supports recurring payments true - This payment product supports recurring payments false - This payment product does not support recurring transactions and can only be used for one-off payments
`void`	`setAllowsTokenization(Boolean value)` Indicates if the payment details can be tokenized for future re-use true - Payment details from payments done with this payment product can be tokenized for future re-use false - Payment details from payments done with this payment product can not be tokenized
`void`	`setAuthenticationIndicator(AuthenticationIndicator value)` Indicates if the payment product supports 3D Security (mandatory, optional or not needed).
`void`	`setAutoTokenized(Boolean value)` Indicates if the payment details can be automatically tokenized for future re-use true - Payment details from payments done with this payment product can be automatically tokenized for future re-use false - Payment details from payments done with this payment product can not be automatically tokenized
`void`	`setCanBeIframed(Boolean value)` This property is only relevant for payment products that use third party redirects.
`void`	`setDeviceFingerprintEnabled(Boolean value)` Indicates if device fingerprint is enabled for the product true false
`void`	`setDisplayHints(PaymentProductDisplayHints value)` Object containing display hints like the order in which the product should be shown, the name of the product and the logo
`void`	`setFields(List<PaymentProductField> value)` Object containing all the fields and their details that are associated with this payment product.
`void`	`setFieldsWarning(String value)` If one or more of the payment product fields could not be constructed, no payment product fields will be returned and a message will be present in this property stating why.
`void`	`setId(Integer value)` The ID of the payment product in our system
`void`	`setIsAuthenticationSupported(Boolean value)` Indicates if the payment product supports 3D-Secure.
`void`	`setIsJavaScriptRequired(Boolean value)` This property indicates if the payment product requires JavaScript to be enabled on the customer's browser.
`void`	`setMaxAmount(Long value)` Maximum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
`void`	`setMinAmount(Long value)` Minimum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
`void`	`setMobileIntegrationLevel(String value)` This provides insight into the level of support for payments using a device with a smaller screen size.
`void`	`setPaymentMethod(String value)` Indicates which payment method will be used for this payment product.
`void`	`setPaymentProduct302SpecificData(PaymentProduct302SpecificData value)` Apple Pay (payment product 302) specific details.
`void`	`setPaymentProduct320SpecificData(PaymentProduct320SpecificData value)` Google Pay (payment product 320) specific details.
`void`	`setPaymentProduct863SpecificData(PaymentProduct863SpecificData value)` WeChat Pay (payment product 863) specific details.
`void`	`setPaymentProductGroup(String value)` The payment product group that has this payment product, if there is any.
`void`	`setSupportsMandates(Boolean value)` Indicates whether the payment product supports mandates.
`void`	`setUsesRedirectionTo3rdParty(Boolean value)` Indicates whether the payment product requires redirection to a third party to complete the payment.

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

- Constructor Detail
  - PaymentProduct
```
public PaymentProduct()
```
- Method Detail
  - getAccountsOnFile
```
public List<AccountOnFile> getAccountsOnFile()
```
    List of tokens for that payment product
  - setAccountsOnFile
```
public void setAccountsOnFile(List<AccountOnFile> value)
```
    List of tokens for that payment product
  - getAcquirerCountry
```
public String getAcquirerCountry()
```
    ISO 3166-1 alpha-2 country code which indicates the most likely country code of the acquirer that will process the transaction. For Google Pay (paymentProductId 320) transactions this acquirerCountry is should be provided in the transactionInfo.countryCode for merchants that use an acquirer that is based in one of the European Economic Area (EEA) countries to make sure the transaction is compliant with the PSD2 Strong Customer Authentication (SCA) requirements. More information on Strong Customer Authentication compliance for Google Pay can be found at https://developers.google.com/pay/api/web/guides/resources/sca
  - setAcquirerCountry
```
public void setAcquirerCountry(String value)
```
    ISO 3166-1 alpha-2 country code which indicates the most likely country code of the acquirer that will process the transaction. For Google Pay (paymentProductId 320) transactions this acquirerCountry is should be provided in the transactionInfo.countryCode for merchants that use an acquirer that is based in one of the European Economic Area (EEA) countries to make sure the transaction is compliant with the PSD2 Strong Customer Authentication (SCA) requirements. More information on Strong Customer Authentication compliance for Google Pay can be found at https://developers.google.com/pay/api/web/guides/resources/sca
  - getAllowsInstallments
```
public Boolean getAllowsInstallments()
```
    Indicates if the product supports installments
    - true - This payment supports installments
    - false - This payment does not support installments
  - setAllowsInstallments
```
public void setAllowsInstallments(Boolean value)
```
    Indicates if the product supports installments
    - true - This payment supports installments
    - false - This payment does not support installments
  - getAllowsRecurring
```
public Boolean getAllowsRecurring()
```
    Indicates if the product supports recurring payments
    - true - This payment product supports recurring payments
    - false - This payment product does not support recurring transactions and can only be used for one-off payments
  - setAllowsRecurring
```
public void setAllowsRecurring(Boolean value)
```
    Indicates if the product supports recurring payments
    - true - This payment product supports recurring payments
    - false - This payment product does not support recurring transactions and can only be used for one-off payments
  - getAllowsTokenization
```
public Boolean getAllowsTokenization()
```
    Indicates if the payment details can be tokenized for future re-use
    - true - Payment details from payments done with this payment product can be tokenized for future re-use
    - false - Payment details from payments done with this payment product can not be tokenized
  - setAllowsTokenization
```
public void setAllowsTokenization(Boolean value)
```
    Indicates if the payment details can be tokenized for future re-use
    - true - Payment details from payments done with this payment product can be tokenized for future re-use
    - false - Payment details from payments done with this payment product can not be tokenized
  - getAuthenticationIndicator
```
public AuthenticationIndicator getAuthenticationIndicator()
```
    Indicates if the payment product supports 3D Security (mandatory, optional or not needed).
  - setAuthenticationIndicator
```
public void setAuthenticationIndicator(AuthenticationIndicator value)
```
    Indicates if the payment product supports 3D Security (mandatory, optional or not needed).
  - getAutoTokenized
```
public Boolean getAutoTokenized()
```
    Indicates if the payment details can be automatically tokenized for future re-use
    - true - Payment details from payments done with this payment product can be automatically tokenized for future re-use
    - false - Payment details from payments done with this payment product can not be automatically tokenized
  - setAutoTokenized
```
public void setAutoTokenized(Boolean value)
```
    Indicates if the payment details can be automatically tokenized for future re-use
    - true - Payment details from payments done with this payment product can be automatically tokenized for future re-use
    - false - Payment details from payments done with this payment product can not be automatically tokenized
  - getCanBeIframed
```
public Boolean getCanBeIframed()
```
    This property is only relevant for payment products that use third party redirects. This property indicates if the third party disallows their payment pages to be embedded in an iframe using the X-Frame-Options header.
    - true - the third party allows their payment pages to be embedded in an iframe.
    - false - the third party disallows their payment pages to be embedded in an iframe.
  - setCanBeIframed
```
public void setCanBeIframed(Boolean value)
```
    This property is only relevant for payment products that use third party redirects. This property indicates if the third party disallows their payment pages to be embedded in an iframe using the X-Frame-Options header.
    - true - the third party allows their payment pages to be embedded in an iframe.
    - false - the third party disallows their payment pages to be embedded in an iframe.
  - getDeviceFingerprintEnabled
```
public Boolean getDeviceFingerprintEnabled()
```
    Indicates if device fingerprint is enabled for the product
    - true
    - false
  - setDeviceFingerprintEnabled
```
public void setDeviceFingerprintEnabled(Boolean value)
```
    Indicates if device fingerprint is enabled for the product
    - true
    - false
  - getDisplayHints
```
public PaymentProductDisplayHints getDisplayHints()
```
    Object containing display hints like the order in which the product should be shown, the name of the product and the logo
  - setDisplayHints
```
public void setDisplayHints(PaymentProductDisplayHints value)
```
    Object containing display hints like the order in which the product should be shown, the name of the product and the logo
  - getFields
```
public List<PaymentProductField> getFields()
```
    Object containing all the fields and their details that are associated with this payment product. If you are not interested in the data in the fields you should have us filter them out (using filter=fields in the query-string)
  - setFields
```
public void setFields(List<PaymentProductField> value)
```
    Object containing all the fields and their details that are associated with this payment product. If you are not interested in the data in the fields you should have us filter them out (using filter=fields in the query-string)
  - getFieldsWarning
```
public String getFieldsWarning()
```
    If one or more of the payment product fields could not be constructed, no payment product fields will be returned and a message will be present in this property stating why.
  - setFieldsWarning
```
public void setFieldsWarning(String value)
```
    If one or more of the payment product fields could not be constructed, no payment product fields will be returned and a message will be present in this property stating why.
  - getId
```
public Integer getId()
```
    The ID of the payment product in our system
  - setId
```
public void setId(Integer value)
```
    The ID of the payment product in our system
  - getIsAuthenticationSupported
```
public Boolean getIsAuthenticationSupported()
```
    Indicates if the payment product supports 3D-Secure.
  - setIsAuthenticationSupported
```
public void setIsAuthenticationSupported(Boolean value)
```
    Indicates if the payment product supports 3D-Secure.
  - getIsJavaScriptRequired
```
public Boolean getIsJavaScriptRequired()
```
    This property indicates if the payment product requires JavaScript to be enabled on the customer's browser. This is usually only true if the payment product depends on a third party JavaScript integration.
    - true - the payment product requires JavaScript to be enabled.
    - false - the payment product does not require JavaScript to be enabled. This is the default value if the property is not present.
  - setIsJavaScriptRequired
```
public void setIsJavaScriptRequired(Boolean value)
```
    This property indicates if the payment product requires JavaScript to be enabled on the customer's browser. This is usually only true if the payment product depends on a third party JavaScript integration.
    - true - the payment product requires JavaScript to be enabled.
    - false - the payment product does not require JavaScript to be enabled. This is the default value if the property is not present.
  - getMaxAmount
```
public Long getMaxAmount()
```
    Maximum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
  - setMaxAmount
```
public void setMaxAmount(Long value)
```
    Maximum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
  - getMinAmount
```
public Long getMinAmount()
```
    Minimum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
  - setMinAmount
```
public void setMinAmount(Long value)
```
    Minimum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
  - getMobileIntegrationLevel
```
public String getMobileIntegrationLevel()
```
    This provides insight into the level of support for payments using a device with a smaller screen size. You can for instance use this to rank payment products differently on devices with a smaller screen. Possible values are:
    - NO_SUPPORT - The payment product does not work at all on a mobile device
    - BASIC_SUPPORT - The payment product has not optimized its user experience for devices with smaller screens
    - OPTIMISED_SUPPORT - The payment product offers a user experience that has been optimized for devices with smaller screens
  - setMobileIntegrationLevel
```
public void setMobileIntegrationLevel(String value)
```
    This provides insight into the level of support for payments using a device with a smaller screen size. You can for instance use this to rank payment products differently on devices with a smaller screen. Possible values are:
    - NO_SUPPORT - The payment product does not work at all on a mobile device
    - BASIC_SUPPORT - The payment product has not optimized its user experience for devices with smaller screens
    - OPTIMISED_SUPPORT - The payment product offers a user experience that has been optimized for devices with smaller screens
  - getPaymentMethod
```
public String getPaymentMethod()
```
    Indicates which payment method will be used for this payment product. Payment method is one of:
    - bankTransfer
    - card
    - cash
    - directDebit
    - eInvoice
    - invoice
    - redirect
  - setPaymentMethod
```
public void setPaymentMethod(String value)
```
    Indicates which payment method will be used for this payment product. Payment method is one of:
    - bankTransfer
    - card
    - cash
    - directDebit
    - eInvoice
    - invoice
    - redirect
  - getPaymentProduct302SpecificData
```
public PaymentProduct302SpecificData getPaymentProduct302SpecificData()
```
    Apple Pay (payment product 302) specific details.
  - setPaymentProduct302SpecificData
```
public void setPaymentProduct302SpecificData(PaymentProduct302SpecificData value)
```
    Apple Pay (payment product 302) specific details.
  - getPaymentProduct320SpecificData
```
public PaymentProduct320SpecificData getPaymentProduct320SpecificData()
```
    Google Pay (payment product 320) specific details.
  - setPaymentProduct320SpecificData
```
public void setPaymentProduct320SpecificData(PaymentProduct320SpecificData value)
```
    Google Pay (payment product 320) specific details.
  - getPaymentProduct863SpecificData
```
public PaymentProduct863SpecificData getPaymentProduct863SpecificData()
```
    WeChat Pay (payment product 863) specific details.
  - setPaymentProduct863SpecificData
```
public void setPaymentProduct863SpecificData(PaymentProduct863SpecificData value)
```
    WeChat Pay (payment product 863) specific details.
  - getPaymentProductGroup
```
public String getPaymentProductGroup()
```
    The payment product group that has this payment product, if there is any. Not populated otherwise. Currently only one payment product group is supported:
    - cards
  - setPaymentProductGroup
```
public void setPaymentProductGroup(String value)
```
    The payment product group that has this payment product, if there is any. Not populated otherwise. Currently only one payment product group is supported:
    - cards
  - getSupportsMandates
```
public Boolean getSupportsMandates()
```
    Indicates whether the payment product supports mandates.
  - setSupportsMandates
```
public void setSupportsMandates(Boolean value)
```
    Indicates whether the payment product supports mandates.
  - getUsesRedirectionTo3rdParty
```
public Boolean getUsesRedirectionTo3rdParty()
```
    Indicates whether the payment product requires redirection to a third party to complete the payment. You can use this to filter out products that require a redirect if you don't want to support that.
    - true - Redirection is required
    - false - No redirection is required
  - setUsesRedirectionTo3rdParty
```
public void setUsesRedirectionTo3rdParty(Boolean value)
```
    Indicates whether the payment product requires redirection to a third party to complete the payment. You can use this to filter out products that require a redirect if you don't want to support that.
    - true - Redirection is required
    - false - No redirection is required

Class PaymentProduct

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentProduct

Method Detail

getAccountsOnFile

setAccountsOnFile

getAcquirerCountry

setAcquirerCountry

getAllowsInstallments

setAllowsInstallments

getAllowsRecurring

setAllowsRecurring

getAllowsTokenization

setAllowsTokenization

getAuthenticationIndicator

setAuthenticationIndicator

getAutoTokenized

setAutoTokenized

getCanBeIframed

setCanBeIframed

getDeviceFingerprintEnabled

setDeviceFingerprintEnabled

getDisplayHints

setDisplayHints

getFields

setFields

getFieldsWarning

setFieldsWarning

getId

setId

getIsAuthenticationSupported

setIsAuthenticationSupported

getIsJavaScriptRequired

setIsJavaScriptRequired

getMaxAmount

setMaxAmount

getMinAmount

setMinAmount

getMobileIntegrationLevel

setMobileIntegrationLevel

getPaymentMethod

setPaymentMethod

getPaymentProduct302SpecificData

setPaymentProduct302SpecificData

getPaymentProduct320SpecificData

setPaymentProduct320SpecificData

getPaymentProduct863SpecificData

setPaymentProduct863SpecificData

getPaymentProductGroup

setPaymentProductGroup

getSupportsMandates

setSupportsMandates

getUsesRedirectionTo3rdParty

setUsesRedirectionTo3rdParty