PaymentProduct (onlinepayments-sdk-java 4.18.0 API)

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

public class PaymentProduct
extends Object

Payment product

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
`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
`PaymentProductDisplayHints`	`getDisplayHints()` Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
`List<PaymentProductDisplayHints>`	`getDisplayHintsList()` List of display hints
`List<PaymentProductField>`	`getFields()` Object containing all the fields and their details that are associated with this payment product.
`Integer`	`getId()` The ID of the payment product in our system
`String`	`getPaymentMethod()` Payment method identifier used by the our payment engine.
`PaymentProduct302SpecificData`	`getPaymentProduct302SpecificData()`
`PaymentProduct320SpecificData`	`getPaymentProduct320SpecificData()`
`String`	`getPaymentProductGroup()` The payment product group that has this payment product, if there is any.
`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`	`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`	`setDisplayHints(PaymentProductDisplayHints value)` Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
`void`	`setDisplayHintsList(List<PaymentProductDisplayHints> value)` List of display hints
`void`	`setFields(List<PaymentProductField> value)` Object containing all the fields and their details that are associated with this payment product.
`void`	`setId(Integer value)` The ID of the payment product in our system
`void`	`setPaymentMethod(String value)` Payment method identifier used by the our payment engine.
`void`	`setPaymentProduct302SpecificData(PaymentProduct302SpecificData value)`
`void`	`setPaymentProduct320SpecificData(PaymentProduct320SpecificData value)`
`void`	`setPaymentProductGroup(String value)` The payment product group that has this payment product, if there is any.
`void`	`setUsesRedirectionTo3rdParty(Boolean value)` Indicates whether the payment product requires redirection to a third party to complete the payment.
`PaymentProduct`	`withAccountsOnFile(List<AccountOnFile> value)` List of tokens for that payment product
`PaymentProduct`	`withAllowsRecurring(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
`PaymentProduct`	`withAllowsTokenization(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
`PaymentProduct`	`withDisplayHints(PaymentProductDisplayHints value)` Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
`PaymentProduct`	`withDisplayHintsList(List<PaymentProductDisplayHints> value)` List of display hints
`PaymentProduct`	`withFields(List<PaymentProductField> value)` Object containing all the fields and their details that are associated with this payment product.
`PaymentProduct`	`withId(Integer value)` The ID of the payment product in our system
`PaymentProduct`	`withPaymentMethod(String value)` Payment method identifier used by the our payment engine.
`PaymentProduct`	`withPaymentProduct302SpecificData(PaymentProduct302SpecificData value)`
`PaymentProduct`	`withPaymentProduct320SpecificData(PaymentProduct320SpecificData value)`
`PaymentProduct`	`withPaymentProductGroup(String value)` The payment product group that has this payment product, if there is any.
`PaymentProduct`	`withUsesRedirectionTo3rdParty(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
  - withAccountsOnFile
```
public PaymentProduct withAccountsOnFile(List<AccountOnFile> value)
```
    List of tokens for that payment product
  - 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
  - withAllowsRecurring
```
public PaymentProduct withAllowsRecurring(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
  - withAllowsTokenization
```
public PaymentProduct withAllowsTokenization(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
  - getDisplayHints
```
public PaymentProductDisplayHints getDisplayHints()
```
    Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
  - setDisplayHints
```
public void setDisplayHints(PaymentProductDisplayHints value)
```
    Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
  - withDisplayHints
```
public PaymentProduct withDisplayHints(PaymentProductDisplayHints value)
```
    Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
  - getDisplayHintsList
```
public List<PaymentProductDisplayHints> getDisplayHintsList()
```
    List of display hints
  - setDisplayHintsList
```
public void setDisplayHintsList(List<PaymentProductDisplayHints> value)
```
    List of display hints
  - withDisplayHintsList
```
public PaymentProduct withDisplayHintsList(List<PaymentProductDisplayHints> value)
```
    List of display hints
  - 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 on the fields you should have us filter them our (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 on the fields you should have us filter them our (using filter=fields in the query-string)
  - withFields
```
public PaymentProduct withFields(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 on the fields you should have us filter them our (using filter=fields in the query-string)
  - 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
  - withId
```
public PaymentProduct withId(Integer value)
```
    The ID of the payment product in our system
  - getPaymentMethod
```
public String getPaymentMethod()
```
    Payment method identifier used by the our payment engine.
  - setPaymentMethod
```
public void setPaymentMethod(String value)
```
    Payment method identifier used by the our payment engine.
  - withPaymentMethod
```
public PaymentProduct withPaymentMethod(String value)
```
    Payment method identifier used by the our payment engine.
  - getPaymentProduct302SpecificData
```
public PaymentProduct302SpecificData getPaymentProduct302SpecificData()
```
  - setPaymentProduct302SpecificData
```
public void setPaymentProduct302SpecificData(PaymentProduct302SpecificData value)
```
  - withPaymentProduct302SpecificData
```
public PaymentProduct withPaymentProduct302SpecificData(PaymentProduct302SpecificData value)
```
  - getPaymentProduct320SpecificData
```
public PaymentProduct320SpecificData getPaymentProduct320SpecificData()
```
  - setPaymentProduct320SpecificData
```
public void setPaymentProduct320SpecificData(PaymentProduct320SpecificData value)
```
  - withPaymentProduct320SpecificData
```
public PaymentProduct withPaymentProduct320SpecificData(PaymentProduct320SpecificData value)
```
  - 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
  - withPaymentProductGroup
```
public PaymentProduct withPaymentProductGroup(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
  - 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 do not 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 do not want to support that. * true - Redirection is required * false - No redirection is required
  - withUsesRedirectionTo3rdParty
```
public PaymentProduct withUsesRedirectionTo3rdParty(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 do not 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

withAccountsOnFile

getAllowsRecurring

setAllowsRecurring

withAllowsRecurring

getAllowsTokenization

setAllowsTokenization

withAllowsTokenization

getDisplayHints

setDisplayHints

withDisplayHints

getDisplayHintsList

setDisplayHintsList

withDisplayHintsList

getFields

setFields

withFields

getId

setId

withId

getPaymentMethod

setPaymentMethod

withPaymentMethod

getPaymentProduct302SpecificData

setPaymentProduct302SpecificData

withPaymentProduct302SpecificData

getPaymentProduct320SpecificData

setPaymentProduct320SpecificData

withPaymentProduct320SpecificData

getPaymentProductGroup

setPaymentProductGroup

withPaymentProductGroup

getUsesRedirectionTo3rdParty

setUsesRedirectionTo3rdParty

withUsesRedirectionTo3rdParty