Package com.adyen.model.payment
Class TechnicalCancelRequest
- java.lang.Object
-
- com.adyen.model.payment.TechnicalCancelRequest
-
public class TechnicalCancelRequest extends Object
TechnicalCancelRequest
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ADDITIONAL_DATAstatic StringJSON_PROPERTY_MERCHANT_ACCOUNTstatic StringJSON_PROPERTY_MODIFICATION_AMOUNTstatic StringJSON_PROPERTY_MPI_DATAstatic StringJSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCEstatic StringJSON_PROPERTY_PLATFORM_CHARGEBACK_LOGICstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_SPLITSstatic StringJSON_PROPERTY_TENDER_REFERENCEstatic StringJSON_PROPERTY_UNIQUE_TERMINAL_ID
-
Constructor Summary
Constructors Constructor Description TechnicalCancelRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TechnicalCancelRequestadditionalData(Map<String,String> additionalData)This field contains additional data, which may be required for a particular modification request.TechnicalCancelRequestaddSplitsItem(Split splitsItem)booleanequals(Object o)Return true if this TechnicalCancelRequest object is equal to o.static TechnicalCancelRequestfromJson(String jsonString)Create an instance of TechnicalCancelRequest given an JSON stringMap<String,String>getAdditionalData()This field contains additional data, which may be required for a particular modification request.StringgetMerchantAccount()The merchant account that is used to process the payment.AmountgetModificationAmount()modificationAmountThreeDSecureDatagetMpiData()mpiDataStringgetOriginalMerchantReference()The original merchant reference to cancel.PlatformChargebackLogicgetPlatformChargebackLogic()platformChargebackLogicStringgetReference()Your reference for the payment modification.List<Split>getSplits()An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.StringgetTenderReference()The transaction reference provided by the PED.StringgetUniqueTerminalId()Unique terminal ID for the PED that originally processed the request.inthashCode()TechnicalCancelRequestmerchantAccount(String merchantAccount)The merchant account that is used to process the payment.TechnicalCancelRequestmodificationAmount(Amount modificationAmount)modificationAmountTechnicalCancelRequestmpiData(ThreeDSecureData mpiData)mpiDataTechnicalCancelRequestoriginalMerchantReference(String originalMerchantReference)The original merchant reference to cancel.TechnicalCancelRequestplatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)platformChargebackLogicTechnicalCancelRequestputAdditionalDataItem(String key, String additionalDataItem)TechnicalCancelRequestreference(String reference)Your reference for the payment modification.voidsetAdditionalData(Map<String,String> additionalData)This field contains additional data, which may be required for a particular modification request.voidsetMerchantAccount(String merchantAccount)The merchant account that is used to process the payment.voidsetModificationAmount(Amount modificationAmount)modificationAmountvoidsetMpiData(ThreeDSecureData mpiData)mpiDatavoidsetOriginalMerchantReference(String originalMerchantReference)The original merchant reference to cancel.voidsetPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)platformChargebackLogicvoidsetReference(String reference)Your reference for the payment modification.voidsetSplits(List<Split> splits)An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.voidsetTenderReference(String tenderReference)The transaction reference provided by the PED.voidsetUniqueTerminalId(String uniqueTerminalId)Unique terminal ID for the PED that originally processed the request.TechnicalCancelRequestsplits(List<Split> splits)An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.TechnicalCancelRequesttenderReference(String tenderReference)The transaction reference provided by the PED.StringtoJson()Convert an instance of TechnicalCancelRequest to an JSON stringStringtoString()TechnicalCancelRequestuniqueTerminalId(String uniqueTerminalId)Unique terminal ID for the PED that originally processed the request.
-
-
-
Field Detail
-
JSON_PROPERTY_ADDITIONAL_DATA
public static final String JSON_PROPERTY_ADDITIONAL_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ACCOUNT
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MODIFICATION_AMOUNT
public static final String JSON_PROPERTY_MODIFICATION_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MPI_DATA
public static final String JSON_PROPERTY_MPI_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE
public static final String JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
public static final String JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SPLITS
public static final String JSON_PROPERTY_SPLITS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TENDER_REFERENCE
public static final String JSON_PROPERTY_TENDER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_UNIQUE_TERMINAL_ID
public static final String JSON_PROPERTY_UNIQUE_TERMINAL_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
additionalData
public TechnicalCancelRequest additionalData(Map<String,String> additionalData)
This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.- Parameters:
additionalData-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
putAdditionalDataItem
public TechnicalCancelRequest putAdditionalDataItem(String key, String additionalDataItem)
-
getAdditionalData
public Map<String,String> getAdditionalData()
This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.- Returns:
- additionalData
-
setAdditionalData
public void setAdditionalData(Map<String,String> additionalData)
This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.- Parameters:
additionalData-
-
merchantAccount
public TechnicalCancelRequest merchantAccount(String merchantAccount)
The merchant account that is used to process the payment.- Parameters:
merchantAccount-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
getMerchantAccount
public String getMerchantAccount()
The merchant account that is used to process the payment.- Returns:
- merchantAccount
-
setMerchantAccount
public void setMerchantAccount(String merchantAccount)
The merchant account that is used to process the payment.- Parameters:
merchantAccount-
-
modificationAmount
public TechnicalCancelRequest modificationAmount(Amount modificationAmount)
modificationAmount- Parameters:
modificationAmount-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
getModificationAmount
public Amount getModificationAmount()
modificationAmount- Returns:
- modificationAmount
-
setModificationAmount
public void setModificationAmount(Amount modificationAmount)
modificationAmount- Parameters:
modificationAmount-
-
mpiData
public TechnicalCancelRequest mpiData(ThreeDSecureData mpiData)
mpiData- Parameters:
mpiData-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
getMpiData
public ThreeDSecureData getMpiData()
mpiData- Returns:
- mpiData
-
setMpiData
public void setMpiData(ThreeDSecureData mpiData)
mpiData- Parameters:
mpiData-
-
originalMerchantReference
public TechnicalCancelRequest originalMerchantReference(String originalMerchantReference)
The original merchant reference to cancel.- Parameters:
originalMerchantReference-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
getOriginalMerchantReference
public String getOriginalMerchantReference()
The original merchant reference to cancel.- Returns:
- originalMerchantReference
-
setOriginalMerchantReference
public void setOriginalMerchantReference(String originalMerchantReference)
The original merchant reference to cancel.- Parameters:
originalMerchantReference-
-
platformChargebackLogic
public TechnicalCancelRequest platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
platformChargebackLogic- Parameters:
platformChargebackLogic-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
getPlatformChargebackLogic
public PlatformChargebackLogic getPlatformChargebackLogic()
platformChargebackLogic- Returns:
- platformChargebackLogic
-
setPlatformChargebackLogic
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
platformChargebackLogic- Parameters:
platformChargebackLogic-
-
reference
public TechnicalCancelRequest reference(String reference)
Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.- Parameters:
reference-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
getReference
public String getReference()
Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.- Returns:
- reference
-
setReference
public void setReference(String reference)
Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.- Parameters:
reference-
-
splits
public TechnicalCancelRequest splits(List<Split> splits)
An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).- Parameters:
splits-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
addSplitsItem
public TechnicalCancelRequest addSplitsItem(Split splitsItem)
-
getSplits
public List<Split> getSplits()
An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).- Returns:
- splits
-
setSplits
public void setSplits(List<Split> splits)
An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).- Parameters:
splits-
-
tenderReference
public TechnicalCancelRequest tenderReference(String tenderReference)
The transaction reference provided by the PED. For point-of-sale integrations only.- Parameters:
tenderReference-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
getTenderReference
public String getTenderReference()
The transaction reference provided by the PED. For point-of-sale integrations only.- Returns:
- tenderReference
-
setTenderReference
public void setTenderReference(String tenderReference)
The transaction reference provided by the PED. For point-of-sale integrations only.- Parameters:
tenderReference-
-
uniqueTerminalId
public TechnicalCancelRequest uniqueTerminalId(String uniqueTerminalId)
Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.- Parameters:
uniqueTerminalId-- Returns:
- the current
TechnicalCancelRequestinstance, allowing for method chaining
-
getUniqueTerminalId
public String getUniqueTerminalId()
Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.- Returns:
- uniqueTerminalId
-
setUniqueTerminalId
public void setUniqueTerminalId(String uniqueTerminalId)
Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.- Parameters:
uniqueTerminalId-
-
equals
public boolean equals(Object o)
Return true if this TechnicalCancelRequest object is equal to o.
-
fromJson
public static TechnicalCancelRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of TechnicalCancelRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of TechnicalCancelRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to TechnicalCancelRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of TechnicalCancelRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-