Package com.adyen.model.management
Class StoreCreationRequest
- java.lang.Object
-
- com.adyen.model.management.StoreCreationRequest
-
public class StoreCreationRequest extends Object
StoreCreationRequest
-
-
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_PHONE_NUMBERstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_SHOPPER_STATEMENTstatic StringJSON_PROPERTY_SPLIT_CONFIGURATION
-
Constructor Summary
Constructors Constructor Description StoreCreationRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StoreCreationRequestaddBusinessLineIdsItem(String businessLineIdsItem)StoreCreationRequestaddress(StoreLocation address)addressStoreCreationRequestbusinessLineIds(List<String> businessLineIds)The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with.StoreCreationRequestdescription(String description)Your description of the store.booleanequals(Object o)Return true if this StoreCreationRequest object is equal to o.StoreCreationRequestexternalReferenceId(String externalReferenceId)The unique identifier of the store, used by certain payment methods and tax authorities.static StoreCreationRequestfromJson(String jsonString)Create an instance of StoreCreationRequest given an JSON stringStoreLocationgetAddress()addressList<String>getBusinessLineIds()The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with.StringgetDescription()Your description of the store.StringgetExternalReferenceId()The unique identifier of the store, used by certain payment methods and tax authorities.StringgetPhoneNumber()The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format.StringgetReference()Your reference to recognize the store by.StringgetShopperStatement()The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt.StoreSplitConfigurationgetSplitConfiguration()splitConfigurationinthashCode()StoreCreationRequestphoneNumber(String phoneNumber)The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format.StoreCreationRequestreference(String reference)Your reference to recognize the store by.voidsetAddress(StoreLocation address)addressvoidsetBusinessLineIds(List<String> businessLineIds)The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with.voidsetDescription(String description)Your description of the store.voidsetExternalReferenceId(String externalReferenceId)The unique identifier of the store, used by certain payment methods and tax authorities.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)Your reference to recognize the store by.voidsetShopperStatement(String shopperStatement)The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt.voidsetSplitConfiguration(StoreSplitConfiguration splitConfiguration)splitConfigurationStoreCreationRequestshopperStatement(String shopperStatement)The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt.StoreCreationRequestsplitConfiguration(StoreSplitConfiguration splitConfiguration)splitConfigurationStringtoJson()Convert an instance of StoreCreationRequest to an JSON stringStringtoString()
-
-
-
Field Detail
-
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_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
-
-
Method Detail
-
address
public StoreCreationRequest address(StoreLocation address)
address- Parameters:
address-- Returns:
- the current
StoreCreationRequestinstance, allowing for method chaining
-
getAddress
public StoreLocation getAddress()
address- Returns:
- address
-
setAddress
public void setAddress(StoreLocation address)
address- Parameters:
address-
-
businessLineIds
public StoreCreationRequest businessLineIds(List<String> businessLineIds)
The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-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
StoreCreationRequestinstance, allowing for method chaining
-
addBusinessLineIdsItem
public StoreCreationRequest 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#responses-200-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#responses-200-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 StoreCreationRequest description(String description)
Your description of the store.- Parameters:
description-- Returns:
- the current
StoreCreationRequestinstance, allowing for method chaining
-
getDescription
public String getDescription()
Your description of the store.- Returns:
- description
-
setDescription
public void setDescription(String description)
Your description of the store.- Parameters:
description-
-
externalReferenceId
public StoreCreationRequest 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
StoreCreationRequestinstance, 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-
-
phoneNumber
public StoreCreationRequest 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
StoreCreationRequestinstance, 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 StoreCreationRequest reference(String reference)
Your 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 (_). If you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id).- Parameters:
reference-- Returns:
- the current
StoreCreationRequestinstance, allowing for method chaining
-
getReference
public String getReference()
Your 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 (_). If you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id).- Returns:
- reference
-
setReference
public void setReference(String reference)
Your 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 (_). If you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id).- Parameters:
reference-
-
shopperStatement
public StoreCreationRequest shopperStatement(String shopperStatement)
The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt. Maximum length: 22 characters; can't be all numbers.- Parameters:
shopperStatement-- Returns:
- the current
StoreCreationRequestinstance, allowing for method chaining
-
getShopperStatement
public String getShopperStatement()
The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt. Maximum length: 22 characters; can't be all numbers.- Returns:
- shopperStatement
-
setShopperStatement
public void setShopperStatement(String shopperStatement)
The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt. Maximum length: 22 characters; can't be all numbers.- Parameters:
shopperStatement-
-
splitConfiguration
public StoreCreationRequest splitConfiguration(StoreSplitConfiguration splitConfiguration)
splitConfiguration- Parameters:
splitConfiguration-- Returns:
- the current
StoreCreationRequestinstance, allowing for method chaining
-
getSplitConfiguration
public StoreSplitConfiguration getSplitConfiguration()
splitConfiguration- Returns:
- splitConfiguration
-
setSplitConfiguration
public void setSplitConfiguration(StoreSplitConfiguration splitConfiguration)
splitConfiguration- Parameters:
splitConfiguration-
-
equals
public boolean equals(Object o)
Return true if this StoreCreationRequest object is equal to o.
-
fromJson
public static StoreCreationRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of StoreCreationRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of StoreCreationRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to StoreCreationRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of StoreCreationRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-