java.lang.Object
- com.adyen.model.checkout.PaymentMethodsRequest

public class PaymentMethodsRequest
extends Object

PaymentMethodsRequest

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PaymentMethodsRequest.ChannelEnum
The platform where a payment transaction takes place.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ADDITIONAL_DATA`
`static String`	`JSON_PROPERTY_ALLOWED_PAYMENT_METHODS`
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_BLOCKED_PAYMENT_METHODS`
`static String`	`JSON_PROPERTY_CHANNEL`
`static String`	`JSON_PROPERTY_COUNTRY_CODE`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_ORDER`
`static String`	`JSON_PROPERTY_SHOPPER_LOCALE`
`static String`	`JSON_PROPERTY_SHOPPER_REFERENCE`
`static String`	`JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES`
`static String`	`JSON_PROPERTY_STORE`

Constructor Summary

Constructors
Constructor Description

PaymentMethodsRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentMethodsRequest`	`addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)`
`PaymentMethodsRequest`	`addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)`
`PaymentMethodsRequest`	`additionalData(Map<String,String> additionalData)`
`PaymentMethodsRequest`	`allowedPaymentMethods(List<String> allowedPaymentMethods)`
`PaymentMethodsRequest`	`amount(Amount amount)`
`PaymentMethodsRequest`	`blockedPaymentMethods(List<String> blockedPaymentMethods)`
`PaymentMethodsRequest`	`channel(PaymentMethodsRequest.ChannelEnum channel)`
`PaymentMethodsRequest`	`countryCode(String countryCode)`
`boolean`	`equals(Object o)`	Return true if this PaymentMethodsRequest object is equal to o.
`static PaymentMethodsRequest`	`fromJson(String jsonString)`	Create an instance of PaymentMethodsRequest given an JSON string
`Map<String,String>`	`getAdditionalData()`	This field contains additional data, which may be required for a particular payment request.
`List<String>`	`getAllowedPaymentMethods()`	List of payment methods to be presented to the shopper.
`Amount`	`getAmount()`	Get amount
`List<String>`	`getBlockedPaymentMethods()`	List of payment methods to be hidden from the shopper.
`PaymentMethodsRequest.ChannelEnum`	`getChannel()`	The platform where a payment transaction takes place.
`String`	`getCountryCode()`	The shopper's country code.
`String`	`getMerchantAccount()`	The merchant account identifier, with which you want to process the transaction.
`EncryptedOrderData`	`getOrder()`	Get order
`String`	`getShopperLocale()`	The combination of a language code and a country code to specify the language to be used in the payment.
`String`	`getShopperReference()`	Required for recurring payments.
`Boolean`	`getSplitCardFundingSources()`	Boolean value indicating whether the card payment method should be split into separate debit and credit options.
`String`	`getStore()`	The ecommerce or point-of-sale store that is processing the payment.
`int`	`hashCode()`
`PaymentMethodsRequest`	`merchantAccount(String merchantAccount)`
`PaymentMethodsRequest`	`order(EncryptedOrderData order)`
`PaymentMethodsRequest`	`putAdditionalDataItem(String key, String additionalDataItem)`
`void`	`setAdditionalData(Map<String,String> additionalData)`
`void`	`setAllowedPaymentMethods(List<String> allowedPaymentMethods)`
`void`	`setAmount(Amount amount)`
`void`	`setBlockedPaymentMethods(List<String> blockedPaymentMethods)`
`void`	`setChannel(PaymentMethodsRequest.ChannelEnum channel)`
`void`	`setCountryCode(String countryCode)`
`void`	`setMerchantAccount(String merchantAccount)`
`void`	`setOrder(EncryptedOrderData order)`
`void`	`setShopperLocale(String shopperLocale)`
`void`	`setShopperReference(String shopperReference)`
`void`	`setSplitCardFundingSources(Boolean splitCardFundingSources)`
`void`	`setStore(String store)`
`PaymentMethodsRequest`	`shopperLocale(String shopperLocale)`
`PaymentMethodsRequest`	`shopperReference(String shopperReference)`
`PaymentMethodsRequest`	`splitCardFundingSources(Boolean splitCardFundingSources)`
`PaymentMethodsRequest`	`store(String store)`
`String`	`toJson()`	Convert an instance of PaymentMethodsRequest to an JSON string
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_ADDITIONAL_DATA
```
public static final String JSON_PROPERTY_ADDITIONAL_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ALLOWED_PAYMENT_METHODS
```
public static final String JSON_PROPERTY_ALLOWED_PAYMENT_METHODS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BLOCKED_PAYMENT_METHODS
```
public static final String JSON_PROPERTY_BLOCKED_PAYMENT_METHODS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CHANNEL
```
public static final String JSON_PROPERTY_CHANNEL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COUNTRY_CODE
```
public static final String JSON_PROPERTY_COUNTRY_CODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ORDER
```
public static final String JSON_PROPERTY_ORDER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_LOCALE
```
public static final String JSON_PROPERTY_SHOPPER_LOCALE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_REFERENCE
```
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES
```
public static final String JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STORE
```
public static final String JSON_PROPERTY_STORE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaymentMethodsRequest
```
public PaymentMethodsRequest()
```
- Method Detail
  - additionalData
```
public PaymentMethodsRequest additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public PaymentMethodsRequest putAdditionalDataItem(String key,
                                                   String additionalDataItem)
```
  - getAdditionalData
```
public Map<String,String> getAdditionalData()
```
    This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.
    
    Returns:
    
    additionalData
  - setAdditionalData
```
public void setAdditionalData(Map<String,String> additionalData)
```
  - allowedPaymentMethods
```
public PaymentMethodsRequest allowedPaymentMethods(List<String> allowedPaymentMethods)
```
  - addAllowedPaymentMethodsItem
```
public PaymentMethodsRequest addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)
```
  - getAllowedPaymentMethods
```
public List<String> getAllowedPaymentMethods()
```
    List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Returns:
    
    allowedPaymentMethods
  - setAllowedPaymentMethods
```
public void setAllowedPaymentMethods(List<String> allowedPaymentMethods)
```
  - amount
```
public PaymentMethodsRequest amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - blockedPaymentMethods
```
public PaymentMethodsRequest blockedPaymentMethods(List<String> blockedPaymentMethods)
```
  - addBlockedPaymentMethodsItem
```
public PaymentMethodsRequest addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)
```
  - getBlockedPaymentMethods
```
public List<String> getBlockedPaymentMethods()
```
    List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Returns:
    
    blockedPaymentMethods
  - setBlockedPaymentMethods
```
public void setBlockedPaymentMethods(List<String> blockedPaymentMethods)
```
  - channel
```
public PaymentMethodsRequest channel(PaymentMethodsRequest.ChannelEnum channel)
```
  - getChannel
```
public PaymentMethodsRequest.ChannelEnum getChannel()
```
    The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web
    
    Returns:
    
    channel
  - setChannel
```
public void setChannel(PaymentMethodsRequest.ChannelEnum channel)
```
  - countryCode
```
public PaymentMethodsRequest countryCode(String countryCode)
```
  - getCountryCode
```
public String getCountryCode()
```
    The shopper's country code.
    
    Returns:
    
    countryCode
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
  - merchantAccount
```
public PaymentMethodsRequest merchantAccount(String merchantAccount)
```
  - getMerchantAccount
```
public String getMerchantAccount()
```
    The merchant account identifier, with which you want to process the transaction.
    
    Returns:
    
    merchantAccount
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
  - order
```
public PaymentMethodsRequest order(EncryptedOrderData order)
```
  - getOrder
```
public EncryptedOrderData getOrder()
```
    Get order
    
    Returns:
    
    order
  - setOrder
```
public void setOrder(EncryptedOrderData order)
```
  - shopperLocale
```
public PaymentMethodsRequest shopperLocale(String shopperLocale)
```
  - getShopperLocale
```
public String getShopperLocale()
```
    The combination of a language code and a country code to specify the language to be used in the payment.
    
    Returns:
    
    shopperLocale
  - setShopperLocale
```
public void setShopperLocale(String shopperLocale)
```
  - shopperReference
```
public PaymentMethodsRequest shopperReference(String shopperReference)
```
  - getShopperReference
```
public String getShopperReference()
```
    Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
    
    Returns:
    
    shopperReference
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
  - splitCardFundingSources
```
public PaymentMethodsRequest splitCardFundingSources(Boolean splitCardFundingSources)
```
  - getSplitCardFundingSources
```
public Boolean getSplitCardFundingSources()
```
    Boolean value indicating whether the card payment method should be split into separate debit and credit options.
    
    Returns:
    
    splitCardFundingSources
  - setSplitCardFundingSources
```
public void setSplitCardFundingSources(Boolean splitCardFundingSources)
```
  - store
```
public PaymentMethodsRequest store(String store)
```
  - getStore
```
public String getStore()
```
    The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).
    
    Returns:
    
    store
  - setStore
```
public void setStore(String store)
```
  - equals
```
public boolean equals(Object o)
```
    Return true if this PaymentMethodsRequest object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static PaymentMethodsRequest fromJson(String jsonString)
                                      throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of PaymentMethodsRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentMethodsRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentMethodsRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of PaymentMethodsRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class PaymentMethodsRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ADDITIONAL_DATA

JSON_PROPERTY_ALLOWED_PAYMENT_METHODS

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_BLOCKED_PAYMENT_METHODS

JSON_PROPERTY_CHANNEL

JSON_PROPERTY_COUNTRY_CODE

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_ORDER

JSON_PROPERTY_SHOPPER_LOCALE

JSON_PROPERTY_SHOPPER_REFERENCE

JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES

JSON_PROPERTY_STORE

Constructor Detail

PaymentMethodsRequest

Method Detail

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

allowedPaymentMethods

addAllowedPaymentMethodsItem

getAllowedPaymentMethods

setAllowedPaymentMethods

amount

getAmount

setAmount

blockedPaymentMethods

addBlockedPaymentMethodsItem

getBlockedPaymentMethods

setBlockedPaymentMethods

channel

getChannel

setChannel

countryCode

getCountryCode

setCountryCode

merchantAccount

getMerchantAccount

setMerchantAccount

order

getOrder

setOrder

shopperLocale

getShopperLocale

setShopperLocale

shopperReference

getShopperReference

setShopperReference

splitCardFundingSources

getSplitCardFundingSources

setSplitCardFundingSources

store

getStore

setStore

equals

hashCode

toString

fromJson

toJson