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

public class PaymentRefundResource
extends Object

PaymentRefundResource

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PaymentRefundResource.CustomTypeAdapterFactory`
`static class`	`PaymentRefundResource.StatusEnum`	The status of your 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_PAYMENT_PSP_REFERENCE`
`static String`	`SERIALIZED_NAME_PSP_REFERENCE`
`static String`	`SERIALIZED_NAME_REFERENCE`
`static String`	`SERIALIZED_NAME_SPLITS`
`static String`	`SERIALIZED_NAME_STATUS`

Constructor Summary

Constructors
Constructor Description

PaymentRefundResource()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentRefundResource`	`addLineItemsItem(LineItem lineItemsItem)`
`PaymentRefundResource`	`addSplitsItem(Split splitsItem)`
`PaymentRefundResource`	`amount(Amount amount)`
`boolean`	`equals(Object o)`
`static PaymentRefundResource`	`fromJson(String jsonString)`	Create an instance of PaymentRefundResource 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.
`String`	`getPaymentPspReference()`	The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
`String`	`getPspReference()`	Adyen's 16-character reference associated with 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.
`PaymentRefundResource.StatusEnum`	`getStatus()`	The status of your request.
`int`	`hashCode()`
`PaymentRefundResource`	`lineItems(List<LineItem> lineItems)`
`PaymentRefundResource`	`merchantAccount(String merchantAccount)`
`PaymentRefundResource`	`paymentPspReference(String paymentPspReference)`
`PaymentRefundResource`	`pspReference(String pspReference)`
`PaymentRefundResource`	`reference(String reference)`
`void`	`setAmount(Amount amount)`
`void`	`setLineItems(List<LineItem> lineItems)`
`void`	`setMerchantAccount(String merchantAccount)`
`void`	`setPaymentPspReference(String paymentPspReference)`
`void`	`setPspReference(String pspReference)`
`void`	`setReference(String reference)`
`void`	`setSplits(List<Split> splits)`
`void`	`setStatus(PaymentRefundResource.StatusEnum status)`
`PaymentRefundResource`	`splits(List<Split> splits)`
`PaymentRefundResource`	`status(PaymentRefundResource.StatusEnum status)`
`String`	`toJson()`	Convert an instance of PaymentRefundResource 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_PAYMENT_PSP_REFERENCE
```
public static final String SERIALIZED_NAME_PAYMENT_PSP_REFERENCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PSP_REFERENCE
```
public static final String SERIALIZED_NAME_PSP_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_STATUS
```
public static final String SERIALIZED_NAME_STATUS
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - PaymentRefundResource
```
public PaymentRefundResource()
```
- Method Detail
  - amount
```
public PaymentRefundResource amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - lineItems
```
public PaymentRefundResource lineItems(List<LineItem> lineItems)
```
  - addLineItemsItem
```
public PaymentRefundResource 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, Clearpay, Klarna, Ratepay, Zip and Atome.
    
    Returns:
    
    lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
  - merchantAccount
```
public PaymentRefundResource 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)
```
  - paymentPspReference
```
public PaymentRefundResource paymentPspReference(String paymentPspReference)
```
  - getPaymentPspReference
```
public String getPaymentPspReference()
```
    The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
    
    Returns:
    
    paymentPspReference
  - setPaymentPspReference
```
public void setPaymentPspReference(String paymentPspReference)
```
  - pspReference
```
public PaymentRefundResource pspReference(String pspReference)
```
  - getPspReference
```
public String getPspReference()
```
    Adyen's 16-character reference associated with the refund request.
    
    Returns:
    
    pspReference
  - setPspReference
```
public void setPspReference(String pspReference)
```
  - reference
```
public PaymentRefundResource reference(String reference)
```
  - getReference
```
public String getReference()
```
    Your reference for the refund request.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
  - splits
```
public PaymentRefundResource splits(List<Split> splits)
```
  - addSplitsItem
```
public PaymentRefundResource 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)
```
  - status
```
public PaymentRefundResource status(PaymentRefundResource.StatusEnum status)
```
  - getStatus
```
public PaymentRefundResource.StatusEnum getStatus()
```
    The status of your request. This will always have the value **received**.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(PaymentRefundResource.StatusEnum status)
```
  - 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 PaymentRefundResource
  - fromJson
```
public static PaymentRefundResource fromJson(String jsonString)
                                      throws IOException
```
    Create an instance of PaymentRefundResource given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentRefundResource
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to PaymentRefundResource
  - toJson
```
public String toJson()
```
    Convert an instance of PaymentRefundResource to an JSON string
    
    Returns:
    
    JSON string

Class PaymentRefundResource

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_PAYMENT_PSP_REFERENCE

SERIALIZED_NAME_PSP_REFERENCE

SERIALIZED_NAME_REFERENCE

SERIALIZED_NAME_SPLITS

SERIALIZED_NAME_STATUS

openapiFields

openapiRequiredFields

Constructor Detail

PaymentRefundResource

Method Detail

amount

getAmount

setAmount

lineItems

addLineItemsItem

getLineItems

setLineItems

merchantAccount

getMerchantAccount

setMerchantAccount

paymentPspReference

getPaymentPspReference

setPaymentPspReference

pspReference

getPspReference

setPspReference

reference

getReference

setReference

splits

addSplitsItem

getSplits

setSplits

status

getStatus

setStatus

equals

hashCode

toString

validateJsonObject

fromJson

toJson