Package com.adyen.model.management
Class Merchant
- java.lang.Object
-
- com.adyen.model.management.Merchant
-
public class Merchant extends Object
Merchant
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_CAPTURE_DELAYstatic StringJSON_PROPERTY_COMPANY_IDstatic StringJSON_PROPERTY_DATA_CENTERSstatic StringJSON_PROPERTY_DEFAULT_SHOPPER_INTERACTIONstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_LINKSstatic StringJSON_PROPERTY_MERCHANT_CITYstatic StringJSON_PROPERTY_NAMEstatic StringJSON_PROPERTY_PRICING_PLANstatic StringJSON_PROPERTY_PRIMARY_SETTLEMENT_CURRENCYstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_SHOP_WEB_ADDRESSstatic StringJSON_PROPERTY_STATUS
-
Constructor Summary
Constructors Constructor Description Merchant()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MerchantaddDataCentersItem(DataCenter dataCentersItem)MerchantcaptureDelay(String captureDelay)MerchantcompanyId(String companyId)MerchantdataCenters(List<DataCenter> dataCenters)MerchantdefaultShopperInteraction(String defaultShopperInteraction)Merchantdescription(String description)booleanequals(Object o)Return true if this Merchant object is equal to o.static MerchantfromJson(String jsonString)Create an instance of Merchant given an JSON stringStringgetCaptureDelay()The [capture delay](https://docs.adyen.com/online-payments/capture#capture-delay) set for the merchant account.StringgetCompanyId()The unique identifier of the company account this merchant belongs toList<DataCenter>getDataCenters()List of available data centers.StringgetDefaultShopperInteraction()The default [`shopperInteraction`](https://docs.adyen.com/api-explorer/#/CheckoutService/v68/post/payments__reqParam_shopperInteraction) value used when processing payments through this merchant account.StringgetDescription()Your description for the merchant account, maximum 300 charactersStringgetId()The unique identifier of the merchant account.MerchantLinksgetLinks()Get linksStringgetMerchantCity()The city where the legal entity of this merchant account is registered.StringgetName()The name of the legal entity associated with the merchant account.StringgetPricingPlan()Only applies to merchant accounts managed by Adyen's partners.StringgetPrimarySettlementCurrency()The currency of the country where the legal entity of this merchant account is registered.StringgetReference()Reference of the merchant account.StringgetShopWebAddress()The URL for the ecommerce website used with this merchant account.StringgetStatus()The status of the merchant account.inthashCode()Merchantid(String id)Merchantlinks(MerchantLinks links)MerchantmerchantCity(String merchantCity)Merchantname(String name)MerchantpricingPlan(String pricingPlan)MerchantprimarySettlementCurrency(String primarySettlementCurrency)Merchantreference(String reference)voidsetCaptureDelay(String captureDelay)The [capture delay](https://docs.adyen.com/online-payments/capture#capture-delay) set for the merchant account.voidsetCompanyId(String companyId)The unique identifier of the company account this merchant belongs tovoidsetDataCenters(List<DataCenter> dataCenters)List of available data centers.voidsetDefaultShopperInteraction(String defaultShopperInteraction)The default [`shopperInteraction`](https://docs.adyen.com/api-explorer/#/CheckoutService/v68/post/payments__reqParam_shopperInteraction) value used when processing payments through this merchant account.voidsetDescription(String description)Your description for the merchant account, maximum 300 charactersvoidsetId(String id)The unique identifier of the merchant account.voidsetLinks(MerchantLinks links)linksvoidsetMerchantCity(String merchantCity)The city where the legal entity of this merchant account is registered.voidsetName(String name)The name of the legal entity associated with the merchant account.voidsetPricingPlan(String pricingPlan)Only applies to merchant accounts managed by Adyen's partners.voidsetPrimarySettlementCurrency(String primarySettlementCurrency)The currency of the country where the legal entity of this merchant account is registered.voidsetReference(String reference)Reference of the merchant account.voidsetShopWebAddress(String shopWebAddress)The URL for the ecommerce website used with this merchant account.voidsetStatus(String status)The status of the merchant account.MerchantshopWebAddress(String shopWebAddress)Merchantstatus(String status)StringtoJson()Convert an instance of Merchant to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_LINKS
public static final String JSON_PROPERTY_LINKS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAPTURE_DELAY
public static final String JSON_PROPERTY_CAPTURE_DELAY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COMPANY_ID
public static final String JSON_PROPERTY_COMPANY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DATA_CENTERS
public static final String JSON_PROPERTY_DATA_CENTERS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DEFAULT_SHOPPER_INTERACTION
public static final String JSON_PROPERTY_DEFAULT_SHOPPER_INTERACTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESCRIPTION
public static final String JSON_PROPERTY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_CITY
public static final String JSON_PROPERTY_MERCHANT_CITY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NAME
public static final String JSON_PROPERTY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRICING_PLAN
public static final String JSON_PROPERTY_PRICING_PLAN
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRIMARY_SETTLEMENT_CURRENCY
public static final String JSON_PROPERTY_PRIMARY_SETTLEMENT_CURRENCY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOP_WEB_ADDRESS
public static final String JSON_PROPERTY_SHOP_WEB_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STATUS
public static final String JSON_PROPERTY_STATUS
- See Also:
- Constant Field Values
-
-
Method Detail
-
links
public Merchant links(MerchantLinks links)
-
getLinks
public MerchantLinks getLinks()
Get links- Returns:
- links
-
setLinks
public void setLinks(MerchantLinks links)
links- Parameters:
links-
-
getCaptureDelay
public String getCaptureDelay()
The [capture delay](https://docs.adyen.com/online-payments/capture#capture-delay) set for the merchant account. Possible values: * **Immediate** * **Manual** * Number of days from **1** to **29**- Returns:
- captureDelay
-
setCaptureDelay
public void setCaptureDelay(String captureDelay)
The [capture delay](https://docs.adyen.com/online-payments/capture#capture-delay) set for the merchant account. Possible values: * **Immediate** * **Manual** * Number of days from **1** to **29**- Parameters:
captureDelay-
-
getCompanyId
public String getCompanyId()
The unique identifier of the company account this merchant belongs to- Returns:
- companyId
-
setCompanyId
public void setCompanyId(String companyId)
The unique identifier of the company account this merchant belongs to- Parameters:
companyId-
-
dataCenters
public Merchant dataCenters(List<DataCenter> dataCenters)
-
addDataCentersItem
public Merchant addDataCentersItem(DataCenter dataCentersItem)
-
getDataCenters
public List<DataCenter> getDataCenters()
List of available data centers. Adyen has several data centers around the world.In the URL that you use for making API requests, we recommend you use the live URL prefix from the data center closest to your shoppers.- Returns:
- dataCenters
-
setDataCenters
public void setDataCenters(List<DataCenter> dataCenters)
List of available data centers. Adyen has several data centers around the world.In the URL that you use for making API requests, we recommend you use the live URL prefix from the data center closest to your shoppers.- Parameters:
dataCenters-
-
defaultShopperInteraction
public Merchant defaultShopperInteraction(String defaultShopperInteraction)
-
getDefaultShopperInteraction
public String getDefaultShopperInteraction()
The default [`shopperInteraction`](https://docs.adyen.com/api-explorer/#/CheckoutService/v68/post/payments__reqParam_shopperInteraction) value used when processing payments through this merchant account.- Returns:
- defaultShopperInteraction
-
setDefaultShopperInteraction
public void setDefaultShopperInteraction(String defaultShopperInteraction)
The default [`shopperInteraction`](https://docs.adyen.com/api-explorer/#/CheckoutService/v68/post/payments__reqParam_shopperInteraction) value used when processing payments through this merchant account.- Parameters:
defaultShopperInteraction-
-
getDescription
public String getDescription()
Your description for the merchant account, maximum 300 characters- Returns:
- description
-
setDescription
public void setDescription(String description)
Your description for the merchant account, maximum 300 characters- Parameters:
description-
-
getId
public String getId()
The unique identifier of the merchant account.- Returns:
- id
-
setId
public void setId(String id)
The unique identifier of the merchant account.- Parameters:
id-
-
getMerchantCity
public String getMerchantCity()
The city where the legal entity of this merchant account is registered.- Returns:
- merchantCity
-
setMerchantCity
public void setMerchantCity(String merchantCity)
The city where the legal entity of this merchant account is registered.- Parameters:
merchantCity-
-
getName
public String getName()
The name of the legal entity associated with the merchant account.- Returns:
- name
-
setName
public void setName(String name)
The name of the legal entity associated with the merchant account.- Parameters:
name-
-
getPricingPlan
public String getPricingPlan()
Only applies to merchant accounts managed by Adyen's partners. The name of the pricing plan assigned to the merchant account.- Returns:
- pricingPlan
-
setPricingPlan
public void setPricingPlan(String pricingPlan)
Only applies to merchant accounts managed by Adyen's partners. The name of the pricing plan assigned to the merchant account.- Parameters:
pricingPlan-
-
primarySettlementCurrency
public Merchant primarySettlementCurrency(String primarySettlementCurrency)
-
getPrimarySettlementCurrency
public String getPrimarySettlementCurrency()
The currency of the country where the legal entity of this merchant account is registered. Format: [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, a legal entity based in the United States has USD as the primary settlement currency.- Returns:
- primarySettlementCurrency
-
setPrimarySettlementCurrency
public void setPrimarySettlementCurrency(String primarySettlementCurrency)
The currency of the country where the legal entity of this merchant account is registered. Format: [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, a legal entity based in the United States has USD as the primary settlement currency.- Parameters:
primarySettlementCurrency-
-
getReference
public String getReference()
Reference of the merchant account.- Returns:
- reference
-
setReference
public void setReference(String reference)
Reference of the merchant account.- Parameters:
reference-
-
getShopWebAddress
public String getShopWebAddress()
The URL for the ecommerce website used with this merchant account.- Returns:
- shopWebAddress
-
setShopWebAddress
public void setShopWebAddress(String shopWebAddress)
The URL for the ecommerce website used with this merchant account.- Parameters:
shopWebAddress-
-
getStatus
public String getStatus()
The status of the merchant account. Possible values: * **PreActive**: The merchant account has been created. Users cannot access the merchant account in the Customer Area. The account cannot process payments. * **Active**: Users can access the merchant account in the Customer Area. If the company account is also **Active**, then payment processing and payouts are enabled. * **InactiveWithModifications**: Users can access the merchant account in the Customer Area. You cannot process new payments but you can still modify payments, for example issue refunds. You can still receive payouts. * **Inactive**: Users can access the merchant account in the Customer Area. Payment processing and payouts are disabled. * **Closed**: The account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled.- Returns:
- status
-
setStatus
public void setStatus(String status)
The status of the merchant account. Possible values: * **PreActive**: The merchant account has been created. Users cannot access the merchant account in the Customer Area. The account cannot process payments. * **Active**: Users can access the merchant account in the Customer Area. If the company account is also **Active**, then payment processing and payouts are enabled. * **InactiveWithModifications**: Users can access the merchant account in the Customer Area. You cannot process new payments but you can still modify payments, for example issue refunds. You can still receive payouts. * **Inactive**: Users can access the merchant account in the Customer Area. Payment processing and payouts are disabled. * **Closed**: The account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled.- Parameters:
status-
-
equals
public boolean equals(Object o)
Return true if this Merchant object is equal to o.
-
fromJson
public static Merchant fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of Merchant given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of Merchant
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to Merchant
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of Merchant to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-