Package com.adyen.model.payment

Class CancelOrRefundRequest

  • public class CancelOrRefundRequest
extends Object
    CancelOrRefundRequest

    • Constructor Detail

      • CancelOrRefundRequest

        public CancelOrRefundRequest()

    • Method Detail

      • additionalData

        public CancelOrRefundRequest additionalData​(Map<String,​String> additionalData)
        This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.
        Parameters:
        additionalData - This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.
        Returns:
        the current CancelOrRefundRequest instance, allowing for method chaining

      • getAdditionalData

        public Map<String,​String> getAdditionalData()
        This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.
        Returns:
        additionalData This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.

      • setAdditionalData

        public void setAdditionalData​(Map<String,​String> additionalData)
        This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.
        Parameters:
        additionalData - This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.

      • merchantAccount

        public CancelOrRefundRequest 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 CancelOrRefundRequest 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.

      • mpiData

        public CancelOrRefundRequest mpiData​(ThreeDSecureData mpiData)
        mpiData
        Parameters:
        mpiData -
        Returns:
        the current CancelOrRefundRequest instance, allowing for method chaining

      • getMpiData

        public ThreeDSecureData getMpiData()
        Get mpiData
        Returns:
        mpiData

      • setMpiData

        public void setMpiData​(ThreeDSecureData mpiData)
        mpiData
        Parameters:
        mpiData -

      • originalMerchantReference

        public CancelOrRefundRequest originalMerchantReference​(String originalMerchantReference)
        The original merchant reference to cancel.
        Parameters:
        originalMerchantReference - The original merchant reference to cancel.
        Returns:
        the current CancelOrRefundRequest instance, allowing for method chaining

      • getOriginalMerchantReference

        public String getOriginalMerchantReference()
        The original merchant reference to cancel.
        Returns:
        originalMerchantReference The original merchant reference to cancel.

      • setOriginalMerchantReference

        public void setOriginalMerchantReference​(String originalMerchantReference)
        The original merchant reference to cancel.
        Parameters:
        originalMerchantReference - The original merchant reference to cancel.

      • originalReference

        public CancelOrRefundRequest originalReference​(String originalReference)
        The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification
        Parameters:
        originalReference - The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification
        Returns:
        the current CancelOrRefundRequest instance, allowing for method chaining

      • getOriginalReference

        public String getOriginalReference()
        The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification
        Returns:
        originalReference The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification

      • setOriginalReference

        public void setOriginalReference​(String originalReference)
        The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification
        Parameters:
        originalReference - The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification

      • platformChargebackLogic

        public CancelOrRefundRequest platformChargebackLogic​(PlatformChargebackLogic platformChargebackLogic)
        platformChargebackLogic
        Parameters:
        platformChargebackLogic -
        Returns:
        the current CancelOrRefundRequest instance, allowing for method chaining

      • getPlatformChargebackLogic

        public PlatformChargebackLogic getPlatformChargebackLogic()
        Get platformChargebackLogic
        Returns:
        platformChargebackLogic

      • setPlatformChargebackLogic

        public void setPlatformChargebackLogic​(PlatformChargebackLogic platformChargebackLogic)
        platformChargebackLogic
        Parameters:
        platformChargebackLogic -

      • reference

        public CancelOrRefundRequest reference​(String reference)
        Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.
        Parameters:
        reference - Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.
        Returns:
        the current CancelOrRefundRequest instance, allowing for method chaining

      • getReference

        public String getReference()
        Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.
        Returns:
        reference Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.

      • setReference

        public void setReference​(String reference)
        Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.
        Parameters:
        reference - Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.

      • tenderReference

        public CancelOrRefundRequest tenderReference​(String tenderReference)
        The transaction reference provided by the PED. For point-of-sale integrations only.
        Parameters:
        tenderReference - The transaction reference provided by the PED. For point-of-sale integrations only.
        Returns:
        the current CancelOrRefundRequest instance, allowing for method chaining

      • getTenderReference

        public String getTenderReference()
        The transaction reference provided by the PED. For point-of-sale integrations only.
        Returns:
        tenderReference The transaction reference provided by the PED. For point-of-sale integrations only.

      • setTenderReference

        public void setTenderReference​(String tenderReference)
        The transaction reference provided by the PED. For point-of-sale integrations only.
        Parameters:
        tenderReference - The transaction reference provided by the PED. For point-of-sale integrations only.

      • uniqueTerminalId

        public CancelOrRefundRequest uniqueTerminalId​(String uniqueTerminalId)
        Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.
        Parameters:
        uniqueTerminalId - Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.
        Returns:
        the current CancelOrRefundRequest instance, allowing for method chaining

      • getUniqueTerminalId

        public String getUniqueTerminalId()
        Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.
        Returns:
        uniqueTerminalId Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.

      • setUniqueTerminalId

        public void setUniqueTerminalId​(String uniqueTerminalId)
        Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.
        Parameters:
        uniqueTerminalId - Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.

      • includeNullValues

        public CancelOrRefundRequest 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 CancelOrRefundRequest 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 CancelOrRefundRequest fromJson​(String jsonString)
                                      throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of CancelOrRefundRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CancelOrRefundRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CancelOrRefundRequest

      • toJson

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