Get a fees cost estimate

post /getCostEstimate

This API is available only for merchants operating in Australia, the EU, and the UK.

Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary.

To retrieve this information, make the call to the /getCostEstimate endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations).

Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the assumptions parameter.

Endpoint destination URL
Click to copy

Request parameters

amount object Required

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

assumptions object

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

cardNumber string
Min length: 4 Max length: 19

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 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.

merchantAccount string Required

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

merchantDetails object

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

recurring object

The recurring settings for the payment. Use this property when you want to enable recurring payments.

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.

shopperInteraction string

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 string

Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

Your reference must not include personally identifiable information (PII), for example name or email address.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy