Adyen · Schema

CostEstimateResponse

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
cardBin	object	Card BIN details.
costEstimateAmount	object	The estimated cost (scheme fee + interchange) in the settlement currency. If the settlement currency cannot be determined, the fee in EUR is returned.
costEstimateReference	string	Adyen's 16-character reference associated with the request.
resultCode	string	The result of the cost estimation.
surchargeType	string	Indicates the way the charges can be passed on to the cardholder. The following values are possible: * `ZERO` - the charges are not allowed to pass on * `PASSTHROUGH` - the charges can be passed on *

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CostEstimateResponse",
  "title": "CostEstimateResponse",
  "properties": {
    "cardBin": {
      "description": "Card BIN details.",
      "$ref": "#/components/schemas/CardBin"
    },
    "costEstimateAmount": {
      "description": "The estimated cost (scheme fee + interchange) in the settlement currency. If the settlement currency cannot be determined, the fee in EUR is returned.",
      "$ref": "#/components/schemas/Amount"
    },
    "costEstimateReference": {
      "x-addedInVersion": "52",
      "description": "Adyen's 16-character reference associated with the request.",
      "type": "string"
    },
    "resultCode": {
      "description": "The result of the cost estimation.",
      "type": "string"
    },
    "surchargeType": {
      "description": "Indicates the way the charges can be passed on to the cardholder. The following values are possible:\n* `ZERO` - the charges are not allowed to pass on\n* `PASSTHROUGH` - the charges can be passed on\n* `UNLIMITED` - there is no limit on how much surcharge is passed on",
      "type": "string"
    }
  },
  "type": "object"
}