Package com.adyen.model.payments

Class CancelOrRefundRequest

java.lang.Object

com.adyen.model.payments.CancelOrRefundRequest

public class CancelOrRefundRequest
extends Object

CancelOrRefundRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CancelOrRefundRequest.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ADDITIONAL_DATA
static String	SERIALIZED_NAME_MERCHANT_ACCOUNT
static String	SERIALIZED_NAME_MPI_DATA
static String	SERIALIZED_NAME_ORIGINAL_MERCHANT_REFERENCE
static String	SERIALIZED_NAME_ORIGINAL_REFERENCE
static String	SERIALIZED_NAME_REFERENCE
static String	SERIALIZED_NAME_TENDER_REFERENCE
static String	SERIALIZED_NAME_UNIQUE_TERMINAL_ID

Constructor Summary

Constructors

Constructor	Description
CancelOrRefundRequest()

Method Summary

Modifier and Type	Method	Description
CancelOrRefundRequest	additionalData(Map<String,String> additionalData)
boolean	equals(Object o)
static CancelOrRefundRequest	fromJson(String jsonString)	Create an instance of CancelOrRefundRequest 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.
String	getReference()	Your reference for the payment modification.
String	getTenderReference()	The transaction reference provided by the PED.
String	getUniqueTerminalId()	Unique terminal ID for the PED that originally processed the request.
int	hashCode()
CancelOrRefundRequest	merchantAccount(String merchantAccount)
CancelOrRefundRequest	mpiData(ThreeDSecureData mpiData)
CancelOrRefundRequest	originalMerchantReference(String originalMerchantReference)
CancelOrRefundRequest	originalReference(String originalReference)
CancelOrRefundRequest	putAdditionalDataItem(String key, String additionalDataItem)
CancelOrRefundRequest	reference(String reference)
void	setAdditionalData(Map<String,String> additionalData)
void	setMerchantAccount(String merchantAccount)
void	setMpiData(ThreeDSecureData mpiData)
void	setOriginalMerchantReference(String originalMerchantReference)
void	setOriginalReference(String originalReference)
void	setReference(String reference)
void	setTenderReference(String tenderReference)
void	setUniqueTerminalId(String uniqueTerminalId)
CancelOrRefundRequest	tenderReference(String tenderReference)
String	toJson()	Convert an instance of CancelOrRefundRequest to an JSON string
String	toString()
CancelOrRefundRequest	uniqueTerminalId(String uniqueTerminalId)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ADDITIONAL_DATA

public static final String SERIALIZED_NAME_ADDITIONAL_DATA

See Also:

Constant Field Values

SERIALIZED_NAME_MERCHANT_ACCOUNT

public static final String SERIALIZED_NAME_MERCHANT_ACCOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_MPI_DATA

public static final String SERIALIZED_NAME_MPI_DATA

See Also:

Constant Field Values

SERIALIZED_NAME_ORIGINAL_MERCHANT_REFERENCE

public static final String SERIALIZED_NAME_ORIGINAL_MERCHANT_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_ORIGINAL_REFERENCE

public static final String SERIALIZED_NAME_ORIGINAL_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_REFERENCE

public static final String SERIALIZED_NAME_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_TENDER_REFERENCE

public static final String SERIALIZED_NAME_TENDER_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_UNIQUE_TERMINAL_ID

public static final String SERIALIZED_NAME_UNIQUE_TERMINAL_ID

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

CancelOrRefundRequest

public CancelOrRefundRequest()

Method Detail

additionalData

public CancelOrRefundRequest additionalData(Map<String,String> additionalData)

putAdditionalDataItem

public CancelOrRefundRequest 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)

merchantAccount

public CancelOrRefundRequest 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)

mpiData

public CancelOrRefundRequest mpiData(ThreeDSecureData mpiData)

getMpiData

public ThreeDSecureData getMpiData()

Get mpiData

Returns:

mpiData

setMpiData

public void setMpiData(ThreeDSecureData mpiData)

originalMerchantReference

public CancelOrRefundRequest originalMerchantReference(String originalMerchantReference)

getOriginalMerchantReference

public String getOriginalMerchantReference()

The original merchant reference to cancel.

Returns:

originalMerchantReference

setOriginalMerchantReference

public void setOriginalMerchantReference(String originalMerchantReference)

originalReference

public CancelOrRefundRequest 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)

reference

public CancelOrRefundRequest 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)

tenderReference

public CancelOrRefundRequest 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)

uniqueTerminalId

public CancelOrRefundRequest 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)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to CancelOrRefundRequest

fromJson

public static CancelOrRefundRequest fromJson(String jsonString)
                                      throws IOException

Create an instance of CancelOrRefundRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CancelOrRefundRequest

Throws:

IOException - if the JSON string is invalid with respect to CancelOrRefundRequest

toJson

public String toJson()

Convert an instance of CancelOrRefundRequest to an JSON string

Returns:

JSON string