SIsilverflow
Fees

Estimate scheme fee [EXPERIMENTAL]

This endpoint is still under development; it currently has a limited library of scheme fees, and will not provide fee estimates for all supported card networks.

This API endpoint will perform a scheme fee estimation, returning a list of predicted scheme fees when passing some parameters similar to a charge.

<!-- These scheme fees can be either a `fixed` or `basisPoints` scheme fee, and contain a calculated `amount` based on the input amount and the scheme fee amount. There is no currency conversion applied; the amounts of these individual scheme fees will always be denominated in the currency of the scheme fee itself. -->
post/fees/scheme/estimate

Request

Request body

cardNumberstring password required

Full digits of a card

merchantAcceptorKeystring required

Uniquely identifies a Merchant Acceptor.

threeDsAuthentication'none' | 'attempt' | 'success' required

3DS settings

Example request

{
  "amount": {
    "currency": "EUR"
  },
  "merchantAcceptorKey": "mac-1JRadf2ffdfrdPMf2XrS2",
  "chargeType": {
    "cardEntry": "e-commerce"
  }
}

Response

Scheme fee estimation response

cardNetwork'mastercard' | 'visa' | 'discover' | 'bancontact' required

The card network

Example response

{
  "cardNetwork": "mastercard",
  "conversionRates": [
    {
      "source": "EUR",
      "target": "EUR"
    }
  ],
  "fees": [
    {
      "sourceAmount": {
        "currency": "EUR"
      },
      "convertedSourceAmount": {
        "currency": "EUR"
      },
      "feeRate": {
        "currency": "EUR"
      },
      "billingAmount": {
        "currency": "EUR"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.