ResponseAdditionalDataCommon class abstract

ResponseAdditionalDataCommon

Properties:

  • acquirerAccountCode - The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions.
  • acquirerCode - The name of the acquirer processing the payment request. Example: TestPmmAcquirer
  • acquirerReference - The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9
  • alias - The Adyen alias of the card. Example: H167852639363479
  • aliasType - The type of the card alias. Example: Default
  • 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
  • authorisationMid - Merchant ID known by the acquirer.
  • authorisedAmountCurrency - The currency of the authorised amount, as a three-character ISO currency code.
  • authorisedAmountValue - Value of the amount authorised. This amount is represented in minor units according to the following table.
  • avsResult - The AVS result code of the payment, which provides information about the outcome of the AVS check. For possible values, see AVS.
  • avsResultRaw - Raw AVS result received from the acquirer, where available. Example: D
  • bic - BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions.
  • coBrandedWith - Includes the co-branded card information.
  • cvcResult - The result of CVC verification.
  • cvcResultRaw - The raw result of CVC verification.
  • dsTransID - Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.
  • eci - The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02
  • expiryDate - The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment.
  • extraCostsCurrency - The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR
  • 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.
  • fraudCheckLeftSquareBracketItemNrRightSquareBracketLeftSquareBracketFraudChecknameRightSquareBracket - The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.
  • fraudManualReview - Indicates if the payment is sent to manual review.
  • fraudResultType - The fraud result properties of the payment. Possible values: * AMBER * GREEN * RED
  • fraudRiskLevel - The risk level of the transaction as classified by the machine learning fraud risk rule. The risk level indicates the likelihood that a transaction will result in a fraudulent dispute. Possible values: * veryLow * low * medium * high * veryHigh
  • 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.
  • 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".
  • 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
  • isCardCommercial - Indicates if the card is used for business purposes only.
  • issuerCountry - The issuing country of the card based on the BIN list that Adyen maintains. Example: JP
  • liabilityShift - A Boolean value indicating whether a liability shift was offered for this payment.
  • mcBankNetReferenceNumber - The mcBankNetReferenceNumber, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field.
  • 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.
  • merchantReference - The reference provided for the transaction.
  • 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.
  • ownerName - The owner name of a bank account. Only relevant for SEPA Direct Debit transactions.
  • 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.
  • paymentMethod - The payment method used in the transaction.
  • paymentMethodVariant - The Adyen sub-variant of the payment method used for the payment request. For more information, refer to PaymentMethodVariant. Example: mcpro
  • 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)
  • realtimeAccountUpdaterStatus - The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder
  • receiptFreeText - Message to be displayed on the terminal.
  • recurringPeriodContractTypes - The recurring contract types applicable to the transaction.
  • recurringPeriodFirstPspReference - 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.
  • recurringPeriodRecurringDetailReference - The reference that uniquely identifies the recurring transaction.
  • recurringPeriodShopperReference - The provided reference of the shopper for a recurring transaction.
  • recurringProcessingModel - The processing model used for the recurring transaction.
  • 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
  • refusalReasonRaw - Raw refusal reason received from the acquirer, where available. Example: AUTHORISED
  • requestAmount - The amount of the payment request.
  • requestCurrencyCode - The currency of the payment request.
  • shopperInteraction - The shopper interaction type of the payment request. Example: Ecommerce
  • shopperReference - The shopperReference passed in the payment request. Example: AdyenTestShopperXX
  • terminalId - The terminal ID used in a point-of-sale payment. Example: 06022622
  • threeDAuthenticated - A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
  • threeDAuthenticatedResponse - The raw 3DS authentication result from the card issuer. Example: N
  • threeDOffered - A Boolean value indicating whether 3DS was offered for this payment. Example: true
  • threeDOfferedResponse - The raw enrollment result from the 3DS directory services of the card schemes. Example: Y
  • threeDSVersion - The 3D Secure 2 version.
  • tokenizationPeriodShopperReference - The reference for the shopper that you sent when tokenizing the payment details.
  • tokenizationPeriodStorePeriodOperationType - The operation performed on the token. Possible values: * created: the token has been created. * updated: the existing token has been updated. * alreadyExisting: the details have already been stored.
  • tokenizationPeriodStoredPaymentMethodId - The reference that uniquely identifies tokenized payment details.
  • visaTransactionId - The visaTransactionId, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field.
  • 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'. Example: ODgxNDc2MDg2MDExODk5MAAAAAA=
Annotations
  • @BuiltValue.new()

Constructors

ResponseAdditionalDataCommon([void updates(ResponseAdditionalDataCommonBuilder b)])
factory

Properties

acquirerAccountCode → String?
The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions.
no setter
acquirerCode → String?
The name of the acquirer processing the payment request. Example: TestPmmAcquirer
no setter
acquirerReference → String?
The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9
no setter
alias → String?
The Adyen alias of the card. Example: H167852639363479
no setter
aliasType → String?
The type of the card alias. Example: Default
no setter
authCode → String?
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
no setter
authorisationMid → String?
Merchant ID known by the acquirer.
no setter
authorisedAmountCurrency → String?
The currency of the authorised amount, as a three-character ISO currency code.
no setter
authorisedAmountValue → String?
Value of the amount authorised. This amount is represented in minor units according to the following table.
no setter
avsResult → String?
The AVS result code of the payment, which provides information about the outcome of the AVS check. For possible values, see AVS.
no setter
avsResultRaw → String?
Raw AVS result received from the acquirer, where available. Example: D
no setter
bic → String?
BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions.
no setter
coBrandedWith → String?
Includes the co-branded card information.
no setter
cvcResult → String?
The result of CVC verification.
no setter
cvcResultRaw → String?
The raw result of CVC verification.
no setter
dsTransID → String?
Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.
no setter
eci → String?
The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02
no setter
expiryDate → String?
The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment.
no setter
extraCostsCurrency → String?
The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR
no setter
extraCostsValue → String?
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.
no setter
fraudCheckLeftSquareBracketItemNrRightSquareBracketLeftSquareBracketFraudChecknameRightSquareBracket → String?
The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.
no setter
fraudManualReview → String?
Indicates if the payment is sent to manual review.
no setter
fraudResultType → ResponseAdditionalDataCommonFraudResultTypeEnum?
The fraud result properties of the payment. Possible values: * AMBER * GREEN * RED
no setter
fraudRiskLevel → ResponseAdditionalDataCommonFraudRiskLevelEnum?
The risk level of the transaction as classified by the machine learning fraud risk rule. The risk level indicates the likelihood that a transaction will result in a fraudulent dispute. Possible values: * veryLow * low * medium * high * veryHigh
no setter
fundingSource → String?
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.
no setter
fundsAvailability → String?
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".
no setter
hashCode → int
The hash code for this object.
no setterinherited
inferredRefusalReason → String?
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
no setter
isCardCommercial → String?
Indicates if the card is used for business purposes only.
no setter
issuerCountry → String?
The issuing country of the card based on the BIN list that Adyen maintains. Example: JP
no setter
liabilityShift → String?
A Boolean value indicating whether a liability shift was offered for this payment.
no setter
mcBankNetReferenceNumber → String?
The mcBankNetReferenceNumber, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field.
no setter
merchantAdviceCode → String?
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.
no setter
merchantReference → String?
The reference provided for the transaction.
no setter
networkTxReference → String?
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.
no setter
ownerName → String?
The owner name of a bank account. Only relevant for SEPA Direct Debit transactions.
no setter
paymentAccountReference → String?
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.
no setter
paymentMethod → String?
The payment method used in the transaction.
no setter
paymentMethodVariant → String?
The Adyen sub-variant of the payment method used for the payment request. For more information, refer to PaymentMethodVariant. Example: mcpro
no setter
payoutEligible → String?
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)
no setter
realtimeAccountUpdaterStatus → String?
The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder
no setter
receiptFreeText → String?
Message to be displayed on the terminal.
no setter
recurringPeriodContractTypes → String?
The recurring contract types applicable to the transaction.
no setter
recurringPeriodFirstPspReference → String?
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.
no setter
recurringPeriodRecurringDetailReference → String?
The reference that uniquely identifies the recurring transaction.
no setter
recurringPeriodShopperReference → String?
The provided reference of the shopper for a recurring transaction.
no setter
recurringProcessingModel → ResponseAdditionalDataCommonRecurringProcessingModelEnum?
The processing model used for the recurring transaction.
no setter
referred → String?
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
no setter
refusalReasonRaw → String?
Raw refusal reason received from the acquirer, where available. Example: AUTHORISED
no setter
requestAmount → String?
The amount of the payment request.
no setter
requestCurrencyCode → String?
The currency of the payment request.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shopperInteraction → String?
The shopper interaction type of the payment request. Example: Ecommerce
no setter
shopperReference → String?
The shopperReference passed in the payment request. Example: AdyenTestShopperXX
no setter
terminalId → String?
The terminal ID used in a point-of-sale payment. Example: 06022622
no setter
threeDAuthenticated → String?
A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
no setter
threeDAuthenticatedResponse → String?
The raw 3DS authentication result from the card issuer. Example: N
no setter
threeDOffered → String?
A Boolean value indicating whether 3DS was offered for this payment. Example: true
no setter
threeDOfferedResponse → String?
The raw enrollment result from the 3DS directory services of the card schemes. Example: Y
no setter
threeDSVersion → String?
The 3D Secure 2 version.
no setter
tokenizationPeriodShopperReference → String?
The reference for the shopper that you sent when tokenizing the payment details.
no setter
tokenizationPeriodStoredPaymentMethodId → String?
The reference that uniquely identifies tokenized payment details.
no setter
tokenizationPeriodStorePeriodOperationType → ResponseAdditionalDataCommonTokenizationPeriodStorePeriodOperationTypeEnum?
The operation performed on the token. Possible values: * created: the token has been created. * updated: the existing token has been updated. * alreadyExisting: the details have already been stored.
no setter
visaTransactionId → String?
The visaTransactionId, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field.
no setter
xid → String?
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'. Example: ODgxNDc2MDg2MDExODk5MAAAAAA=
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(ResponseAdditionalDataCommonBuilder)) → ResponseAdditionalDataCommon
Rebuilds the instance.
inherited
toBuilder() → ResponseAdditionalDataCommonBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<ResponseAdditionalDataCommon>
no setter