com.onlinepayments.merchant.productgroups

Class GetProductGroupsParams

java.lang.Object

com.onlinepayments.merchant.productgroups.GetProductGroupsParams

All Implemented Interfaces:

ParamRequest

public class GetProductGroupsParams
extends Object
implements ParamRequest

Query parameters for 'Get product groups'.

Constructor Summary

Constructors

Constructor and Description
GetProductGroupsParams()

Method Summary

Modifier and Type	Method and Description
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.
Long	getAmount() Whole amount in cents (not containing any decimals)
String	getCountryCode() ISO 3166-1 alpha-2 country code of the transaction
String	getCurrencyCode() Three-letter ISO currency code representing the currency for the amount
List<String>	getHide() Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client.
Boolean	getIsRecurring() This allows you to filter payment products based on their support for recurring payments.
String	getLocale() Deprecated: This field has no effect.
void	setAmount(Long value) Whole amount in cents (not containing any decimals)
void	setCountryCode(String value) ISO 3166-1 alpha-2 country code of the transaction
void	setCurrencyCode(String value) Three-letter ISO currency code representing the currency for the amount
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.
void	setIsRecurring(Boolean value) This allows you to filter payment products based on their support for recurring payments.
void	setLocale(String value) Deprecated: This field has no effect.
List<RequestParam>	toRequestParameters()
GetProductGroupsParams	withAmount(Long value) Whole amount in cents (not containing any decimals)
GetProductGroupsParams	withCountryCode(String value) ISO 3166-1 alpha-2 country code of the transaction
GetProductGroupsParams	withCurrencyCode(String value) Three-letter ISO currency code representing the currency for the amount
GetProductGroupsParams	withIsRecurring(Boolean value) This allows you to filter payment products based on their support for recurring payments.
GetProductGroupsParams	withLocale(String value) Deprecated: This field has no effect.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetProductGroupsParams

public GetProductGroupsParams()

Method Detail

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 GetProductGroupsParams 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 GetProductGroupsParams withCurrencyCode(String value)

Three-letter ISO currency code representing the currency for the amount

getLocale

public String getLocale()

Deprecated: This field has no effect.

setLocale

public void setLocale(String value)

Deprecated: This field has no effect.

withLocale

public GetProductGroupsParams withLocale(String value)

Deprecated: This field has no effect.

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 GetProductGroupsParams 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 GetProductGroupsParams 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

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