Package com.adyen.model.payout

Class PayoutResponse

  • public class PayoutResponse
extends Object
    PayoutResponse

    • Constructor Detail

      • PayoutResponse

        public PayoutResponse()

    • Method Detail

      • additionalData

        public PayoutResponse additionalData​(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 -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

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

      • authCode

        public PayoutResponse authCode​(String authCode)
        Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty.
        Parameters:
        authCode -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

      • getAuthCode

        public String getAuthCode()
        Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty.
        Returns:
        authCode

      • setAuthCode

        public void setAuthCode​(String authCode)
        Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty.
        Parameters:
        authCode -

      • dccAmount

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

      • getDccAmount

        public Amount getDccAmount()
        dccAmount
        Returns:
        dccAmount

      • setDccAmount

        public void setDccAmount​(Amount dccAmount)
        dccAmount
        Parameters:
        dccAmount -

      • dccSignature

        public PayoutResponse dccSignature​(String dccSignature)
        Cryptographic signature used to verify `dccQuote`. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
        Parameters:
        dccSignature -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

      • getDccSignature

        public String getDccSignature()
        Cryptographic signature used to verify `dccQuote`. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
        Returns:
        dccSignature

      • setDccSignature

        public void setDccSignature​(String dccSignature)
        Cryptographic signature used to verify `dccQuote`. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
        Parameters:
        dccSignature -

      • fraudResult

        public PayoutResponse fraudResult​(FraudResult fraudResult)
        fraudResult
        Parameters:
        fraudResult -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

      • getFraudResult

        public FraudResult getFraudResult()
        fraudResult
        Returns:
        fraudResult

      • setFraudResult

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

      • issuerUrl

        public PayoutResponse issuerUrl​(String issuerUrl)
        The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL.
        Parameters:
        issuerUrl -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

      • getIssuerUrl

        public String getIssuerUrl()
        The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL.
        Returns:
        issuerUrl

      • setIssuerUrl

        public void setIssuerUrl​(String issuerUrl)
        The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL.
        Parameters:
        issuerUrl -

      • md

        public PayoutResponse md​(String md)
        The payment session.
        Parameters:
        md -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

      • getMd

        public String getMd()
        The payment session.
        Returns:
        md

      • setMd

        public void setMd​(String md)
        The payment session.
        Parameters:
        md -

      • paRequest

        public PayoutResponse paRequest​(String paRequest)
        The 3D request data for the issuer. If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure).
        Parameters:
        paRequest -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

      • getPaRequest

        public String getPaRequest()
        The 3D request data for the issuer. If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure).
        Returns:
        paRequest

      • setPaRequest

        public void setPaRequest​(String paRequest)
        The 3D request data for the issuer. If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure).
        Parameters:
        paRequest -

      • pspReference

        public PayoutResponse pspReference​(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 -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

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

      • refusalReason

        public PayoutResponse refusalReason​(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 -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

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

      • resultCode

        public PayoutResponse resultCode​(PayoutResponse.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 -
        Returns:
        the current PayoutResponse instance, allowing for method chaining

      • getResultCode

        public PayoutResponse.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​(PayoutResponse.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 -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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