Class ResponseAdditionalDataCommon


  • public class ResponseAdditionalDataCommon
    extends Object
    ResponseAdditionalDataCommon
    • Constructor Detail

      • ResponseAdditionalDataCommon

        public ResponseAdditionalDataCommon()
    • Method Detail

      • acquirerAccountCode

        public ResponseAdditionalDataCommon acquirerAccountCode​(String acquirerAccountCode)
        The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions.
        Parameters:
        acquirerAccountCode -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAcquirerAccountCode

        public String getAcquirerAccountCode()
        The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions.
        Returns:
        acquirerAccountCode
      • setAcquirerAccountCode

        public void setAcquirerAccountCode​(String acquirerAccountCode)
        The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions.
        Parameters:
        acquirerAccountCode -
      • acquirerCode

        public ResponseAdditionalDataCommon acquirerCode​(String acquirerCode)
        The name of the acquirer processing the payment request. Example: TestPmmAcquirer
        Parameters:
        acquirerCode -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAcquirerCode

        public String getAcquirerCode()
        The name of the acquirer processing the payment request. Example: TestPmmAcquirer
        Returns:
        acquirerCode
      • setAcquirerCode

        public void setAcquirerCode​(String acquirerCode)
        The name of the acquirer processing the payment request. Example: TestPmmAcquirer
        Parameters:
        acquirerCode -
      • acquirerReference

        public ResponseAdditionalDataCommon acquirerReference​(String acquirerReference)
        The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9
        Parameters:
        acquirerReference -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAcquirerReference

        public String getAcquirerReference()
        The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9
        Returns:
        acquirerReference
      • setAcquirerReference

        public void setAcquirerReference​(String acquirerReference)
        The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9
        Parameters:
        acquirerReference -
      • alias

        public ResponseAdditionalDataCommon alias​(String alias)
        The Adyen alias of the card. Example: H167852639363479
        Parameters:
        alias -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAlias

        public String getAlias()
        The Adyen alias of the card. Example: H167852639363479
        Returns:
        alias
      • setAlias

        public void setAlias​(String alias)
        The Adyen alias of the card. Example: H167852639363479
        Parameters:
        alias -
      • aliasType

        public ResponseAdditionalDataCommon aliasType​(String aliasType)
        The type of the card alias. Example: Default
        Parameters:
        aliasType -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAliasType

        public String getAliasType()
        The type of the card alias. Example: Default
        Returns:
        aliasType
      • setAliasType

        public void setAliasType​(String aliasType)
        The type of the card alias. Example: Default
        Parameters:
        aliasType -
      • authCode

        public ResponseAdditionalDataCommon 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. Example: 58747
        Parameters:
        authCode -
        Returns:
        the current ResponseAdditionalDataCommon 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. Example: 58747
        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. Example: 58747
        Parameters:
        authCode -
      • authorisationMid

        public ResponseAdditionalDataCommon authorisationMid​(String authorisationMid)
        Merchant ID known by the acquirer.
        Parameters:
        authorisationMid -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAuthorisationMid

        public String getAuthorisationMid()
        Merchant ID known by the acquirer.
        Returns:
        authorisationMid
      • setAuthorisationMid

        public void setAuthorisationMid​(String authorisationMid)
        Merchant ID known by the acquirer.
        Parameters:
        authorisationMid -
      • authorisedAmountCurrency

        public ResponseAdditionalDataCommon authorisedAmountCurrency​(String authorisedAmountCurrency)
        The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
        Parameters:
        authorisedAmountCurrency -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAuthorisedAmountCurrency

        public String getAuthorisedAmountCurrency()
        The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
        Returns:
        authorisedAmountCurrency
      • setAuthorisedAmountCurrency

        public void setAuthorisedAmountCurrency​(String authorisedAmountCurrency)
        The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
        Parameters:
        authorisedAmountCurrency -
      • authorisedAmountValue

        public ResponseAdditionalDataCommon authorisedAmountValue​(String authorisedAmountValue)
        Value of the amount authorised. This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
        Parameters:
        authorisedAmountValue -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAuthorisedAmountValue

        public String getAuthorisedAmountValue()
        Value of the amount authorised. This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
        Returns:
        authorisedAmountValue
      • setAuthorisedAmountValue

        public void setAuthorisedAmountValue​(String authorisedAmountValue)
        Value of the amount authorised. This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
        Parameters:
        authorisedAmountValue -
      • avsResult

        public ResponseAdditionalDataCommon avsResult​(String avsResult)
        The AVS result code of the payment, which provides information about the outcome of the AVS check. For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs).
        Parameters:
        avsResult -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAvsResult

        public String getAvsResult()
        The AVS result code of the payment, which provides information about the outcome of the AVS check. For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs).
        Returns:
        avsResult
      • setAvsResult

        public void setAvsResult​(String avsResult)
        The AVS result code of the payment, which provides information about the outcome of the AVS check. For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs).
        Parameters:
        avsResult -
      • avsResultRaw

        public ResponseAdditionalDataCommon avsResultRaw​(String avsResultRaw)
        Raw AVS result received from the acquirer, where available. Example: D
        Parameters:
        avsResultRaw -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getAvsResultRaw

        public String getAvsResultRaw()
        Raw AVS result received from the acquirer, where available. Example: D
        Returns:
        avsResultRaw
      • setAvsResultRaw

        public void setAvsResultRaw​(String avsResultRaw)
        Raw AVS result received from the acquirer, where available. Example: D
        Parameters:
        avsResultRaw -
      • bic

        public ResponseAdditionalDataCommon bic​(String bic)
        BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions.
        Parameters:
        bic -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getBic

        public String getBic()
        BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions.
        Returns:
        bic
      • setBic

        public void setBic​(String bic)
        BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions.
        Parameters:
        bic -
      • coBrandedWith

        public ResponseAdditionalDataCommon coBrandedWith​(String coBrandedWith)
        Includes the co-branded card information.
        Parameters:
        coBrandedWith -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getCoBrandedWith

        public String getCoBrandedWith()
        Includes the co-branded card information.
        Returns:
        coBrandedWith
      • setCoBrandedWith

        public void setCoBrandedWith​(String coBrandedWith)
        Includes the co-branded card information.
        Parameters:
        coBrandedWith -
      • cvcResult

        public ResponseAdditionalDataCommon cvcResult​(String cvcResult)
        The result of CVC verification.
        Parameters:
        cvcResult -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getCvcResult

        public String getCvcResult()
        The result of CVC verification.
        Returns:
        cvcResult
      • setCvcResult

        public void setCvcResult​(String cvcResult)
        The result of CVC verification.
        Parameters:
        cvcResult -
      • cvcResultRaw

        public ResponseAdditionalDataCommon cvcResultRaw​(String cvcResultRaw)
        The raw result of CVC verification.
        Parameters:
        cvcResultRaw -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getCvcResultRaw

        public String getCvcResultRaw()
        The raw result of CVC verification.
        Returns:
        cvcResultRaw
      • setCvcResultRaw

        public void setCvcResultRaw​(String cvcResultRaw)
        The raw result of CVC verification.
        Parameters:
        cvcResultRaw -
      • dsTransID

        public ResponseAdditionalDataCommon dsTransID​(String dsTransID)
        Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.
        Parameters:
        dsTransID -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getDsTransID

        public String getDsTransID()
        Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.
        Returns:
        dsTransID
      • setDsTransID

        public void setDsTransID​(String dsTransID)
        Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.
        Parameters:
        dsTransID -
      • eci

        public ResponseAdditionalDataCommon eci​(String eci)
        The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02
        Parameters:
        eci -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getEci

        public String getEci()
        The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02
        Returns:
        eci
      • setEci

        public void setEci​(String eci)
        The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02
        Parameters:
        eci -
      • expiryDate

        public ResponseAdditionalDataCommon expiryDate​(String expiryDate)
        The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment.
        Parameters:
        expiryDate -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getExpiryDate

        public String getExpiryDate()
        The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment.
        Returns:
        expiryDate
      • setExpiryDate

        public void setExpiryDate​(String expiryDate)
        The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment.
        Parameters:
        expiryDate -
      • extraCostsCurrency

        public ResponseAdditionalDataCommon extraCostsCurrency​(String extraCostsCurrency)
        The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR
        Parameters:
        extraCostsCurrency -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getExtraCostsCurrency

        public String getExtraCostsCurrency()
        The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR
        Returns:
        extraCostsCurrency
      • setExtraCostsCurrency

        public void setExtraCostsCurrency​(String extraCostsCurrency)
        The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR
        Parameters:
        extraCostsCurrency -
      • extraCostsValue

        public ResponseAdditionalDataCommon extraCostsValue​(String extraCostsValue)
        The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units.
        Parameters:
        extraCostsValue -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getExtraCostsValue

        public String getExtraCostsValue()
        The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units.
        Returns:
        extraCostsValue
      • setExtraCostsValue

        public void setExtraCostsValue​(String extraCostsValue)
        The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units.
        Parameters:
        extraCostsValue -
      • fraudCheckItemNrFraudCheckname

        public ResponseAdditionalDataCommon fraudCheckItemNrFraudCheckname​(String fraudCheckItemNrFraudCheckname)
        The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.
        Parameters:
        fraudCheckItemNrFraudCheckname -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getFraudCheckItemNrFraudCheckname

        public String getFraudCheckItemNrFraudCheckname()
        The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.
        Returns:
        fraudCheckItemNrFraudCheckname
      • setFraudCheckItemNrFraudCheckname

        public void setFraudCheckItemNrFraudCheckname​(String fraudCheckItemNrFraudCheckname)
        The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.
        Parameters:
        fraudCheckItemNrFraudCheckname -
      • fraudManualReview

        public ResponseAdditionalDataCommon fraudManualReview​(String fraudManualReview)
        Indicates if the payment is sent to manual review.
        Parameters:
        fraudManualReview -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getFraudManualReview

        public String getFraudManualReview()
        Indicates if the payment is sent to manual review.
        Returns:
        fraudManualReview
      • setFraudManualReview

        public void setFraudManualReview​(String fraudManualReview)
        Indicates if the payment is sent to manual review.
        Parameters:
        fraudManualReview -
      • fundingSource

        public ResponseAdditionalDataCommon fundingSource​(String fundingSource)
        Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.
        Parameters:
        fundingSource -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getFundingSource

        public String getFundingSource()
        Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.
        Returns:
        fundingSource
      • setFundingSource

        public void setFundingSource​(String fundingSource)
        Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.
        Parameters:
        fundingSource -
      • fundsAvailability

        public ResponseAdditionalDataCommon fundsAvailability​(String fundsAvailability)
        Indicates availability of funds. Visa: * \"I\" (fast funds are supported) * \"N\" (otherwise) Mastercard: * \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) * \"N\" (otherwise) > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\".
        Parameters:
        fundsAvailability -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getFundsAvailability

        public String getFundsAvailability()
        Indicates availability of funds. Visa: * \"I\" (fast funds are supported) * \"N\" (otherwise) Mastercard: * \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) * \"N\" (otherwise) > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\".
        Returns:
        fundsAvailability
      • setFundsAvailability

        public void setFundsAvailability​(String fundsAvailability)
        Indicates availability of funds. Visa: * \"I\" (fast funds are supported) * \"N\" (otherwise) Mastercard: * \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) * \"N\" (otherwise) > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\".
        Parameters:
        fundsAvailability -
      • inferredRefusalReason

        public ResponseAdditionalDataCommon inferredRefusalReason​(String inferredRefusalReason)
        Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card
        Parameters:
        inferredRefusalReason -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getInferredRefusalReason

        public String getInferredRefusalReason()
        Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card
        Returns:
        inferredRefusalReason
      • setInferredRefusalReason

        public void setInferredRefusalReason​(String inferredRefusalReason)
        Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card
        Parameters:
        inferredRefusalReason -
      • isCardCommercial

        public ResponseAdditionalDataCommon isCardCommercial​(String isCardCommercial)
        Indicates if the card is used for business purposes only.
        Parameters:
        isCardCommercial -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getIsCardCommercial

        public String getIsCardCommercial()
        Indicates if the card is used for business purposes only.
        Returns:
        isCardCommercial
      • setIsCardCommercial

        public void setIsCardCommercial​(String isCardCommercial)
        Indicates if the card is used for business purposes only.
        Parameters:
        isCardCommercial -
      • issuerCountry

        public ResponseAdditionalDataCommon issuerCountry​(String issuerCountry)
        The issuing country of the card based on the BIN list that Adyen maintains. Example: JP
        Parameters:
        issuerCountry -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getIssuerCountry

        public String getIssuerCountry()
        The issuing country of the card based on the BIN list that Adyen maintains. Example: JP
        Returns:
        issuerCountry
      • setIssuerCountry

        public void setIssuerCountry​(String issuerCountry)
        The issuing country of the card based on the BIN list that Adyen maintains. Example: JP
        Parameters:
        issuerCountry -
      • liabilityShift

        public ResponseAdditionalDataCommon liabilityShift​(String liabilityShift)
        A Boolean value indicating whether a liability shift was offered for this payment.
        Parameters:
        liabilityShift -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getLiabilityShift

        public String getLiabilityShift()
        A Boolean value indicating whether a liability shift was offered for this payment.
        Returns:
        liabilityShift
      • setLiabilityShift

        public void setLiabilityShift​(String liabilityShift)
        A Boolean value indicating whether a liability shift was offered for this payment.
        Parameters:
        liabilityShift -
      • mcBankNetReferenceNumber

        public ResponseAdditionalDataCommon mcBankNetReferenceNumber​(String mcBankNetReferenceNumber)
        The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field.
        Parameters:
        mcBankNetReferenceNumber -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getMcBankNetReferenceNumber

        public String getMcBankNetReferenceNumber()
        The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field.
        Returns:
        mcBankNetReferenceNumber
      • setMcBankNetReferenceNumber

        public void setMcBankNetReferenceNumber​(String mcBankNetReferenceNumber)
        The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field.
        Parameters:
        mcBankNetReferenceNumber -
      • merchantAdviceCode

        public ResponseAdditionalDataCommon merchantAdviceCode​(String merchantAdviceCode)
        The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried. For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).
        Parameters:
        merchantAdviceCode -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getMerchantAdviceCode

        public String getMerchantAdviceCode()
        The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried. For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).
        Returns:
        merchantAdviceCode
      • setMerchantAdviceCode

        public void setMerchantAdviceCode​(String merchantAdviceCode)
        The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried. For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).
        Parameters:
        merchantAdviceCode -
      • merchantReference

        public ResponseAdditionalDataCommon merchantReference​(String merchantReference)
        The reference provided for the transaction.
        Parameters:
        merchantReference -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getMerchantReference

        public String getMerchantReference()
        The reference provided for the transaction.
        Returns:
        merchantReference
      • setMerchantReference

        public void setMerchantReference​(String merchantReference)
        The reference provided for the transaction.
        Parameters:
        merchantReference -
      • networkTxReference

        public ResponseAdditionalDataCommon networkTxReference​(String networkTxReference)
        Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Parameters:
        networkTxReference -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getNetworkTxReference

        public String getNetworkTxReference()
        Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Returns:
        networkTxReference
      • setNetworkTxReference

        public void setNetworkTxReference​(String networkTxReference)
        Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID.
        Parameters:
        networkTxReference -
      • ownerName

        public ResponseAdditionalDataCommon ownerName​(String ownerName)
        The owner name of a bank account. Only relevant for SEPA Direct Debit transactions.
        Parameters:
        ownerName -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getOwnerName

        public String getOwnerName()
        The owner name of a bank account. Only relevant for SEPA Direct Debit transactions.
        Returns:
        ownerName
      • setOwnerName

        public void setOwnerName​(String ownerName)
        The owner name of a bank account. Only relevant for SEPA Direct Debit transactions.
        Parameters:
        ownerName -
      • paymentAccountReference

        public ResponseAdditionalDataCommon paymentAccountReference​(String paymentAccountReference)
        The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters.
        Parameters:
        paymentAccountReference -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getPaymentAccountReference

        public String getPaymentAccountReference()
        The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters.
        Returns:
        paymentAccountReference
      • setPaymentAccountReference

        public void setPaymentAccountReference​(String paymentAccountReference)
        The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters.
        Parameters:
        paymentAccountReference -
      • paymentMethod

        public ResponseAdditionalDataCommon paymentMethod​(String paymentMethod)
        The payment method used in the transaction.
        Parameters:
        paymentMethod -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getPaymentMethod

        public String getPaymentMethod()
        The payment method used in the transaction.
        Returns:
        paymentMethod
      • setPaymentMethod

        public void setPaymentMethod​(String paymentMethod)
        The payment method used in the transaction.
        Parameters:
        paymentMethod -
      • paymentMethodVariant

        public ResponseAdditionalDataCommon paymentMethodVariant​(String paymentMethodVariant)
        The Adyen sub-variant of the payment method used for the payment request. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). Example: mcpro
        Parameters:
        paymentMethodVariant -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getPaymentMethodVariant

        public String getPaymentMethodVariant()
        The Adyen sub-variant of the payment method used for the payment request. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). Example: mcpro
        Returns:
        paymentMethodVariant
      • setPaymentMethodVariant

        public void setPaymentMethodVariant​(String paymentMethodVariant)
        The Adyen sub-variant of the payment method used for the payment request. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). Example: mcpro
        Parameters:
        paymentMethodVariant -
      • payoutEligible

        public ResponseAdditionalDataCommon payoutEligible​(String payoutEligible)
        Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown)
        Parameters:
        payoutEligible -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getPayoutEligible

        public String getPayoutEligible()
        Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown)
        Returns:
        payoutEligible
      • setPayoutEligible

        public void setPayoutEligible​(String payoutEligible)
        Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown)
        Parameters:
        payoutEligible -
      • realtimeAccountUpdaterStatus

        public ResponseAdditionalDataCommon realtimeAccountUpdaterStatus​(String realtimeAccountUpdaterStatus)
        The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder
        Parameters:
        realtimeAccountUpdaterStatus -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getRealtimeAccountUpdaterStatus

        public String getRealtimeAccountUpdaterStatus()
        The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder
        Returns:
        realtimeAccountUpdaterStatus
      • setRealtimeAccountUpdaterStatus

        public void setRealtimeAccountUpdaterStatus​(String realtimeAccountUpdaterStatus)
        The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder
        Parameters:
        realtimeAccountUpdaterStatus -
      • receiptFreeText

        public ResponseAdditionalDataCommon receiptFreeText​(String receiptFreeText)
        Message to be displayed on the terminal.
        Parameters:
        receiptFreeText -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getReceiptFreeText

        public String getReceiptFreeText()
        Message to be displayed on the terminal.
        Returns:
        receiptFreeText
      • setReceiptFreeText

        public void setReceiptFreeText​(String receiptFreeText)
        Message to be displayed on the terminal.
        Parameters:
        receiptFreeText -
      • recurringContractTypes

        public ResponseAdditionalDataCommon recurringContractTypes​(String recurringContractTypes)
        The recurring contract types applicable to the transaction.
        Parameters:
        recurringContractTypes -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getRecurringContractTypes

        public String getRecurringContractTypes()
        The recurring contract types applicable to the transaction.
        Returns:
        recurringContractTypes
      • setRecurringContractTypes

        public void setRecurringContractTypes​(String recurringContractTypes)
        The recurring contract types applicable to the transaction.
        Parameters:
        recurringContractTypes -
      • recurringFirstPspReference

        public ResponseAdditionalDataCommon recurringFirstPspReference​(String recurringFirstPspReference)
        The `pspReference`, of the first recurring payment that created the recurring detail. This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.
        Parameters:
        recurringFirstPspReference -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getRecurringFirstPspReference

        public String getRecurringFirstPspReference()
        The `pspReference`, of the first recurring payment that created the recurring detail. This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.
        Returns:
        recurringFirstPspReference
      • setRecurringFirstPspReference

        public void setRecurringFirstPspReference​(String recurringFirstPspReference)
        The `pspReference`, of the first recurring payment that created the recurring detail. This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.
        Parameters:
        recurringFirstPspReference -
      • recurringRecurringDetailReference

        public ResponseAdditionalDataCommon recurringRecurringDetailReference​(String recurringRecurringDetailReference)
        The reference that uniquely identifies the recurring transaction.
        Parameters:
        recurringRecurringDetailReference -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getRecurringRecurringDetailReference

        public String getRecurringRecurringDetailReference()
        The reference that uniquely identifies the recurring transaction.
        Returns:
        recurringRecurringDetailReference
      • setRecurringRecurringDetailReference

        public void setRecurringRecurringDetailReference​(String recurringRecurringDetailReference)
        The reference that uniquely identifies the recurring transaction.
        Parameters:
        recurringRecurringDetailReference -
      • recurringShopperReference

        public ResponseAdditionalDataCommon recurringShopperReference​(String recurringShopperReference)
        The provided reference of the shopper for a recurring transaction.
        Parameters:
        recurringShopperReference -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getRecurringShopperReference

        public String getRecurringShopperReference()
        The provided reference of the shopper for a recurring transaction.
        Returns:
        recurringShopperReference
      • setRecurringShopperReference

        public void setRecurringShopperReference​(String recurringShopperReference)
        The provided reference of the shopper for a recurring transaction.
        Parameters:
        recurringShopperReference -
      • referred

        public ResponseAdditionalDataCommon referred​(String referred)
        If the payment is referred, this field is set to true. This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. Example: true
        Parameters:
        referred -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getReferred

        public String getReferred()
        If the payment is referred, this field is set to true. This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. Example: true
        Returns:
        referred
      • setReferred

        public void setReferred​(String referred)
        If the payment is referred, this field is set to true. This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. Example: true
        Parameters:
        referred -
      • refusalReasonRaw

        public ResponseAdditionalDataCommon refusalReasonRaw​(String refusalReasonRaw)
        Raw refusal reason received from the acquirer, where available. Example: AUTHORISED
        Parameters:
        refusalReasonRaw -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getRefusalReasonRaw

        public String getRefusalReasonRaw()
        Raw refusal reason received from the acquirer, where available. Example: AUTHORISED
        Returns:
        refusalReasonRaw
      • setRefusalReasonRaw

        public void setRefusalReasonRaw​(String refusalReasonRaw)
        Raw refusal reason received from the acquirer, where available. Example: AUTHORISED
        Parameters:
        refusalReasonRaw -
      • requestAmount

        public ResponseAdditionalDataCommon requestAmount​(String requestAmount)
        The amount of the payment request.
        Parameters:
        requestAmount -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getRequestAmount

        public String getRequestAmount()
        The amount of the payment request.
        Returns:
        requestAmount
      • setRequestAmount

        public void setRequestAmount​(String requestAmount)
        The amount of the payment request.
        Parameters:
        requestAmount -
      • requestCurrencyCode

        public ResponseAdditionalDataCommon requestCurrencyCode​(String requestCurrencyCode)
        The currency of the payment request.
        Parameters:
        requestCurrencyCode -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getRequestCurrencyCode

        public String getRequestCurrencyCode()
        The currency of the payment request.
        Returns:
        requestCurrencyCode
      • setRequestCurrencyCode

        public void setRequestCurrencyCode​(String requestCurrencyCode)
        The currency of the payment request.
        Parameters:
        requestCurrencyCode -
      • shopperInteraction

        public ResponseAdditionalDataCommon shopperInteraction​(String shopperInteraction)
        The shopper interaction type of the payment request. Example: Ecommerce
        Parameters:
        shopperInteraction -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getShopperInteraction

        public String getShopperInteraction()
        The shopper interaction type of the payment request. Example: Ecommerce
        Returns:
        shopperInteraction
      • setShopperInteraction

        public void setShopperInteraction​(String shopperInteraction)
        The shopper interaction type of the payment request. Example: Ecommerce
        Parameters:
        shopperInteraction -
      • shopperReference

        public ResponseAdditionalDataCommon shopperReference​(String shopperReference)
        The shopperReference passed in the payment request. Example: AdyenTestShopperXX
        Parameters:
        shopperReference -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getShopperReference

        public String getShopperReference()
        The shopperReference passed in the payment request. Example: AdyenTestShopperXX
        Returns:
        shopperReference
      • setShopperReference

        public void setShopperReference​(String shopperReference)
        The shopperReference passed in the payment request. Example: AdyenTestShopperXX
        Parameters:
        shopperReference -
      • terminalId

        public ResponseAdditionalDataCommon terminalId​(String terminalId)
        The terminal ID used in a point-of-sale payment. Example: 06022622
        Parameters:
        terminalId -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getTerminalId

        public String getTerminalId()
        The terminal ID used in a point-of-sale payment. Example: 06022622
        Returns:
        terminalId
      • setTerminalId

        public void setTerminalId​(String terminalId)
        The terminal ID used in a point-of-sale payment. Example: 06022622
        Parameters:
        terminalId -
      • threeDAuthenticated

        public ResponseAdditionalDataCommon threeDAuthenticated​(String threeDAuthenticated)
        A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
        Parameters:
        threeDAuthenticated -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getThreeDAuthenticated

        public String getThreeDAuthenticated()
        A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
        Returns:
        threeDAuthenticated
      • setThreeDAuthenticated

        public void setThreeDAuthenticated​(String threeDAuthenticated)
        A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
        Parameters:
        threeDAuthenticated -
      • threeDAuthenticatedResponse

        public ResponseAdditionalDataCommon threeDAuthenticatedResponse​(String threeDAuthenticatedResponse)
        The raw 3DS authentication result from the card issuer. Example: N
        Parameters:
        threeDAuthenticatedResponse -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getThreeDAuthenticatedResponse

        public String getThreeDAuthenticatedResponse()
        The raw 3DS authentication result from the card issuer. Example: N
        Returns:
        threeDAuthenticatedResponse
      • setThreeDAuthenticatedResponse

        public void setThreeDAuthenticatedResponse​(String threeDAuthenticatedResponse)
        The raw 3DS authentication result from the card issuer. Example: N
        Parameters:
        threeDAuthenticatedResponse -
      • threeDOffered

        public ResponseAdditionalDataCommon threeDOffered​(String threeDOffered)
        A Boolean value indicating whether 3DS was offered for this payment. Example: true
        Parameters:
        threeDOffered -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getThreeDOffered

        public String getThreeDOffered()
        A Boolean value indicating whether 3DS was offered for this payment. Example: true
        Returns:
        threeDOffered
      • setThreeDOffered

        public void setThreeDOffered​(String threeDOffered)
        A Boolean value indicating whether 3DS was offered for this payment. Example: true
        Parameters:
        threeDOffered -
      • threeDOfferedResponse

        public ResponseAdditionalDataCommon threeDOfferedResponse​(String threeDOfferedResponse)
        The raw enrollment result from the 3DS directory services of the card schemes. Example: Y
        Parameters:
        threeDOfferedResponse -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getThreeDOfferedResponse

        public String getThreeDOfferedResponse()
        The raw enrollment result from the 3DS directory services of the card schemes. Example: Y
        Returns:
        threeDOfferedResponse
      • setThreeDOfferedResponse

        public void setThreeDOfferedResponse​(String threeDOfferedResponse)
        The raw enrollment result from the 3DS directory services of the card schemes. Example: Y
        Parameters:
        threeDOfferedResponse -
      • threeDSVersion

        public ResponseAdditionalDataCommon threeDSVersion​(String threeDSVersion)
        The 3D Secure 2 version.
        Parameters:
        threeDSVersion -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getThreeDSVersion

        public String getThreeDSVersion()
        The 3D Secure 2 version.
        Returns:
        threeDSVersion
      • setThreeDSVersion

        public void setThreeDSVersion​(String threeDSVersion)
        The 3D Secure 2 version.
        Parameters:
        threeDSVersion -
      • visaTransactionId

        public ResponseAdditionalDataCommon visaTransactionId​(String visaTransactionId)
        The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field.
        Parameters:
        visaTransactionId -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getVisaTransactionId

        public String getVisaTransactionId()
        The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field.
        Returns:
        visaTransactionId
      • setVisaTransactionId

        public void setVisaTransactionId​(String visaTransactionId)
        The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field.
        Parameters:
        visaTransactionId -
      • xid

        public ResponseAdditionalDataCommon xid​(String xid)
        The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. Example: ODgxNDc2MDg2MDExODk5MAAAAAA=
        Parameters:
        xid -
        Returns:
        the current ResponseAdditionalDataCommon instance, allowing for method chaining
      • getXid

        public String getXid()
        The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. Example: ODgxNDc2MDg2MDExODk5MAAAAAA=
        Returns:
        xid
      • setXid

        public void setXid​(String xid)
        The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. Example: ODgxNDc2MDg2MDExODk5MAAAAAA=
        Parameters:
        xid -
      • equals

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

        public int hashCode()
        Overrides:
        hashCode in class Object
      • fromJson

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

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