Package com.adyen.model.checkout

Class StoredPaymentMethodResource

  • public class StoredPaymentMethodResource
extends Object
    StoredPaymentMethodResource

    • Constructor Detail

      • StoredPaymentMethodResource

        public StoredPaymentMethodResource()

    • Method Detail

      • alias

        public StoredPaymentMethodResource alias​(String alias)
        The alias of the credit card number. Applies only to recurring contracts storing credit card details
        Parameters:
        alias - The alias of the credit card number. Applies only to recurring contracts storing credit card details
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getAlias

        public String getAlias()
        The alias of the credit card number. Applies only to recurring contracts storing credit card details
        Returns:
        alias The alias of the credit card number. Applies only to recurring contracts storing credit card details

      • setAlias

        public void setAlias​(String alias)
        The alias of the credit card number. Applies only to recurring contracts storing credit card details
        Parameters:
        alias - The alias of the credit card number. Applies only to recurring contracts storing credit card details

      • aliasType

        public StoredPaymentMethodResource aliasType​(String aliasType)
        The alias type of the credit card number. Applies only to recurring contracts storing credit card details.
        Parameters:
        aliasType - The alias type of the credit card number. Applies only to recurring contracts storing credit card details.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getAliasType

        public String getAliasType()
        The alias type of the credit card number. Applies only to recurring contracts storing credit card details.
        Returns:
        aliasType The alias type of the credit card number. Applies only to recurring contracts storing credit card details.

      • setAliasType

        public void setAliasType​(String aliasType)
        The alias type of the credit card number. Applies only to recurring contracts storing credit card details.
        Parameters:
        aliasType - The alias type of the credit card number. Applies only to recurring contracts storing credit card details.

      • brand

        public StoredPaymentMethodResource brand​(String brand)
        The brand of the card.
        Parameters:
        brand - The brand of the card.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getBrand

        public String getBrand()
        The brand of the card.
        Returns:
        brand The brand of the card.

      • setBrand

        public void setBrand​(String brand)
        The brand of the card.
        Parameters:
        brand - The brand of the card.

      • cardBin

        public StoredPaymentMethodResource cardBin​(String cardBin)
        The bank identification number (BIN) of the card.
        Parameters:
        cardBin - The bank identification number (BIN) of the card.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getCardBin

        public String getCardBin()
        The bank identification number (BIN) of the card.
        Returns:
        cardBin The bank identification number (BIN) of the card.

      • setCardBin

        public void setCardBin​(String cardBin)
        The bank identification number (BIN) of the card.
        Parameters:
        cardBin - The bank identification number (BIN) of the card.

      • expiryMonth

        public StoredPaymentMethodResource expiryMonth​(String expiryMonth)
        The month the card expires.
        Parameters:
        expiryMonth - The month the card expires.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getExpiryMonth

        public String getExpiryMonth()
        The month the card expires.
        Returns:
        expiryMonth The month the card expires.

      • setExpiryMonth

        public void setExpiryMonth​(String expiryMonth)
        The month the card expires.
        Parameters:
        expiryMonth - The month the card expires.

      • expiryYear

        public StoredPaymentMethodResource expiryYear​(String expiryYear)
        The last two digits of the year the card expires. For example, **22** for the year 2022.
        Parameters:
        expiryYear - The last two digits of the year the card expires. For example, **22** for the year 2022.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getExpiryYear

        public String getExpiryYear()
        The last two digits of the year the card expires. For example, **22** for the year 2022.
        Returns:
        expiryYear The last two digits of the year the card expires. For example, **22** for the year 2022.

      • setExpiryYear

        public void setExpiryYear​(String expiryYear)
        The last two digits of the year the card expires. For example, **22** for the year 2022.
        Parameters:
        expiryYear - The last two digits of the year the card expires. For example, **22** for the year 2022.

      • externalResponseCode

        public StoredPaymentMethodResource externalResponseCode​(String externalResponseCode)
        The response code returned by an external system (for example after a provisioning operation).
        Parameters:
        externalResponseCode - The response code returned by an external system (for example after a provisioning operation).
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getExternalResponseCode

        public String getExternalResponseCode()
        The response code returned by an external system (for example after a provisioning operation).
        Returns:
        externalResponseCode The response code returned by an external system (for example after a provisioning operation).

      • setExternalResponseCode

        public void setExternalResponseCode​(String externalResponseCode)
        The response code returned by an external system (for example after a provisioning operation).
        Parameters:
        externalResponseCode - The response code returned by an external system (for example after a provisioning operation).

      • externalTokenReference

        public StoredPaymentMethodResource externalTokenReference​(String externalTokenReference)
        The token reference of a linked token in an external system (for example a network token reference).
        Parameters:
        externalTokenReference - The token reference of a linked token in an external system (for example a network token reference).
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getExternalTokenReference

        public String getExternalTokenReference()
        The token reference of a linked token in an external system (for example a network token reference).
        Returns:
        externalTokenReference The token reference of a linked token in an external system (for example a network token reference).

      • setExternalTokenReference

        public void setExternalTokenReference​(String externalTokenReference)
        The token reference of a linked token in an external system (for example a network token reference).
        Parameters:
        externalTokenReference - The token reference of a linked token in an external system (for example a network token reference).

      • holderName

        public StoredPaymentMethodResource holderName​(String holderName)
        The unique payment method code.
        Parameters:
        holderName - The unique payment method code.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getHolderName

        public String getHolderName()
        The unique payment method code.
        Returns:
        holderName The unique payment method code.

      • setHolderName

        public void setHolderName​(String holderName)
        The unique payment method code.
        Parameters:
        holderName - The unique payment method code.

      • iban

        public StoredPaymentMethodResource iban​(String iban)
        The IBAN of the bank account.
        Parameters:
        iban - The IBAN of the bank account.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getIban

        public String getIban()
        The IBAN of the bank account.
        Returns:
        iban The IBAN of the bank account.

      • setIban

        public void setIban​(String iban)
        The IBAN of the bank account.
        Parameters:
        iban - The IBAN of the bank account.

      • id

        public StoredPaymentMethodResource id​(String id)
        A unique identifier of this stored payment method.
        Parameters:
        id - A unique identifier of this stored payment method.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getId

        public String getId()
        A unique identifier of this stored payment method.
        Returns:
        id A unique identifier of this stored payment method.

      • setId

        public void setId​(String id)
        A unique identifier of this stored payment method.
        Parameters:
        id - A unique identifier of this stored payment method.

      • issuerName

        public StoredPaymentMethodResource issuerName​(String issuerName)
        The name of the issuer of token or card.
        Parameters:
        issuerName - The name of the issuer of token or card.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getIssuerName

        public String getIssuerName()
        The name of the issuer of token or card.
        Returns:
        issuerName The name of the issuer of token or card.

      • setIssuerName

        public void setIssuerName​(String issuerName)
        The name of the issuer of token or card.
        Parameters:
        issuerName - The name of the issuer of token or card.

      • lastFour

        public StoredPaymentMethodResource lastFour​(String lastFour)
        The last four digits of the PAN.
        Parameters:
        lastFour - The last four digits of the PAN.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getLastFour

        public String getLastFour()
        The last four digits of the PAN.
        Returns:
        lastFour The last four digits of the PAN.

      • setLastFour

        public void setLastFour​(String lastFour)
        The last four digits of the PAN.
        Parameters:
        lastFour - The last four digits of the PAN.

      • mandate

        public StoredPaymentMethodResource mandate​(TokenMandate mandate)
        mandate
        Parameters:
        mandate -
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getMandate

        public TokenMandate getMandate()
        Get mandate
        Returns:
        mandate

      • setMandate

        public void setMandate​(TokenMandate mandate)
        mandate
        Parameters:
        mandate -

      • name

        public StoredPaymentMethodResource name​(String name)
        The display name of the stored payment method.
        Parameters:
        name - The display name of the stored payment method.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getName

        public String getName()
        The display name of the stored payment method.
        Returns:
        name The display name of the stored payment method.

      • setName

        public void setName​(String name)
        The display name of the stored payment method.
        Parameters:
        name - The display name of the stored payment method.

      • networkTxReference

        public StoredPaymentMethodResource networkTxReference​(String networkTxReference)
        Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Parameters:
        networkTxReference - Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getNetworkTxReference

        public String getNetworkTxReference()
        Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Returns:
        networkTxReference Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.

      • setNetworkTxReference

        public void setNetworkTxReference​(String networkTxReference)
        Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Parameters:
        networkTxReference - Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.

      • ownerName

        public StoredPaymentMethodResource ownerName​(String ownerName)
        The name of the bank account holder.
        Parameters:
        ownerName - The name of the bank account holder.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getOwnerName

        public String getOwnerName()
        The name of the bank account holder.
        Returns:
        ownerName The name of the bank account holder.

      • setOwnerName

        public void setOwnerName​(String ownerName)
        The name of the bank account holder.
        Parameters:
        ownerName - The name of the bank account holder.

      • shopperEmail

        public StoredPaymentMethodResource shopperEmail​(String shopperEmail)
        The shopper’s email address.
        Parameters:
        shopperEmail - The shopper’s email address.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getShopperEmail

        public String getShopperEmail()
        The shopper’s email address.
        Returns:
        shopperEmail The shopper’s email address.

      • setShopperEmail

        public void setShopperEmail​(String shopperEmail)
        The shopper’s email address.
        Parameters:
        shopperEmail - The shopper’s email address.

      • shopperReference

        public StoredPaymentMethodResource shopperReference​(String shopperReference)
        Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
        Parameters:
        shopperReference - Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getShopperReference

        public String getShopperReference()
        Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
        Returns:
        shopperReference Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.

      • setShopperReference

        public void setShopperReference​(String shopperReference)
        Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
        Parameters:
        shopperReference - Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.

      • supportedRecurringProcessingModels

        public StoredPaymentMethodResource supportedRecurringProcessingModels​(List<String> supportedRecurringProcessingModels)
        Defines a recurring payment type. 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:
        supportedRecurringProcessingModels - Defines a recurring payment type. 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 StoredPaymentMethodResource instance, allowing for method chaining

      • addSupportedRecurringProcessingModelsItem

        public StoredPaymentMethodResource addSupportedRecurringProcessingModelsItem​(String supportedRecurringProcessingModelsItem)

      • getSupportedRecurringProcessingModels

        public List<String> getSupportedRecurringProcessingModels()
        Defines a recurring payment type. 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:
        supportedRecurringProcessingModels Defines a recurring payment type. 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.

      • setSupportedRecurringProcessingModels

        public void setSupportedRecurringProcessingModels​(List<String> supportedRecurringProcessingModels)
        Defines a recurring payment type. 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:
        supportedRecurringProcessingModels - Defines a recurring payment type. 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.

      • type

        public StoredPaymentMethodResource type​(String type)
        The type of payment method.
        Parameters:
        type - The type of payment method.
        Returns:
        the current StoredPaymentMethodResource instance, allowing for method chaining

      • getType

        public String getType()
        The type of payment method.
        Returns:
        type The type of payment method.

      • setType

        public void setType​(String type)
        The type of payment method.
        Parameters:
        type - The type of payment method.

      • includeNullValues

        public StoredPaymentMethodResource 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 StoredPaymentMethodResource 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 StoredPaymentMethodResource fromJson​(String jsonString)
                                            throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of StoredPaymentMethodResource given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of StoredPaymentMethodResource
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to StoredPaymentMethodResource

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of StoredPaymentMethodResource to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException