Package com.adyen.model.checkout

Class PaymentVerificationResponse

  • public class PaymentVerificationResponse
extends Object
    PaymentVerificationResponse

    • Constructor Detail

      • PaymentVerificationResponse

        public PaymentVerificationResponse()

    • Method Detail

      • getAdditionalData

        public Map<String,​String> getAdditionalData()
        Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.
        Returns:
        additionalData

      • setAdditionalData

        public void setAdditionalData​(Map<String,​String> additionalData)
        Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.
        Parameters:
        additionalData -

      • getFraudResult

        public FraudResult getFraudResult()
        Get fraudResult
        Returns:
        fraudResult

      • setFraudResult

        public void setFraudResult​(FraudResult fraudResult)
        fraudResult
        Parameters:
        fraudResult -

      • getMerchantReference

        public String getMerchantReference()
        A unique value that you provided in the initial `/paymentSession` request as a `reference` field.
        Returns:
        merchantReference

      • setMerchantReference

        public void setMerchantReference​(String merchantReference)
        A unique value that you provided in the initial `/paymentSession` request as a `reference` field.
        Parameters:
        merchantReference -

      • getPspReference

        public String getPspReference()
        Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
        Returns:
        pspReference

      • setPspReference

        public void setPspReference​(String pspReference)
        Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
        Parameters:
        pspReference -

      • getRefusalReason

        public String getRefusalReason()
        If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
        Returns:
        refusalReason

      • setRefusalReason

        public void setRefusalReason​(String refusalReason)
        If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
        Parameters:
        refusalReason -

      • getRefusalReasonCode

        public String getRefusalReasonCode()
        Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
        Returns:
        refusalReasonCode

      • setRefusalReasonCode

        public void setRefusalReasonCode​(String refusalReasonCode)
        Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
        Parameters:
        refusalReasonCode -

      • getResultCode

        public PaymentVerificationResponse.ResultCodeEnum getResultCode()
        The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.
        Returns:
        resultCode

      • setResultCode

        public void setResultCode​(PaymentVerificationResponse.ResultCodeEnum resultCode)
        The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.
        Parameters:
        resultCode -

      • getServiceError

        public ServiceErrorDetails getServiceError()
        Get serviceError
        Returns:
        serviceError

      • setServiceError

        public void setServiceError​(ServiceErrorDetails serviceError)
        serviceError
        Parameters:
        serviceError -

      • getShopperLocale

        public String getShopperLocale()
        The shopperLocale value provided in the payment request.
        Returns:
        shopperLocale

      • setShopperLocale

        public void setShopperLocale​(String shopperLocale)
        The shopperLocale value provided in the payment request.
        Parameters:
        shopperLocale -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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