AdditionalDataCommon class abstract

AdditionalDataCommon

Properties:

  • requestedTestAcquirerResponseCode - Triggers test scenarios that allow to replicate certain acquirer response codes. See Testing result codes and refusal reasons to learn about the possible values, and the refusalReason values you can trigger.
  • requestedTestErrorResponseCode - Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * NO_CONNECTION_AVAILABLE – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * IOEXCEPTION_RECEIVED – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.
  • allowPartialAuth - Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. If a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue. To enable this functionality, contact our Support Team.
  • authorisationType - Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to Authorisation types. Allowed values: * PreAuth – flags the payment request to be handled as a pre-authorisation. * FinalAuth – flags the payment request to be handled as a final authorisation.
  • autoRescue - Set to true to enable Auto Rescue for a transaction. Use the maxDaysToRescue to specify a rescue window.
  • customRoutingFlag - Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. To enable this functionality, contact Support.
  • industryUsage - In case of asynchronous authorisation adjustment, this field denotes why the additional payment is made. Possible values: * NoShow: An incremental charge is carried out because of a no-show for a guaranteed reservation. * DelayedCharge: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.
  • manualCapture - Set to true to require manual capture for the transaction.
  • maxDaysToRescue - The rescue window for a transaction, in days, when autoRescue is set to true. You can specify a value between 1 and 48. * For cards, the default is one calendar month. * For SEPA, the default is 42 days.
  • networkTxReference - Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending shopperInteraction ContAuth and recurringProcessingModel Subscription or UnscheduledCardOnFile to ensure that the transaction is classified as MIT.
  • overwriteBrand - Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the selectedBrand value to specify how to process the transaction.
  • subMerchantCity - This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 13 characters.
  • subMerchantCountry - This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. * Format: alpha-numeric. * Fixed length: 3 characters.
  • subMerchantEmail - This field is required for transactions performed by registered payment facilitators. This field contains the email address of the sub-merchant. * Format: Alphanumeric * Maximum length: 40 characters
  • subMerchantID - This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters.
  • subMerchantName - This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters.
  • subMerchantPhoneNumber - This field is required for transactions performed by registered payment facilitators. This field contains the phone number of the sub-merchant.* Format: Alphanumeric * Maximum length: 20 characters
  • subMerchantPostalCode - This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 10 characters.
  • subMerchantState - This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 3 characters.
  • subMerchantStreet - This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 60 characters.
  • subMerchantTaxId - This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters.
Annotations
  • @BuiltValue.new()

Constructors

AdditionalDataCommon([void updates(AdditionalDataCommonBuilder b)])
factory

Properties

allowPartialAuth → String?
Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. If a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue. To enable this functionality, contact our Support Team.
no setter
authorisationType → String?
Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to Authorisation types. Allowed values: * PreAuth – flags the payment request to be handled as a pre-authorisation. * FinalAuth – flags the payment request to be handled as a final authorisation.
no setter
autoRescue → String?
Set to true to enable Auto Rescue for a transaction. Use the maxDaysToRescue to specify a rescue window.
no setter
customRoutingFlag → String?
Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. To enable this functionality, contact Support.
no setter
hashCode → int
The hash code for this object.
no setterinherited
industryUsage → AdditionalDataCommonIndustryUsageEnum?
In case of asynchronous authorisation adjustment, this field denotes why the additional payment is made. Possible values: * NoShow: An incremental charge is carried out because of a no-show for a guaranteed reservation. * DelayedCharge: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.
no setter
manualCapture → String?
Set to true to require manual capture for the transaction.
no setter
maxDaysToRescue → String?
The rescue window for a transaction, in days, when autoRescue is set to true. You can specify a value between 1 and 48. * For cards, the default is one calendar month. * For SEPA, the default is 42 days.
no setter
networkTxReference → String?
Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending shopperInteraction ContAuth and recurringProcessingModel Subscription or UnscheduledCardOnFile to ensure that the transaction is classified as MIT.
no setter
overwriteBrand → String?
Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the selectedBrand value to specify how to process the transaction.
no setter
requestedTestAcquirerResponseCode → String?
Triggers test scenarios that allow to replicate certain acquirer response codes. See Testing result codes and refusal reasons to learn about the possible values, and the refusalReason values you can trigger.
no setter
requestedTestErrorResponseCode → String?
Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * NO_CONNECTION_AVAILABLE – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * IOEXCEPTION_RECEIVED – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subMerchantCity → String?
This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 13 characters.
no setter
subMerchantCountry → String?
This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. * Format: alpha-numeric. * Fixed length: 3 characters.
no setter
subMerchantEmail → String?
This field is required for transactions performed by registered payment facilitators. This field contains the email address of the sub-merchant. * Format: Alphanumeric * Maximum length: 40 characters
no setter
subMerchantID → String?
This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters.
no setter
subMerchantName → String?
This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters.
no setter
subMerchantPhoneNumber → String?
This field is required for transactions performed by registered payment facilitators. This field contains the phone number of the sub-merchant.* Format: Alphanumeric * Maximum length: 20 characters
no setter
subMerchantPostalCode → String?
This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 10 characters.
no setter
subMerchantState → String?
This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 3 characters.
no setter
subMerchantStreet → String?
This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 60 characters.
no setter
subMerchantTaxId → String?
This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(AdditionalDataCommonBuilder)) → AdditionalDataCommon
Rebuilds the instance.
inherited
toBuilder() → AdditionalDataCommonBuilder
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<AdditionalDataCommon>
no setter