CostEstimateRequest class abstract

CostEstimateRequest

Properties:

  • amount - The transaction amount used as a base for the cost estimation.
  • assumptions - Assumptions made for the expected characteristics of the transaction, for which the charges are being estimated.
  • cardNumber - The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. > Either the cardNumber or encryptedCardNumber field must be provided in a payment request.
  • encryptedCardNumber - Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the encryptedCardNumber field. > Either the cardNumber or encryptedCardNumber field must be provided in a payment request.
  • merchantAccount - The merchant account identifier you want to process the (transaction) request with.
  • merchantDetails - Additional data for merchants who don't use Adyen as the payment authorisation gateway.
  • recurring - The recurring settings for the payment. Use this property when you want to enable recurring payments.
  • selectedRecurringDetailReference - The recurringDetailReference you want to use for this cost estimate. The value LATEST can be used to select the most recently stored recurring detail.
  • shopperInteraction - Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * Ecommerce - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * ContAuth - Card on file and/or subscription transactions, where the card holder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * Moto - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * POS - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
  • shopperReference - Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
Annotations
  • @BuiltValue.new()

Constructors

CostEstimateRequest([void updates(CostEstimateRequestBuilder b)])
factory

Properties

amount → Amount
The transaction amount used as a base for the cost estimation.
no setter
assumptions → CostEstimateAssumptions?
Assumptions made for the expected characteristics of the transaction, for which the charges are being estimated.
no setter
cardNumber → String?
The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. > Either the cardNumber or encryptedCardNumber field must be provided in a payment request.
no setter
encryptedCardNumber → String?
Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the encryptedCardNumber field. > Either the cardNumber or encryptedCardNumber field must be provided in a payment request.
no setter
hashCode → int
The hash code for this object.
no setterinherited
merchantAccount → String
The merchant account identifier you want to process the (transaction) request with.
no setter
merchantDetails → MerchantDetails?
Additional data for merchants who don't use Adyen as the payment authorisation gateway.
no setter
recurring → Recurring?
The recurring settings for the payment. Use this property when you want to enable recurring payments.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedRecurringDetailReference → String?
The recurringDetailReference you want to use for this cost estimate. The value LATEST can be used to select the most recently stored recurring detail.
no setter
shopperInteraction → CostEstimateRequestShopperInteractionEnum?
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * Ecommerce - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * ContAuth - Card on file and/or subscription transactions, where the card holder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * Moto - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * POS - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
no setter
shopperReference → String?
Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
no setter

Methods

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