Class PaymentProduct

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

public class PaymentProduct extends Object
  • Constructor Details

    • PaymentProduct

      public PaymentProduct()
  • Method Details

    • 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
    • getAllowsAuthentication

      public Boolean getAllowsAuthentication()
      True when 3DS authentication is supported or required for the product
    • setAllowsAuthentication

      public void setAllowsAuthentication(Boolean value)
      True when 3DS authentication is supported or required for the product
    • withAllowsAuthentication

      public PaymentProduct withAllowsAuthentication(Boolean value)
      True when 3DS authentication is supported or required for the 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()
    • setDisplayHintsList

      public void setDisplayHintsList(List<PaymentProductDisplayHints> value)
    • withDisplayHintsList

      public PaymentProduct withDisplayHintsList(List<PaymentProductDisplayHints> value)
    • 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