Package com.adyen.model.checkout

Class StoredPaymentMethodRequest

  • public class StoredPaymentMethodRequest
extends Object
    StoredPaymentMethodRequest

    • Constructor Detail

      • StoredPaymentMethodRequest

        public StoredPaymentMethodRequest()

    • Method Detail

      • merchantAccount

        public StoredPaymentMethodRequest merchantAccount​(String merchantAccount)
        The merchant account identifier, with which you want to process the transaction.
        Parameters:
        merchantAccount - The merchant account identifier, with which you want to process the transaction.
        Returns:
        the current StoredPaymentMethodRequest instance, allowing for method chaining

      • getMerchantAccount

        public String getMerchantAccount()
        The merchant account identifier, with which you want to process the transaction.
        Returns:
        merchantAccount The merchant account identifier, with which you want to process the transaction.

      • setMerchantAccount

        public void setMerchantAccount​(String merchantAccount)
        The merchant account identifier, with which you want to process the transaction.
        Parameters:
        merchantAccount - The merchant account identifier, with which you want to process the transaction.

      • paymentMethod

        public StoredPaymentMethodRequest paymentMethod​(PaymentMethodToStore paymentMethod)
        paymentMethod
        Parameters:
        paymentMethod -
        Returns:
        the current StoredPaymentMethodRequest instance, allowing for method chaining

      • getPaymentMethod

        public PaymentMethodToStore getPaymentMethod()
        Get paymentMethod
        Returns:
        paymentMethod

      • setPaymentMethod

        public void setPaymentMethod​(PaymentMethodToStore paymentMethod)
        paymentMethod
        Parameters:
        paymentMethod -

      • recurringProcessingModel

        public StoredPaymentMethodRequest recurringProcessingModel​(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 - 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:
        the current StoredPaymentMethodRequest instance, allowing for method chaining

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

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

      • shopperEmail

        public StoredPaymentMethodRequest shopperEmail​(String shopperEmail)
        The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.
        Parameters:
        shopperEmail - The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.
        Returns:
        the current StoredPaymentMethodRequest instance, allowing for method chaining

      • 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 The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.

      • 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 - The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.

      • shopperIP

        public StoredPaymentMethodRequest shopperIP​(String shopperIP)
        The IP address of a shopper.
        Parameters:
        shopperIP - The IP address of a shopper.
        Returns:
        the current StoredPaymentMethodRequest instance, allowing for method chaining

      • getShopperIP

        public String getShopperIP()
        The IP address of a shopper.
        Returns:
        shopperIP The IP address of a shopper.

      • setShopperIP

        public void setShopperIP​(String shopperIP)
        The IP address of a shopper.
        Parameters:
        shopperIP - The IP address of a shopper.

      • shopperReference

        public StoredPaymentMethodRequest shopperReference​(String shopperReference)
        A unique identifier for the shopper (for example, user ID or account ID).
        Parameters:
        shopperReference - A unique identifier for the shopper (for example, user ID or account ID).
        Returns:
        the current StoredPaymentMethodRequest instance, allowing for method chaining

      • getShopperReference

        public String getShopperReference()
        A unique identifier for the shopper (for example, user ID or account ID).
        Returns:
        shopperReference A unique identifier for the shopper (for example, user ID or account ID).

      • setShopperReference

        public void setShopperReference​(String shopperReference)
        A unique identifier for the shopper (for example, user ID or account ID).
        Parameters:
        shopperReference - A unique identifier for the shopper (for example, user ID or account ID).

      • includeNullValues

        public StoredPaymentMethodRequest includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • equals

        public boolean equals​(Object o)
        Return true if this StoredPaymentMethodRequest object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • 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