Package com.adyen.model.checkout
Class StoredPaymentMethodRequest
- java.lang.Object
-
- com.adyen.model.checkout.StoredPaymentMethodRequest
-
public class StoredPaymentMethodRequest extends Object
StoredPaymentMethodRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classStoredPaymentMethodRequest.RecurringProcessingModelEnumDefines a recurring payment type.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_MERCHANT_ACCOUNTstatic StringJSON_PROPERTY_PAYMENT_METHODstatic StringJSON_PROPERTY_RECURRING_PROCESSING_MODELstatic StringJSON_PROPERTY_SHOPPER_EMAILstatic StringJSON_PROPERTY_SHOPPER_I_Pstatic StringJSON_PROPERTY_SHOPPER_REFERENCE
-
Constructor Summary
Constructors Constructor Description StoredPaymentMethodRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)Return true if this StoredPaymentMethodRequest object is equal to o.static StoredPaymentMethodRequestfromJson(String jsonString)Create an instance of StoredPaymentMethodRequest given an JSON stringStringgetMerchantAccount()The merchant account identifier, with which you want to process the transaction.PaymentMethodToStoregetPaymentMethod()Get paymentMethodStoredPaymentMethodRequest.RecurringProcessingModelEnumgetRecurringProcessingModel()Defines a recurring payment type.StringgetShopperEmail()The shopper's email address.StringgetShopperIP()The IP address of a shopper.StringgetShopperReference()A unique identifier for the shopper (for example, user ID or account ID).inthashCode()StoredPaymentMethodRequestmerchantAccount(String merchantAccount)StoredPaymentMethodRequestpaymentMethod(PaymentMethodToStore paymentMethod)StoredPaymentMethodRequestrecurringProcessingModel(StoredPaymentMethodRequest.RecurringProcessingModelEnum recurringProcessingModel)voidsetMerchantAccount(String merchantAccount)The merchant account identifier, with which you want to process the transaction.voidsetPaymentMethod(PaymentMethodToStore paymentMethod)paymentMethodvoidsetRecurringProcessingModel(StoredPaymentMethodRequest.RecurringProcessingModelEnum recurringProcessingModel)Defines a recurring payment type.voidsetShopperEmail(String shopperEmail)The shopper's email address.voidsetShopperIP(String shopperIP)The IP address of a shopper.voidsetShopperReference(String shopperReference)A unique identifier for the shopper (for example, user ID or account ID).StoredPaymentMethodRequestshopperEmail(String shopperEmail)StoredPaymentMethodRequestshopperIP(String shopperIP)StoredPaymentMethodRequestshopperReference(String shopperReference)StringtoJson()Convert an instance of StoredPaymentMethodRequest to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_MERCHANT_ACCOUNT
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAYMENT_METHOD
public static final String JSON_PROPERTY_PAYMENT_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING_PROCESSING_MODEL
public static final String JSON_PROPERTY_RECURRING_PROCESSING_MODEL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_EMAIL
public static final String JSON_PROPERTY_SHOPPER_EMAIL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_I_P
public static final String JSON_PROPERTY_SHOPPER_I_P
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_REFERENCE
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
- See Also:
- Constant Field Values
-
-
Method Detail
-
merchantAccount
public StoredPaymentMethodRequest 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)
The merchant account identifier, with which you want to process the transaction.- Parameters:
merchantAccount-
-
paymentMethod
public StoredPaymentMethodRequest paymentMethod(PaymentMethodToStore paymentMethod)
-
getPaymentMethod
public PaymentMethodToStore getPaymentMethod()
Get paymentMethod- Returns:
- paymentMethod
-
setPaymentMethod
public void setPaymentMethod(PaymentMethodToStore paymentMethod)
paymentMethod- Parameters:
paymentMethod-
-
recurringProcessingModel
public StoredPaymentMethodRequest recurringProcessingModel(StoredPaymentMethodRequest.RecurringProcessingModelEnum recurringProcessingModel)
-
getRecurringProcessingModel
public StoredPaymentMethodRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
Defines a recurring payment type. Required when creating a token to store payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.- Returns:
- recurringProcessingModel
-
setRecurringProcessingModel
public void setRecurringProcessingModel(StoredPaymentMethodRequest.RecurringProcessingModelEnum recurringProcessingModel)
Defines a recurring payment type. Required when creating a token to store payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.- Parameters:
recurringProcessingModel-
-
shopperEmail
public StoredPaymentMethodRequest shopperEmail(String shopperEmail)
-
getShopperEmail
public String getShopperEmail()
The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.- Returns:
- shopperEmail
-
setShopperEmail
public void setShopperEmail(String shopperEmail)
The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.- Parameters:
shopperEmail-
-
shopperIP
public StoredPaymentMethodRequest shopperIP(String shopperIP)
-
getShopperIP
public String getShopperIP()
The IP address of a shopper.- Returns:
- shopperIP
-
setShopperIP
public void setShopperIP(String shopperIP)
The IP address of a shopper.- Parameters:
shopperIP-
-
shopperReference
public StoredPaymentMethodRequest shopperReference(String shopperReference)
-
getShopperReference
public String getShopperReference()
A unique identifier for the shopper (for example, user ID or account ID).- Returns:
- shopperReference
-
setShopperReference
public void setShopperReference(String shopperReference)
A unique identifier for the shopper (for example, user ID or account ID).- Parameters:
shopperReference-
-
equals
public boolean equals(Object o)
Return true if this StoredPaymentMethodRequest object is equal to o.
-
fromJson
public static StoredPaymentMethodRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of StoredPaymentMethodRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of StoredPaymentMethodRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to StoredPaymentMethodRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of StoredPaymentMethodRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-