Package com.adyen.model.checkout

Class PaymentRefundResponse

  • public class PaymentRefundResponse
extends Object
    PaymentRefundResponse

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

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

      • 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 - 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 PaymentRefundResponse 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 PaymentRefundResponse 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 PaymentRefundResponse 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 PaymentRefundResponse merchantRefundReason​(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)
        Your reason for the refund request.
        Parameters:
        merchantRefundReason - Your reason for the refund request.
        Returns:
        the current PaymentRefundResponse instance, allowing for method chaining

      • setMerchantRefundReason

        public void setMerchantRefundReason​(PaymentRefundResponse.MerchantRefundReasonEnum merchantRefundReason)
        Your reason for the refund request.
        Parameters:
        merchantRefundReason - Your reason for the refund request.

      • 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 - The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.
        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 The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.

      • 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 - The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund.

      • pspReference

        public PaymentRefundResponse pspReference​(String pspReference)
        Adyen's 16-character reference associated with the refund request.
        Parameters:
        pspReference - Adyen's 16-character reference associated with the refund request.
        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 Adyen's 16-character reference associated with the refund request.

      • setPspReference

        public void setPspReference​(String pspReference)
        Adyen's 16-character reference associated with the refund request.
        Parameters:
        pspReference - Adyen's 16-character reference associated with the refund request.

      • reference

        public PaymentRefundResponse reference​(String reference)
        Your reference for the refund request.
        Parameters:
        reference - Your reference for the refund request.
        Returns:
        the current PaymentRefundResponse instance, allowing for method chaining

      • getReference

        public String getReference()
        Your reference for the refund request.
        Returns:
        reference Your reference for the refund request.

      • setReference

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

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

      • status

        public PaymentRefundResponse status​(PaymentRefundResponse.StatusEnum status)
        The status of your request. This will always have the value **received**.
        Parameters:
        status - The status of your request. This will always have the value **received**.
        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 The status of your request. This will always have the value **received**.

      • setStatus

        public void setStatus​(PaymentRefundResponse.StatusEnum status)
        The status of your request. This will always have the value **received**.
        Parameters:
        status - The status of your request. This will always have the value **received**.

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

      • 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

      • 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