Package com.adyen.model.management

Class Store

  • public class Store
extends Object
    Store

    • Constructor Detail

      • Store

        public Store()

    • Method Detail

      • links

        public Store links​(Links links)
        links
        Parameters:
        links -
        Returns:
        the current Store instance, allowing for method chaining

      • getLinks

        public Links getLinks()
        links
        Returns:
        links

      • setLinks

        public void setLinks​(Links links)
        links
        Parameters:
        links -

      • address

        public Store address​(StoreLocation address)
        address
        Parameters:
        address -
        Returns:
        the current Store instance, allowing for method chaining

      • getAddress

        public StoreLocation getAddress()
        address
        Returns:
        address

      • setAddress

        public void setAddress​(StoreLocation address)
        address
        Parameters:
        address -

      • businessLineIds

        public Store businessLineIds​(List<String> businessLineIds)
        The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id) that the store is associated with. If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.
        Parameters:
        businessLineIds -
        Returns:
        the current Store instance, allowing for method chaining

      • addBusinessLineIdsItem

        public Store addBusinessLineIdsItem​(String businessLineIdsItem)

      • getBusinessLineIds

        public List<String> getBusinessLineIds()
        The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id) that the store is associated with. If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.
        Returns:
        businessLineIds

      • setBusinessLineIds

        public void setBusinessLineIds​(List<String> businessLineIds)
        The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id) that the store is associated with. If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.
        Parameters:
        businessLineIds -

      • description

        public Store description​(String description)
        The description of the store.
        Parameters:
        description -
        Returns:
        the current Store instance, allowing for method chaining

      • getDescription

        public String getDescription()
        The description of the store.
        Returns:
        description

      • setDescription

        public void setDescription​(String description)
        The description of the store.
        Parameters:
        description -

      • externalReferenceId

        public Store externalReferenceId​(String externalReferenceId)
        The unique identifier of the store, used by certain payment methods and tax authorities. Required for CNPJ in Brazil, in the format 00.000.000/0000-00 separated by dots, slashes, hyphens, or without separators. Optional for SIRET in France, up to 14 digits. Optional for Zip in Australia, up to 50 digits.
        Parameters:
        externalReferenceId -
        Returns:
        the current Store instance, allowing for method chaining

      • getExternalReferenceId

        public String getExternalReferenceId()
        The unique identifier of the store, used by certain payment methods and tax authorities. Required for CNPJ in Brazil, in the format 00.000.000/0000-00 separated by dots, slashes, hyphens, or without separators. Optional for SIRET in France, up to 14 digits. Optional for Zip in Australia, up to 50 digits.
        Returns:
        externalReferenceId

      • setExternalReferenceId

        public void setExternalReferenceId​(String externalReferenceId)
        The unique identifier of the store, used by certain payment methods and tax authorities. Required for CNPJ in Brazil, in the format 00.000.000/0000-00 separated by dots, slashes, hyphens, or without separators. Optional for SIRET in France, up to 14 digits. Optional for Zip in Australia, up to 50 digits.
        Parameters:
        externalReferenceId -

      • id

        public Store id​(String id)
        The unique identifier of the store. This value is generated by Adyen.
        Parameters:
        id -
        Returns:
        the current Store instance, allowing for method chaining

      • getId

        public String getId()
        The unique identifier of the store. This value is generated by Adyen.
        Returns:
        id

      • setId

        public void setId​(String id)
        The unique identifier of the store. This value is generated by Adyen.
        Parameters:
        id -

      • merchantId

        public Store merchantId​(String merchantId)
        The unique identifier of the merchant account that the store belongs to.
        Parameters:
        merchantId -
        Returns:
        the current Store instance, allowing for method chaining

      • getMerchantId

        public String getMerchantId()
        The unique identifier of the merchant account that the store belongs to.
        Returns:
        merchantId

      • setMerchantId

        public void setMerchantId​(String merchantId)
        The unique identifier of the merchant account that the store belongs to.
        Parameters:
        merchantId -

      • phoneNumber

        public Store phoneNumber​(String phoneNumber)
        The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164.
        Parameters:
        phoneNumber -
        Returns:
        the current Store instance, allowing for method chaining

      • getPhoneNumber

        public String getPhoneNumber()
        The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164.
        Returns:
        phoneNumber

      • setPhoneNumber

        public void setPhoneNumber​(String phoneNumber)
        The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164.
        Parameters:
        phoneNumber -

      • reference

        public Store reference​(String reference)
        A reference to recognize the store by. Also known as the store code. Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)
        Parameters:
        reference -
        Returns:
        the current Store instance, allowing for method chaining

      • getReference

        public String getReference()
        A reference to recognize the store by. Also known as the store code. Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)
        Returns:
        reference

      • setReference

        public void setReference​(String reference)
        A reference to recognize the store by. Also known as the store code. Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)
        Parameters:
        reference -

      • shopperStatement

        public Store shopperStatement​(String shopperStatement)
        The store name shown on the shopper's bank or credit card statement and on the shopper receipt.
        Parameters:
        shopperStatement -
        Returns:
        the current Store instance, allowing for method chaining

      • getShopperStatement

        public String getShopperStatement()
        The store name shown on the shopper's bank or credit card statement and on the shopper receipt.
        Returns:
        shopperStatement

      • setShopperStatement

        public void setShopperStatement​(String shopperStatement)
        The store name shown on the shopper's bank or credit card statement and on the shopper receipt.
        Parameters:
        shopperStatement -

      • splitConfiguration

        public Store splitConfiguration​(StoreSplitConfiguration splitConfiguration)
        splitConfiguration
        Parameters:
        splitConfiguration -
        Returns:
        the current Store instance, allowing for method chaining

      • getSplitConfiguration

        public StoreSplitConfiguration getSplitConfiguration()
        splitConfiguration
        Returns:
        splitConfiguration

      • setSplitConfiguration

        public void setSplitConfiguration​(StoreSplitConfiguration splitConfiguration)
        splitConfiguration
        Parameters:
        splitConfiguration -

      • status

        public Store status​(Store.StatusEnum status)
        The status of the store. Possible values are: - **active**. This value is assigned automatically when a store is created. - **inactive**. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible. - **closed**. This status is irreversible. The terminals under the store are reassigned to the merchant inventory.
        Parameters:
        status -
        Returns:
        the current Store instance, allowing for method chaining

      • getStatus

        public Store.StatusEnum getStatus()
        The status of the store. Possible values are: - **active**. This value is assigned automatically when a store is created. - **inactive**. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible. - **closed**. This status is irreversible. The terminals under the store are reassigned to the merchant inventory.
        Returns:
        status

      • setStatus

        public void setStatus​(Store.StatusEnum status)
        The status of the store. Possible values are: - **active**. This value is assigned automatically when a store is created. - **inactive**. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible. - **closed**. This status is irreversible. The terminals under the store are reassigned to the merchant inventory.
        Parameters:
        status -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static Store fromJson​(String jsonString)
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of Store given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of Store
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to Store

      • toJson

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