Package com.onlinepayments.merchant.products

Class GetPaymentProductParams

java.lang.Object
com.onlinepayments.merchant.products.GetPaymentProductParams
All Implemented Interfaces:
ParamRequest
public class GetPaymentProductParams extends Object implements ParamRequest
Query parameters for Get payment product (/v2/{merchantId}/products/{paymentProductId})

  • Constructor Details

    • GetPaymentProductParams

      public GetPaymentProductParams()

  • Method Details

    • getCountryCode

      public String getCountryCode()
      ISO 3166-1 alpha-2 country code of the transaction

    • setCountryCode

      public void setCountryCode(String value)
      ISO 3166-1 alpha-2 country code of the transaction

    • withCountryCode

      public GetPaymentProductParams withCountryCode(String value)
      ISO 3166-1 alpha-2 country code of the transaction

    • getCurrencyCode

      public String getCurrencyCode()
      Three-letter ISO currency code representing the currency for the amount

    • setCurrencyCode

      public void setCurrencyCode(String value)
      Three-letter ISO currency code representing the currency for the amount

    • withCurrencyCode

      public GetPaymentProductParams withCurrencyCode(String value)
      Three-letter ISO currency code representing the currency for the amount

    • 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 GetPaymentProductParams withLocale(String value)
      Locale used in the GUI towards the consumer.

    • getAmount

      public Long getAmount()
      Whole amount in cents (not containing any decimals)

    • setAmount

      public void setAmount(Long value)
      Whole amount in cents (not containing any decimals)

    • withAmount

      public GetPaymentProductParams withAmount(Long value)
      Whole amount in cents (not containing any decimals)

    • getIsRecurring

      public Boolean getIsRecurring()
      This allows you to filter payment products based on their support for recurring payments.
      • true - return only payment products that support recurring payments,
      • false - return all payment products that support one-time transactions. Payment products that support recurring products are usually also part of this list.

    • setIsRecurring

      public void setIsRecurring(Boolean value)
      This allows you to filter payment products based on their support for recurring payments.
      • true - return only payment products that support recurring payments,
      • false - return all payment products that support one-time transactions. Payment products that support recurring products are usually also part of this list.

    • withIsRecurring

      public GetPaymentProductParams withIsRecurring(Boolean value)
      This allows you to filter payment products based on their support for recurring payments.
      • true - return only payment products that support recurring payments,
      • false - return all payment products that support one-time transactions. Payment products that support recurring products are usually also part of this list.

    • getHide

      public List<String> getHide()
      Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:
      • fields - Do not return any data on fields of the payment product
      • accountsOnFile - Do not return any accounts on file data
      • translations - Do not return any label texts associated with the payment products
      • productsWithoutFields - Do not return products that require any additional data to be captured
      • productsWithoutInstructions - Do not return products that show instructions
      • productsWithRedirects - Do not return products that require a redirect to a 3rd party. Note that products that involve potential redirects related to 3D Secure authentication are not hidden

    • setHide

      public void setHide(List<String> value)
      Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:
      • fields - Do not return any data on fields of the payment product
      • accountsOnFile - Do not return any accounts on file data
      • translations - Do not return any label texts associated with the payment products
      • productsWithoutFields - Do not return products that require any additional data to be captured
      • productsWithoutInstructions - Do not return products that show instructions
      • productsWithRedirects - Do not return products that require a redirect to a 3rd party. Note that products that involve potential redirects related to 3D Secure authentication are not hidden

    • withHide

      public GetPaymentProductParams withHide(List<String> value)
      Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:
      • fields - Do not return any data on fields of the payment product
      • accountsOnFile - Do not return any accounts on file data
      • translations - Do not return any label texts associated with the payment products
      • productsWithoutFields - Do not return products that require any additional data to be captured
      • productsWithoutInstructions - Do not return products that show instructions
      • productsWithRedirects - Do not return products that require a redirect to a 3rd party. Note that products that involve potential redirects related to 3D Secure authentication are not hidden

    • addHide

      public void addHide(String value)
      Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:
      • fields - Do not return any data on fields of the payment product
      • accountsOnFile - Do not return any accounts on file data
      • translations - Do not return any label texts associated with the payment products
      • productsWithoutFields - Do not return products that require any additional data to be captured
      • productsWithoutInstructions - Do not return products that show instructions
      • productsWithRedirects - Do not return products that require a redirect to a 3rd party. Note that products that involve potential redirects related to 3D Secure authentication are not hidden

    • toRequestParameters

      public List<RequestParam> toRequestParameters()
      Specified by:
      toRequestParameters in interface ParamRequest