Package com.adyen.model.checkout

Class PaymentRefundResponse

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_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

Constructor Summary

Constructors

Constructor	Description
PaymentRefundResponse()

Method Summary

Modifier and Type	Method	Description
PaymentRefundResponse	addLineItemsItem(LineItem lineItemsItem)
PaymentRefundResponse	addSplitsItem(Split splitsItem)
PaymentRefundResponse	amount(Amount amount)
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
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.
int	hashCode()
PaymentRefundResponse	lineItems(List<LineItem> lineItems)
PaymentRefundResponse	merchantAccount(String merchantAccount)
PaymentRefundResponse	merchantRefundReason(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)
PaymentRefundResponse	paymentPspReference(String paymentPspReference)
PaymentRefundResponse	pspReference(String pspReference)
PaymentRefundResponse	reference(String reference)
void	setAmount(Amount amount)
void	setLineItems(List<LineItem> lineItems)
void	setMerchantAccount(String merchantAccount)
void	setMerchantRefundReason(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)
void	setPaymentPspReference(String paymentPspReference)
void	setPspReference(String pspReference)
void	setReference(String reference)
void	setSplits(List<Split> splits)
void	setStatus(PaymentRefundResponse.StatusEnum status)
PaymentRefundResponse	splits(List<Split> splits)
PaymentRefundResponse	status(PaymentRefundResponse.StatusEnum status)
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_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

Constructor Detail

PaymentRefundResponse

public PaymentRefundResponse()

Method Detail

amount

public PaymentRefundResponse amount(Amount amount)

getAmount

public Amount getAmount()

Get amount

Returns:

amount

setAmount

public void setAmount(Amount amount)

lineItems

public PaymentRefundResponse lineItems(List<LineItem> lineItems)

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)

merchantAccount

public PaymentRefundResponse 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 PaymentRefundResponse merchantRefundReason(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)

getMerchantRefundReason

public PaymentRefundResponse.MerchantRefundReasonEnum getMerchantRefundReason()

Your reason for the refund request.

Returns:

merchantRefundReason

setMerchantRefundReason

public void setMerchantRefundReason(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)

paymentPspReference

public PaymentRefundResponse 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 PaymentRefundResponse 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 PaymentRefundResponse reference(String reference)

getReference

public String getReference()

Your reference for the refund request.

Returns:

reference

setReference

public void setReference(String reference)

splits

public PaymentRefundResponse splits(List<Split> splits)

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 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 PaymentRefundResponse status(PaymentRefundResponse.StatusEnum status)

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)

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