GetCostEstimateRequest

The fields described below are the generic parameters you specify when making a /getCostEstimate call to the Adyen API. For more information, refer to Cost estimation.

Field

Type

Required

Description

amount

Amount

(tick)

The transaction amount used as a base for the cost estimation.

assumptions

CostEstimateAssumptions

(error)

Assumptions made for the expected characteristics of the transaction, for which the charges are being estimated.

cardNumber String (error)

The card number (4-19 characters). Do not use any separators.

Either the cardNumber or encryptedCard field must be provided in a payment request.

encryptedCard String (error)

Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Client-Side Encryption library and must contain at least the number and generationtime fields.

Either the cardNumber or encryptedCard field must be provided in a payment request.

merchantAccount

String
(tick)

The merchant account identifier you want to process the (transaction) request with.

merchantDetails

MerchantDetails
(error)

Additional data for merchants who don't use Adyen as the payment authorisation gateway.

shopperInteraction

String
(error)

 

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).
  • POS - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
  • Moto - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.