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

public class PaymentRefundResponse
extends Object

PaymentRefundResponse

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PaymentRefundResponse.MerchantRefundReasonEnum`	Your reason for the refund request.
`static class`	`PaymentRefundResponse.StatusEnum`	The status of your request.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_CAPTURE_PSP_REFERENCE`
`static String`	`JSON_PROPERTY_LINE_ITEMS`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_MERCHANT_REFUND_REASON`
`static String`	`JSON_PROPERTY_PAYMENT_PSP_REFERENCE`
`static String`	`JSON_PROPERTY_PSP_REFERENCE`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_SPLITS`
`static String`	`JSON_PROPERTY_STATUS`
`static String`	`JSON_PROPERTY_STORE`

Constructor Summary

Constructors
Constructor Description

PaymentRefundResponse()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentRefundResponse`	`addLineItemsItem(LineItem lineItemsItem)`
`PaymentRefundResponse`	`addSplitsItem(Split splitsItem)`
`PaymentRefundResponse`	`amount(Amount amount)`	amount
`PaymentRefundResponse`	`capturePspReference(String capturePspReference)`	This is only available for PayPal refunds.
`boolean`	`equals(Object o)`	Return true if this PaymentRefundResponse object is equal to o.
`static PaymentRefundResponse`	`fromJson(String jsonString)`	Create an instance of PaymentRefundResponse given an JSON string
`Amount`	`getAmount()`	Get amount
`String`	`getCapturePspReference()`	This is only available for PayPal refunds.
`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.
`PaymentRefundResponse.MerchantRefundReasonEnum`	`getMerchantRefundReason()`	Your reason for the refund request.
`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.
`PaymentRefundResponse.StatusEnum`	`getStatus()`	The status of your request.
`String`	`getStore()`	The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund.
`int`	`hashCode()`
`PaymentRefundResponse`	`lineItems(List<LineItem> lineItems)`	Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
`PaymentRefundResponse`	`merchantAccount(String merchantAccount)`	The merchant account that is used to process the payment.
`PaymentRefundResponse`	`merchantRefundReason(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)`	Your reason for the refund request.
`PaymentRefundResponse`	`paymentPspReference(String paymentPspReference)`	The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
`PaymentRefundResponse`	`pspReference(String pspReference)`	Adyen's 16-character reference associated with the refund request.
`PaymentRefundResponse`	`reference(String reference)`	Your reference for the refund request.
`void`	`setAmount(Amount amount)`	amount
`void`	`setCapturePspReference(String capturePspReference)`	This is only available for PayPal refunds.
`void`	`setLineItems(List<LineItem> lineItems)`	Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account that is used to process the payment.
`void`	`setMerchantRefundReason(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)`	Your reason for the refund request.
`void`	`setPaymentPspReference(String paymentPspReference)`	The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
`void`	`setPspReference(String pspReference)`	Adyen's 16-character reference associated with the refund request.
`void`	`setReference(String reference)`	Your reference for the refund request.
`void`	`setSplits(List<Split> splits)`	An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.
`void`	`setStatus(PaymentRefundResponse.StatusEnum status)`	The status of your request.
`void`	`setStore(String store)`	The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund.
`PaymentRefundResponse`	`splits(List<Split> splits)`	An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.
`PaymentRefundResponse`	`status(PaymentRefundResponse.StatusEnum status)`	The status of your request.
`PaymentRefundResponse`	`store(String store)`	The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund.
`String`	`toJson()`	Convert an instance of PaymentRefundResponse to an JSON string
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CAPTURE_PSP_REFERENCE
```
public static final String JSON_PROPERTY_CAPTURE_PSP_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LINE_ITEMS
```
public static final String JSON_PROPERTY_LINE_ITEMS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_REFUND_REASON
```
public static final String JSON_PROPERTY_MERCHANT_REFUND_REASON
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAYMENT_PSP_REFERENCE
```
public static final String JSON_PROPERTY_PAYMENT_PSP_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PSP_REFERENCE
```
public static final String JSON_PROPERTY_PSP_REFERENCE
```
    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_STATUS
```
public static final String JSON_PROPERTY_STATUS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STORE
```
public static final String JSON_PROPERTY_STORE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaymentRefundResponse
```
public PaymentRefundResponse()
```
- Method Detail
  - amount
```
public PaymentRefundResponse amount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - capturePspReference
```
public PaymentRefundResponse capturePspReference(String capturePspReference)
```
    This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the specific capture to refund.
    
    Parameters:
    
    capturePspReference -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - getCapturePspReference
```
public String getCapturePspReference()
```
    This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the specific capture to refund.
    
    Returns:
    
    capturePspReference
  - setCapturePspReference
```
public void setCapturePspReference(String capturePspReference)
```
    This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the specific capture to refund.
    
    Parameters:
    
    capturePspReference -
  - lineItems
```
public PaymentRefundResponse lineItems(List<LineItem> lineItems)
```
    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.
    
    Parameters:
    
    lineItems -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - addLineItemsItem
```
public PaymentRefundResponse 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)
```
    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.
    
    Parameters:
    
    lineItems -
  - merchantAccount
```
public PaymentRefundResponse merchantAccount(String merchantAccount)
```
    The merchant account that is used to process the payment.
    
    Parameters:
    
    merchantAccount -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - 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 -
  - merchantRefundReason
```
public PaymentRefundResponse merchantRefundReason(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)
```
    Your reason for the refund request.
    
    Parameters:
    
    merchantRefundReason -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - getMerchantRefundReason
```
public PaymentRefundResponse.MerchantRefundReasonEnum getMerchantRefundReason()
```
    Your reason for the refund request.
    
    Returns:
    
    merchantRefundReason
  - setMerchantRefundReason
```
public void setMerchantRefundReason(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)
```
    Your reason for the refund request.
    
    Parameters:
    
    merchantRefundReason -
  - paymentPspReference
```
public PaymentRefundResponse paymentPspReference(String paymentPspReference)
```
    The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
    
    Parameters:
    
    paymentPspReference -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - 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)
```
    The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
    
    Parameters:
    
    paymentPspReference -
  - pspReference
```
public PaymentRefundResponse pspReference(String pspReference)
```
    Adyen's 16-character reference associated with the refund request.
    
    Parameters:
    
    pspReference -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - getPspReference
```
public String getPspReference()
```
    Adyen's 16-character reference associated with the refund request.
    
    Returns:
    
    pspReference
  - setPspReference
```
public void setPspReference(String pspReference)
```
    Adyen's 16-character reference associated with the refund request.
    
    Parameters:
    
    pspReference -
  - reference
```
public PaymentRefundResponse reference(String reference)
```
    Your reference for the refund request.
    
    Parameters:
    
    reference -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - getReference
```
public String getReference()
```
    Your reference for the refund request.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
    Your reference for the refund request.
    
    Parameters:
    
    reference -
  - splits
```
public PaymentRefundResponse splits(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 process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/).
    
    Parameters:
    
    splits -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - addSplitsItem
```
public PaymentRefundResponse 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 process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/).
    
    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 process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/).
    
    Parameters:
    
    splits -
  - status
```
public PaymentRefundResponse status(PaymentRefundResponse.StatusEnum status)
```
    The status of your request. This will always have the value **received**.
    
    Parameters:
    
    status -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - getStatus
```
public PaymentRefundResponse.StatusEnum getStatus()
```
    The status of your request. This will always have the value **received**.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(PaymentRefundResponse.StatusEnum status)
```
    The status of your request. This will always have the value **received**.
    
    Parameters:
    
    status -
  - store
```
public PaymentRefundResponse store(String store)
```
    The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as the store name configured in your Customer Area. Otherwise, you get an error and the refund fails.
    
    Parameters:
    
    store -
    
    Returns:
    
    the current PaymentRefundResponse instance, allowing for method chaining
  - getStore
```
public String getStore()
```
    The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as the store name configured in your Customer Area. Otherwise, you get an error and the refund fails.
    
    Returns:
    
    store
  - setStore
```
public void setStore(String store)
```
    The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as the store name configured in your Customer Area. Otherwise, you get an error and the refund fails.
    
    Parameters:
    
    store -
  - equals
```
public boolean equals(Object o)
```
    Return true if this PaymentRefundResponse 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 PaymentRefundResponse fromJson(String jsonString)
                                      throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of PaymentRefundResponse given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentRefundResponse
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentRefundResponse
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of PaymentRefundResponse to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class PaymentRefundResponse

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_CAPTURE_PSP_REFERENCE

JSON_PROPERTY_LINE_ITEMS

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_MERCHANT_REFUND_REASON

JSON_PROPERTY_PAYMENT_PSP_REFERENCE

JSON_PROPERTY_PSP_REFERENCE

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_SPLITS

JSON_PROPERTY_STATUS

JSON_PROPERTY_STORE

Constructor Detail

PaymentRefundResponse

Method Detail

amount

getAmount

setAmount

capturePspReference

getCapturePspReference

setCapturePspReference

lineItems

addLineItemsItem

getLineItems

setLineItems

merchantAccount

getMerchantAccount

setMerchantAccount

merchantRefundReason

getMerchantRefundReason

setMerchantRefundReason

paymentPspReference

getPaymentPspReference

setPaymentPspReference

pspReference

getPspReference

setPspReference

reference

getReference

setReference

splits

addSplitsItem

getSplits

setSplits

status

getStatus

setStatus

store

getStore

setStore

equals

hashCode

toString

fromJson

toJson