java.lang.Object
- com.adyen.model.checkout.CreatePaymentRefundRequest

public class CreatePaymentRefundRequest
extends Object

CreatePaymentRefundRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`CreatePaymentRefundRequest.CustomTypeAdapterFactory`
`static class`	`CreatePaymentRefundRequest.MerchantRefundReasonEnum`	Your reason for the refund request

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_LINE_ITEMS`
`static String`	`SERIALIZED_NAME_MERCHANT_ACCOUNT`
`static String`	`SERIALIZED_NAME_MERCHANT_REFUND_REASON`
`static String`	`SERIALIZED_NAME_REFERENCE`
`static String`	`SERIALIZED_NAME_SPLITS`

Constructor Summary

Constructors
Constructor Description

CreatePaymentRefundRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CreatePaymentRefundRequest`	`addLineItemsItem(LineItem lineItemsItem)`
`CreatePaymentRefundRequest`	`addSplitsItem(Split splitsItem)`
`CreatePaymentRefundRequest`	`amount(Amount amount)`
`boolean`	`equals(Object o)`
`static CreatePaymentRefundRequest`	`fromJson(String jsonString)`	Create an instance of CreatePaymentRefundRequest given an JSON string
`Amount`	`getAmount()`	Get amount
`List<LineItem>`	`getLineItems()`	Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
`String`	`getMerchantAccount()`	The merchant account that is used to process the payment.
`CreatePaymentRefundRequest.MerchantRefundReasonEnum`	`getMerchantRefundReason()`	Your reason for the refund request
`String`	`getReference()`	Your reference for the refund request.
`List<Split>`	`getSplits()`	An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.
`int`	`hashCode()`
`CreatePaymentRefundRequest`	`lineItems(List<LineItem> lineItems)`
`CreatePaymentRefundRequest`	`merchantAccount(String merchantAccount)`
`CreatePaymentRefundRequest`	`merchantRefundReason(CreatePaymentRefundRequest.MerchantRefundReasonEnum merchantRefundReason)`
`CreatePaymentRefundRequest`	`reference(String reference)`
`void`	`setAmount(Amount amount)`
`void`	`setLineItems(List<LineItem> lineItems)`
`void`	`setMerchantAccount(String merchantAccount)`
`void`	`setMerchantRefundReason(CreatePaymentRefundRequest.MerchantRefundReasonEnum merchantRefundReason)`
`void`	`setReference(String reference)`
`void`	`setSplits(List<Split> splits)`
`CreatePaymentRefundRequest`	`splits(List<Split> splits)`
`String`	`toJson()`	Convert an instance of CreatePaymentRefundRequest to an JSON string
`String`	`toString()`
`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_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:: Constant Field Values

SERIALIZED_NAME_LINE_ITEMS

public static final String SERIALIZED_NAME_LINE_ITEMS

See Also:: Constant Field Values

SERIALIZED_NAME_MERCHANT_ACCOUNT

public static final String SERIALIZED_NAME_MERCHANT_ACCOUNT

See Also:: Constant Field Values

SERIALIZED_NAME_MERCHANT_REFUND_REASON

public static final String SERIALIZED_NAME_MERCHANT_REFUND_REASON

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail
- CreatePaymentRefundRequest
```
public CreatePaymentRefundRequest()
```

Method Detail
- amount
```
public CreatePaymentRefundRequest amount(Amount amount)
```
- getAmount
```
public Amount getAmount()
```
  Get amount
  
  Returns:
  
  amount
- setAmount
```
public void setAmount(Amount amount)
```
- lineItems
```
public CreatePaymentRefundRequest lineItems(List<LineItem> lineItems)
```
- addLineItemsItem
```
public CreatePaymentRefundRequest addLineItemsItem(LineItem lineItemsItem)
```
- getLineItems
```
public List<LineItem> getLineItems()
```
  Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.
  
  Returns:
  
  lineItems
- setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
- merchantAccount
```
public CreatePaymentRefundRequest 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)
```
- merchantRefundReason
```
public CreatePaymentRefundRequest merchantRefundReason(CreatePaymentRefundRequest.MerchantRefundReasonEnum merchantRefundReason)
```
- getMerchantRefundReason
```
public CreatePaymentRefundRequest.MerchantRefundReasonEnum getMerchantRefundReason()
```
  Your reason for the refund request
  
  Returns:
  
  merchantRefundReason
- setMerchantRefundReason
```
public void setMerchantRefundReason(CreatePaymentRefundRequest.MerchantRefundReasonEnum merchantRefundReason)
```
- reference
```
public CreatePaymentRefundRequest reference(String reference)
```
- getReference
```
public String getReference()
```
  Your reference for the refund request. Maximum length: 80 characters.
  
  Returns:
  
  reference
- setReference
```
public void setReference(String reference)
```
- splits
```
public CreatePaymentRefundRequest splits(List<Split> splits)
```
- addSplitsItem
```
public CreatePaymentRefundRequest 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)
```
- 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 CreatePaymentRefundRequest
- fromJson
```
public static CreatePaymentRefundRequest fromJson(String jsonString)
                                           throws IOException
```
  Create an instance of CreatePaymentRefundRequest given an JSON string
  
  Parameters:
  
  jsonString - JSON string
  
  Returns:
  
  An instance of CreatePaymentRefundRequest
  
  Throws:
  
  IOException - if the JSON string is invalid with respect to CreatePaymentRefundRequest
- toJson
```
public String toJson()
```
  Convert an instance of CreatePaymentRefundRequest to an JSON string
  
  Returns:
  
  JSON string

Class CreatePaymentRefundRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_LINE_ITEMS

SERIALIZED_NAME_MERCHANT_ACCOUNT

SERIALIZED_NAME_MERCHANT_REFUND_REASON

SERIALIZED_NAME_REFERENCE

SERIALIZED_NAME_SPLITS

openapiFields

openapiRequiredFields

Constructor Detail

CreatePaymentRefundRequest

Method Detail

amount

getAmount

setAmount

lineItems

addLineItemsItem

getLineItems

setLineItems

merchantAccount

getMerchantAccount

setMerchantAccount

merchantRefundReason

getMerchantRefundReason

setMerchantRefundReason

reference

getReference

setReference

splits

addSplitsItem

getSplits

setSplits

equals

hashCode

toString

validateJsonObject

fromJson

toJson