Package com.adyen.model.management
Class Store
- java.lang.Object
-
- com.adyen.model.management.Store
-
public class Store extends Object
Store
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classStore.StatusEnumThe status of the store.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ADDRESSstatic StringJSON_PROPERTY_BUSINESS_LINE_IDSstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_EXTERNAL_REFERENCE_IDstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_LINKSstatic StringJSON_PROPERTY_MERCHANT_IDstatic StringJSON_PROPERTY_PHONE_NUMBERstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_SHOPPER_STATEMENTstatic StringJSON_PROPERTY_SPLIT_CONFIGURATIONstatic StringJSON_PROPERTY_STATUS
-
Constructor Summary
Constructors Constructor Description Store()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StoreaddBusinessLineIdsItem(String businessLineIdsItem)Storeaddress(StoreLocation address)StorebusinessLineIds(List<String> businessLineIds)Storedescription(String description)booleanequals(Object o)Return true if this Store object is equal to o.StoreexternalReferenceId(String externalReferenceId)static StorefromJson(String jsonString)Create an instance of Store given an JSON stringStoreLocationgetAddress()Get addressList<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.StringgetDescription()The description of the store.StringgetExternalReferenceId()The unique identifier of the store, used by certain payment methods and tax authorities.StringgetId()The unique identifier of the store.LinksgetLinks()Get linksStringgetMerchantId()The unique identifier of the merchant account that the store belongs to.StringgetPhoneNumber()The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format.StringgetReference()A reference to recognize the store by.StringgetShopperStatement()The store name shown on the shopper's bank or credit card statement and on the shopper receipt.StoreSplitConfigurationgetSplitConfiguration()Get splitConfigurationStore.StatusEnumgetStatus()The status of the store.inthashCode()Storeid(String id)Storelinks(Links links)StoremerchantId(String merchantId)StorephoneNumber(String phoneNumber)Storereference(String reference)voidsetAddress(StoreLocation address)addressvoidsetBusinessLineIds(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.voidsetDescription(String description)The description of the store.voidsetExternalReferenceId(String externalReferenceId)The unique identifier of the store, used by certain payment methods and tax authorities.voidsetId(String id)The unique identifier of the store.voidsetLinks(Links links)linksvoidsetMerchantId(String merchantId)The unique identifier of the merchant account that the store belongs to.voidsetPhoneNumber(String phoneNumber)The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format.voidsetReference(String reference)A reference to recognize the store by.voidsetShopperStatement(String shopperStatement)The store name shown on the shopper's bank or credit card statement and on the shopper receipt.voidsetSplitConfiguration(StoreSplitConfiguration splitConfiguration)splitConfigurationvoidsetStatus(Store.StatusEnum status)The status of the store.StoreshopperStatement(String shopperStatement)StoresplitConfiguration(StoreSplitConfiguration splitConfiguration)Storestatus(Store.StatusEnum status)StringtoJson()Convert an instance of Store to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_LINKS
public static final String JSON_PROPERTY_LINKS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ADDRESS
public static final String JSON_PROPERTY_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BUSINESS_LINE_IDS
public static final String JSON_PROPERTY_BUSINESS_LINE_IDS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESCRIPTION
public static final String JSON_PROPERTY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXTERNAL_REFERENCE_ID
public static final String JSON_PROPERTY_EXTERNAL_REFERENCE_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ID
public static final String JSON_PROPERTY_MERCHANT_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PHONE_NUMBER
public static final String JSON_PROPERTY_PHONE_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_STATEMENT
public static final String JSON_PROPERTY_SHOPPER_STATEMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SPLIT_CONFIGURATION
public static final String JSON_PROPERTY_SPLIT_CONFIGURATION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STATUS
public static final String JSON_PROPERTY_STATUS
- See Also:
- Constant Field Values
-
-
Method Detail
-
getLinks
public Links getLinks()
Get links- Returns:
- links
-
setLinks
public void setLinks(Links links)
links- Parameters:
links-
-
address
public Store address(StoreLocation address)
-
getAddress
public StoreLocation getAddress()
Get address- Returns:
- address
-
setAddress
public void setAddress(StoreLocation address)
address- Parameters:
address-
-
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-
-
getDescription
public String getDescription()
The description of the store.- Returns:
- description
-
setDescription
public void setDescription(String description)
The description of the store.- Parameters:
description-
-
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-
-
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-
-
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-
-
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-
-
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-
-
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)
-
getSplitConfiguration
public StoreSplitConfiguration getSplitConfiguration()
Get splitConfiguration- Returns:
- splitConfiguration
-
setSplitConfiguration
public void setSplitConfiguration(StoreSplitConfiguration splitConfiguration)
splitConfiguration- Parameters:
splitConfiguration-
-
status
public Store status(Store.StatusEnum status)
-
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.
-
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
-
-