Package com.adyen.model.checkout

Class PaymentRefundRequest

  • public class PaymentRefundRequest
extends Object
    PaymentRefundRequest

    • Constructor Detail

      • PaymentRefundRequest

        public PaymentRefundRequest()

    • Method Detail

      • amount

        public PaymentRefundRequest amount​(Amount amount)
        amount
        Parameters:
        amount -
        Returns:
        the current PaymentRefundRequest instance, allowing for method chaining

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

        public void setAmount​(Amount amount)
        amount
        Parameters:
        amount -

      • applicationInfo

        public PaymentRefundRequest applicationInfo​(ApplicationInfo applicationInfo)
        applicationInfo
        Parameters:
        applicationInfo -
        Returns:
        the current PaymentRefundRequest instance, allowing for method chaining

      • getApplicationInfo

        public ApplicationInfo getApplicationInfo()
        Get applicationInfo
        Returns:
        applicationInfo

      • setApplicationInfo

        public void setApplicationInfo​(ApplicationInfo applicationInfo)
        applicationInfo
        Parameters:
        applicationInfo -

      • capturePspReference

        public PaymentRefundRequest capturePspReference​(String capturePspReference)
        This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund.
        Parameters:
        capturePspReference - This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund.
        Returns:
        the current PaymentRefundRequest instance, allowing for method chaining

      • getCapturePspReference

        public String getCapturePspReference()
        This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund.
        Returns:
        capturePspReference This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund.

      • setCapturePspReference

        public void setCapturePspReference​(String capturePspReference)
        This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund.
        Parameters:
        capturePspReference - This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund.

      • enhancedSchemeData

        public PaymentRefundRequest enhancedSchemeData​(EnhancedSchemeData enhancedSchemeData)
        enhancedSchemeData
        Parameters:
        enhancedSchemeData -
        Returns:
        the current PaymentRefundRequest instance, allowing for method chaining

      • getEnhancedSchemeData

        public EnhancedSchemeData getEnhancedSchemeData()
        Get enhancedSchemeData
        Returns:
        enhancedSchemeData

      • setEnhancedSchemeData

        public void setEnhancedSchemeData​(EnhancedSchemeData enhancedSchemeData)
        enhancedSchemeData
        Parameters:
        enhancedSchemeData -

      • lineItems

        public PaymentRefundRequest 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 - 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:
        the current PaymentRefundRequest instance, allowing for method chaining

      • 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 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.

      • 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 - 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.

      • merchantAccount

        public PaymentRefundRequest merchantAccount​(String merchantAccount)
        The merchant account that is used to process the payment.
        Parameters:
        merchantAccount - The merchant account that is used to process the payment.
        Returns:
        the current PaymentRefundRequest instance, allowing for method chaining

      • getMerchantAccount

        public String getMerchantAccount()
        The merchant account that is used to process the payment.
        Returns:
        merchantAccount The merchant account that is used to process the payment.

      • setMerchantAccount

        public void setMerchantAccount​(String merchantAccount)
        The merchant account that is used to process the payment.
        Parameters:
        merchantAccount - The merchant account that is used to process the payment.

      • merchantRefundReason

        public PaymentRefundRequest merchantRefundReason​(PaymentRefundRequest.MerchantRefundReasonEnum merchantRefundReason)
        The reason for the refund request. Possible values: * **FRAUD** * **CUSTOMER REQUEST** * **RETURN** * **DUPLICATE** * **OTHER**
        Parameters:
        merchantRefundReason - The reason for the refund request. Possible values: * **FRAUD** * **CUSTOMER REQUEST** * **RETURN** * **DUPLICATE** * **OTHER**
        Returns:
        the current PaymentRefundRequest instance, allowing for method chaining

      • getMerchantRefundReason

        public PaymentRefundRequest.MerchantRefundReasonEnum getMerchantRefundReason()
        The reason for the refund request. Possible values: * **FRAUD** * **CUSTOMER REQUEST** * **RETURN** * **DUPLICATE** * **OTHER**
        Returns:
        merchantRefundReason The reason for the refund request. Possible values: * **FRAUD** * **CUSTOMER REQUEST** * **RETURN** * **DUPLICATE** * **OTHER**

      • setMerchantRefundReason

        public void setMerchantRefundReason​(PaymentRefundRequest.MerchantRefundReasonEnum merchantRefundReason)
        The reason for the refund request. Possible values: * **FRAUD** * **CUSTOMER REQUEST** * **RETURN** * **DUPLICATE** * **OTHER**
        Parameters:
        merchantRefundReason - The reason for the refund request. Possible values: * **FRAUD** * **CUSTOMER REQUEST** * **RETURN** * **DUPLICATE** * **OTHER**

      • reference

        public PaymentRefundRequest reference​(String reference)
        Your reference for the refund request. Maximum length: 80 characters.
        Parameters:
        reference - Your reference for the refund request. Maximum length: 80 characters.
        Returns:
        the current PaymentRefundRequest instance, allowing for method chaining

      • getReference

        public String getReference()
        Your reference for the refund request. Maximum length: 80 characters.
        Returns:
        reference Your reference for the refund request. Maximum length: 80 characters.

      • setReference

        public void setReference​(String reference)
        Your reference for the refund request. Maximum length: 80 characters.
        Parameters:
        reference - Your reference for the refund request. Maximum length: 80 characters.

      • splits

        public PaymentRefundRequest 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 - 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:
        the current PaymentRefundRequest instance, allowing for method chaining

      • 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 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/).

      • 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 - 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/).

      • store

        public PaymentRefundRequest 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 - 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:
        the current PaymentRefundRequest 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 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.

      • 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 - 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.

      • includeNullValues

        public PaymentRefundRequest includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • equals

        public boolean equals​(Object o)
        Return true if this PaymentRefundRequest object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • fromJson

        public static PaymentRefundRequest fromJson​(String jsonString)
                                     throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of PaymentRefundRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of PaymentRefundRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentRefundRequest

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of PaymentRefundRequest to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException