Package com.adyen.model.payments

Class RefundRequest

java.lang.Object

com.adyen.model.payments.RefundRequest

public class RefundRequest
extends Object

RefundRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RefundRequest.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_MODIFICATION_AMOUNT
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_SPLITS
static String	SERIALIZED_NAME_TENDER_REFERENCE
static String	SERIALIZED_NAME_UNIQUE_TERMINAL_ID

Constructor Summary

Constructors

Constructor	Description
RefundRequest()

Method Summary

Modifier and Type	Method	Description
RefundRequest	additionalData(Map<String,String> additionalData)
RefundRequest	addSplitsItem(Split splitsItem)
boolean	equals(Object o)
static RefundRequest	fromJson(String jsonString)	Create an instance of RefundRequest 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.
Amount	getModificationAmount()	Get modificationAmount
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.
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()
RefundRequest	merchantAccount(String merchantAccount)
RefundRequest	modificationAmount(Amount modificationAmount)
RefundRequest	mpiData(ThreeDSecureData mpiData)
RefundRequest	originalMerchantReference(String originalMerchantReference)
RefundRequest	originalReference(String originalReference)
RefundRequest	putAdditionalDataItem(String key, String additionalDataItem)
RefundRequest	reference(String reference)
void	setAdditionalData(Map<String,String> additionalData)
void	setMerchantAccount(String merchantAccount)
void	setModificationAmount(Amount modificationAmount)
void	setMpiData(ThreeDSecureData mpiData)
void	setOriginalMerchantReference(String originalMerchantReference)
void	setOriginalReference(String originalReference)
void	setReference(String reference)
void	setSplits(List<Split> splits)
void	setTenderReference(String tenderReference)
void	setUniqueTerminalId(String uniqueTerminalId)
RefundRequest	splits(List<Split> splits)
RefundRequest	tenderReference(String tenderReference)
String	toJson()	Convert an instance of RefundRequest to an JSON string
String	toString()
RefundRequest	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_MODIFICATION_AMOUNT

public static final String SERIALIZED_NAME_MODIFICATION_AMOUNT

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_SPLITS

public static final String SERIALIZED_NAME_SPLITS

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

RefundRequest

public RefundRequest()

Method Detail

additionalData

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

putAdditionalDataItem

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

modificationAmount

public RefundRequest modificationAmount(Amount modificationAmount)

getModificationAmount

public Amount getModificationAmount()

Get modificationAmount

Returns:

modificationAmount

setModificationAmount

public void setModificationAmount(Amount modificationAmount)

mpiData

public RefundRequest mpiData(ThreeDSecureData mpiData)

getMpiData

public ThreeDSecureData getMpiData()

Get mpiData

Returns:

mpiData

setMpiData

public void setMpiData(ThreeDSecureData mpiData)

originalMerchantReference

public RefundRequest originalMerchantReference(String originalMerchantReference)

getOriginalMerchantReference

public String getOriginalMerchantReference()

The original merchant reference to cancel.

Returns:

originalMerchantReference

setOriginalMerchantReference

public void setOriginalMerchantReference(String originalMerchantReference)

originalReference

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

splits

public RefundRequest splits(List<Split> splits)

addSplitsItem

public RefundRequest 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 details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).

Returns:

splits

setSplits

public void setSplits(List<Split> splits)

tenderReference

public RefundRequest 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 RefundRequest 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 RefundRequest

fromJson

public static RefundRequest fromJson(String jsonString)
                              throws IOException

Create an instance of RefundRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RefundRequest

Throws:

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

toJson

public String toJson()

Convert an instance of RefundRequest to an JSON string

Returns:

JSON string