com.adyen.model.checkout.PaymentRefundResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of adyen-java-api-library Show documentation
Show all versions of adyen-java-api-library Show documentation
Adyen API Client Library for Java
/*
* Adyen Checkout API
*
* The version of the OpenAPI document: 71
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.adyen.model.checkout;
import java.util.Objects;
import java.util.Map;
import java.util.HashMap;
import com.adyen.model.checkout.Amount;
import com.adyen.model.checkout.LineItem;
import com.adyen.model.checkout.Split;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.core.JsonProcessingException;
/**
* PaymentRefundResponse
*/
@JsonPropertyOrder({
PaymentRefundResponse.JSON_PROPERTY_AMOUNT,
PaymentRefundResponse.JSON_PROPERTY_CAPTURE_PSP_REFERENCE,
PaymentRefundResponse.JSON_PROPERTY_LINE_ITEMS,
PaymentRefundResponse.JSON_PROPERTY_MERCHANT_ACCOUNT,
PaymentRefundResponse.JSON_PROPERTY_MERCHANT_REFUND_REASON,
PaymentRefundResponse.JSON_PROPERTY_PAYMENT_PSP_REFERENCE,
PaymentRefundResponse.JSON_PROPERTY_PSP_REFERENCE,
PaymentRefundResponse.JSON_PROPERTY_REFERENCE,
PaymentRefundResponse.JSON_PROPERTY_SPLITS,
PaymentRefundResponse.JSON_PROPERTY_STATUS,
PaymentRefundResponse.JSON_PROPERTY_STORE
})
public class PaymentRefundResponse {
public static final String JSON_PROPERTY_AMOUNT = "amount";
private Amount amount;
public static final String JSON_PROPERTY_CAPTURE_PSP_REFERENCE = "capturePspReference";
private String capturePspReference;
public static final String JSON_PROPERTY_LINE_ITEMS = "lineItems";
private List lineItems;
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT = "merchantAccount";
private String merchantAccount;
/**
* Your reason for the refund request.
*/
public enum MerchantRefundReasonEnum {
FRAUD(String.valueOf("FRAUD")),
CUSTOMER_REQUEST(String.valueOf("CUSTOMER REQUEST")),
RETURN(String.valueOf("RETURN")),
DUPLICATE(String.valueOf("DUPLICATE")),
OTHER(String.valueOf("OTHER"));
private String value;
MerchantRefundReasonEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static MerchantRefundReasonEnum fromValue(String value) {
for (MerchantRefundReasonEnum b : MerchantRefundReasonEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
return null;
}
}
public static final String JSON_PROPERTY_MERCHANT_REFUND_REASON = "merchantRefundReason";
private MerchantRefundReasonEnum merchantRefundReason;
public static final String JSON_PROPERTY_PAYMENT_PSP_REFERENCE = "paymentPspReference";
private String paymentPspReference;
public static final String JSON_PROPERTY_PSP_REFERENCE = "pspReference";
private String pspReference;
public static final String JSON_PROPERTY_REFERENCE = "reference";
private String reference;
public static final String JSON_PROPERTY_SPLITS = "splits";
private List splits;
/**
* The status of your request. This will always have the value **received**.
*/
public enum StatusEnum {
RECEIVED(String.valueOf("received"));
private String value;
StatusEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static StatusEnum fromValue(String value) {
for (StatusEnum b : StatusEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_STATUS = "status";
private StatusEnum status;
public static final String JSON_PROPERTY_STORE = "store";
private String store;
public PaymentRefundResponse() {
}
/**
* amount
*
* @param amount
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse amount(Amount amount) {
this.amount = amount;
return this;
}
/**
* Get amount
* @return amount
*/
@JsonProperty(JSON_PROPERTY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Amount getAmount() {
return amount;
}
/**
* amount
*
* @param amount
*/
@JsonProperty(JSON_PROPERTY_AMOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAmount(Amount amount) {
this.amount = amount;
}
/**
* 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.
*
* @param 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.
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse capturePspReference(String capturePspReference) {
this.capturePspReference = capturePspReference;
return this;
}
/**
* 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.
* @return 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.
*/
@JsonProperty(JSON_PROPERTY_CAPTURE_PSP_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCapturePspReference() {
return 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.
*
* @param 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.
*/
@JsonProperty(JSON_PROPERTY_CAPTURE_PSP_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCapturePspReference(String capturePspReference) {
this.capturePspReference = capturePspReference;
}
/**
* 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.
*
* @param 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.
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse lineItems(List lineItems) {
this.lineItems = lineItems;
return this;
}
public PaymentRefundResponse addLineItemsItem(LineItem lineItemsItem) {
if (this.lineItems == null) {
this.lineItems = new ArrayList<>();
}
this.lineItems.add(lineItemsItem);
return this;
}
/**
* 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.
* @return 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.
*/
@JsonProperty(JSON_PROPERTY_LINE_ITEMS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getLineItems() {
return 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.
*
* @param 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.
*/
@JsonProperty(JSON_PROPERTY_LINE_ITEMS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLineItems(List lineItems) {
this.lineItems = lineItems;
}
/**
* The merchant account that is used to process the payment.
*
* @param merchantAccount The merchant account that is used to process the payment.
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse merchantAccount(String merchantAccount) {
this.merchantAccount = merchantAccount;
return this;
}
/**
* The merchant account that is used to process the payment.
* @return merchantAccount The merchant account that is used to process the payment.
*/
@JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getMerchantAccount() {
return merchantAccount;
}
/**
* The merchant account that is used to process the payment.
*
* @param merchantAccount The merchant account that is used to process the payment.
*/
@JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setMerchantAccount(String merchantAccount) {
this.merchantAccount = merchantAccount;
}
/**
* Your reason for the refund request.
*
* @param merchantRefundReason Your reason for the refund request.
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse merchantRefundReason(MerchantRefundReasonEnum merchantRefundReason) {
this.merchantRefundReason = merchantRefundReason;
return this;
}
/**
* Your reason for the refund request.
* @return merchantRefundReason Your reason for the refund request.
*/
@JsonProperty(JSON_PROPERTY_MERCHANT_REFUND_REASON)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public MerchantRefundReasonEnum getMerchantRefundReason() {
return merchantRefundReason;
}
/**
* Your reason for the refund request.
*
* @param merchantRefundReason Your reason for the refund request.
*/
@JsonProperty(JSON_PROPERTY_MERCHANT_REFUND_REASON)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setMerchantRefundReason(MerchantRefundReasonEnum merchantRefundReason) {
this.merchantRefundReason = merchantRefundReason;
}
/**
* The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
*
* @param paymentPspReference The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse paymentPspReference(String paymentPspReference) {
this.paymentPspReference = paymentPspReference;
return this;
}
/**
* The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
* @return paymentPspReference The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
*/
@JsonProperty(JSON_PROPERTY_PAYMENT_PSP_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getPaymentPspReference() {
return paymentPspReference;
}
/**
* The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
*
* @param paymentPspReference The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
*/
@JsonProperty(JSON_PROPERTY_PAYMENT_PSP_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPaymentPspReference(String paymentPspReference) {
this.paymentPspReference = paymentPspReference;
}
/**
* Adyen's 16-character reference associated with the refund request.
*
* @param pspReference Adyen's 16-character reference associated with the refund request.
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse pspReference(String pspReference) {
this.pspReference = pspReference;
return this;
}
/**
* Adyen's 16-character reference associated with the refund request.
* @return pspReference Adyen's 16-character reference associated with the refund request.
*/
@JsonProperty(JSON_PROPERTY_PSP_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getPspReference() {
return pspReference;
}
/**
* Adyen's 16-character reference associated with the refund request.
*
* @param pspReference Adyen's 16-character reference associated with the refund request.
*/
@JsonProperty(JSON_PROPERTY_PSP_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPspReference(String pspReference) {
this.pspReference = pspReference;
}
/**
* Your reference for the refund request.
*
* @param reference Your reference for the refund request.
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse reference(String reference) {
this.reference = reference;
return this;
}
/**
* Your reference for the refund request.
* @return reference Your reference for the refund request.
*/
@JsonProperty(JSON_PROPERTY_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getReference() {
return reference;
}
/**
* Your reference for the refund request.
*
* @param reference Your reference for the refund request.
*/
@JsonProperty(JSON_PROPERTY_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setReference(String reference) {
this.reference = reference;
}
/**
* 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/).
*
* @param 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/).
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse splits(List splits) {
this.splits = splits;
return this;
}
public PaymentRefundResponse addSplitsItem(Split splitsItem) {
if (this.splits == null) {
this.splits = new ArrayList<>();
}
this.splits.add(splitsItem);
return this;
}
/**
* 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/).
* @return 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/).
*/
@JsonProperty(JSON_PROPERTY_SPLITS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getSplits() {
return 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/).
*
* @param 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/).
*/
@JsonProperty(JSON_PROPERTY_SPLITS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSplits(List splits) {
this.splits = splits;
}
/**
* The status of your request. This will always have the value **received**.
*
* @param status The status of your request. This will always have the value **received**.
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse status(StatusEnum status) {
this.status = status;
return this;
}
/**
* The status of your request. This will always have the value **received**.
* @return status The status of your request. This will always have the value **received**.
*/
@JsonProperty(JSON_PROPERTY_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public StatusEnum getStatus() {
return status;
}
/**
* The status of your request. This will always have the value **received**.
*
* @param status The status of your request. This will always have the value **received**.
*/
@JsonProperty(JSON_PROPERTY_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStatus(StatusEnum status) {
this.status = status;
}
/**
* 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.
*
* @param 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.
* @return the current {@code PaymentRefundResponse} instance, allowing for method chaining
*/
public PaymentRefundResponse store(String store) {
this.store = store;
return this;
}
/**
* 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.
* @return 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.
*/
@JsonProperty(JSON_PROPERTY_STORE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getStore() {
return 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.
*
* @param 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.
*/
@JsonProperty(JSON_PROPERTY_STORE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStore(String store) {
this.store = store;
}
/**
* Return true if this PaymentRefundResponse object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
PaymentRefundResponse paymentRefundResponse = (PaymentRefundResponse) o;
return Objects.equals(this.amount, paymentRefundResponse.amount) &&
Objects.equals(this.capturePspReference, paymentRefundResponse.capturePspReference) &&
Objects.equals(this.lineItems, paymentRefundResponse.lineItems) &&
Objects.equals(this.merchantAccount, paymentRefundResponse.merchantAccount) &&
Objects.equals(this.merchantRefundReason, paymentRefundResponse.merchantRefundReason) &&
Objects.equals(this.paymentPspReference, paymentRefundResponse.paymentPspReference) &&
Objects.equals(this.pspReference, paymentRefundResponse.pspReference) &&
Objects.equals(this.reference, paymentRefundResponse.reference) &&
Objects.equals(this.splits, paymentRefundResponse.splits) &&
Objects.equals(this.status, paymentRefundResponse.status) &&
Objects.equals(this.store, paymentRefundResponse.store);
}
@Override
public int hashCode() {
return Objects.hash(amount, capturePspReference, lineItems, merchantAccount, merchantRefundReason, paymentPspReference, pspReference, reference, splits, status, store);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PaymentRefundResponse {\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" capturePspReference: ").append(toIndentedString(capturePspReference)).append("\n");
sb.append(" lineItems: ").append(toIndentedString(lineItems)).append("\n");
sb.append(" merchantAccount: ").append(toIndentedString(merchantAccount)).append("\n");
sb.append(" merchantRefundReason: ").append(toIndentedString(merchantRefundReason)).append("\n");
sb.append(" paymentPspReference: ").append(toIndentedString(paymentPspReference)).append("\n");
sb.append(" pspReference: ").append(toIndentedString(pspReference)).append("\n");
sb.append(" reference: ").append(toIndentedString(reference)).append("\n");
sb.append(" splits: ").append(toIndentedString(splits)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" store: ").append(toIndentedString(store)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
/**
* Create an instance of PaymentRefundResponse given an JSON string
*
* @param jsonString JSON string
* @return An instance of PaymentRefundResponse
* @throws JsonProcessingException if the JSON string is invalid with respect to PaymentRefundResponse
*/
public static PaymentRefundResponse fromJson(String jsonString) throws JsonProcessingException {
return JSON.getMapper().readValue(jsonString, PaymentRefundResponse.class);
}
/**
* Convert an instance of PaymentRefundResponse to an JSON string
*
* @return JSON string
*/
public String toJson() throws JsonProcessingException {
return JSON.getMapper().writeValueAsString(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy