java.lang.Object
- com.adyen.model.payment.CancelRequest

public class CancelRequest
extends Object

CancelRequest

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ADDITIONAL_DATA`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_MPI_DATA`
`static String`	`JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE`
`static String`	`JSON_PROPERTY_ORIGINAL_REFERENCE`
`static String`	`JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_SPLITS`
`static String`	`JSON_PROPERTY_TENDER_REFERENCE`
`static String`	`JSON_PROPERTY_UNIQUE_TERMINAL_ID`

Constructor Summary

Constructors
Constructor Description

CancelRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CancelRequest`	`additionalData(Map<String,String> additionalData)`
`CancelRequest`	`addSplitsItem(Split splitsItem)`
`boolean`	`equals(Object o)`	Return true if this CancelRequest object is equal to o.
`static CancelRequest`	`fromJson(String jsonString)`	Create an instance of CancelRequest given an JSON string
`Map<String,String>`	`getAdditionalData()`	This field contains additional data, which may be required for a particular modification request.
`String`	`getMerchantAccount()`	The merchant account that is used to process the payment.
`ThreeDSecureData`	`getMpiData()`	Get mpiData
`String`	`getOriginalMerchantReference()`	The original merchant reference to cancel.
`String`	`getOriginalReference()`	The original pspReference of the payment to modify.
`PlatformChargebackLogic`	`getPlatformChargebackLogic()`	Get platformChargebackLogic
`String`	`getReference()`	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.
`String`	`getTenderReference()`	The transaction reference provided by the PED.
`String`	`getUniqueTerminalId()`	Unique terminal ID for the PED that originally processed the request.
`int`	`hashCode()`
`CancelRequest`	`merchantAccount(String merchantAccount)`
`CancelRequest`	`mpiData(ThreeDSecureData mpiData)`
`CancelRequest`	`originalMerchantReference(String originalMerchantReference)`
`CancelRequest`	`originalReference(String originalReference)`
`CancelRequest`	`platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)`
`CancelRequest`	`putAdditionalDataItem(String key, String additionalDataItem)`
`CancelRequest`	`reference(String reference)`
`void`	`setAdditionalData(Map<String,String> additionalData)`	This field contains additional data, which may be required for a particular modification request.
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account that is used to process the payment.
`void`	`setMpiData(ThreeDSecureData mpiData)`	mpiData
`void`	`setOriginalMerchantReference(String originalMerchantReference)`	The original merchant reference to cancel.
`void`	`setOriginalReference(String originalReference)`	The original pspReference of the payment to modify.
`void`	`setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)`	platformChargebackLogic
`void`	`setReference(String reference)`	Your reference for the payment modification.
`void`	`setSplits(List<Split> splits)`	An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.
`void`	`setTenderReference(String tenderReference)`	The transaction reference provided by the PED.
`void`	`setUniqueTerminalId(String uniqueTerminalId)`	Unique terminal ID for the PED that originally processed the request.
`CancelRequest`	`splits(List<Split> splits)`
`CancelRequest`	`tenderReference(String tenderReference)`
`String`	`toJson()`	Convert an instance of CancelRequest to an JSON string
`String`	`toString()`
`CancelRequest`	`uniqueTerminalId(String uniqueTerminalId)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 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_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_ORIGINAL_REFERENCE
```
public static final String JSON_PROPERTY_ORIGINAL_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
- Constructor Detail
  - CancelRequest
```
public CancelRequest()
```
- Method Detail
  - additionalData
```
public CancelRequest additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public CancelRequest 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 CancelRequest merchantAccount(String merchantAccount)
```
  - 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 -
  - mpiData
```
public CancelRequest mpiData(ThreeDSecureData mpiData)
```
  - getMpiData
```
public ThreeDSecureData getMpiData()
```
    Get mpiData
    
    Returns:
    
    mpiData
  - setMpiData
```
public void setMpiData(ThreeDSecureData mpiData)
```
    mpiData
    
    Parameters:
    
    mpiData -
  - originalMerchantReference
```
public CancelRequest originalMerchantReference(String originalMerchantReference)
```
  - 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 -
  - originalReference
```
public CancelRequest originalReference(String originalReference)
```
  - getOriginalReference
```
public String getOriginalReference()
```
    The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification
    
    Returns:
    
    originalReference
  - setOriginalReference
```
public void setOriginalReference(String originalReference)
```
    The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification
    
    Parameters:
    
    originalReference -
  - platformChargebackLogic
```
public CancelRequest platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
  - getPlatformChargebackLogic
```
public PlatformChargebackLogic getPlatformChargebackLogic()
```
    Get platformChargebackLogic
    
    Returns:
    
    platformChargebackLogic
  - setPlatformChargebackLogic
```
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
    platformChargebackLogic
    
    Parameters:
    
    platformChargebackLogic -
  - reference
```
public CancelRequest reference(String reference)
```
  - 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 CancelRequest splits(List<Split> splits)
```
  - addSplitsItem
```
public CancelRequest 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 CancelRequest tenderReference(String tenderReference)
```
  - 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 CancelRequest uniqueTerminalId(String uniqueTerminalId)
```
  - 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 CancelRequest object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static CancelRequest fromJson(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of CancelRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CancelRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CancelRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of CancelRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class CancelRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ADDITIONAL_DATA

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_MPI_DATA

JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE

JSON_PROPERTY_ORIGINAL_REFERENCE

JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_SPLITS

JSON_PROPERTY_TENDER_REFERENCE

JSON_PROPERTY_UNIQUE_TERMINAL_ID

Constructor Detail

CancelRequest

Method Detail

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

merchantAccount

getMerchantAccount

setMerchantAccount

mpiData

getMpiData

setMpiData

originalMerchantReference

getOriginalMerchantReference

setOriginalMerchantReference

originalReference

getOriginalReference

setOriginalReference

platformChargebackLogic

getPlatformChargebackLogic

setPlatformChargebackLogic

reference

getReference

setReference

splits

addSplitsItem

getSplits

setSplits

tenderReference

getTenderReference

setTenderReference

uniqueTerminalId

getUniqueTerminalId

setUniqueTerminalId

equals

hashCode

toString

fromJson

toJson