Fees

Estimate interchange fee

Obtain an estimate for the interchange fee of a future transaction.

Requires fees:Interchange permission.

<!-- The resulting estimate will be inaccurate due to any of the following sources: * Graduated products * Authorization fallbacks * Foreign exchange rate dates ### Interchange product The selected interchange program is surfaced in the API response in the `designator` field which is not scheme agnostic and will return different sub-fields for Visa `feeDescriptor` and Mastercard `ird`. More information on the fee programs can be found in the interchange manuals of the respective scheme. ### Fee components and amount The API endpoint will return the total interchange fee amount in the `amount` field and this information should be sufficient for interchange fee estimation. All individual fee components will be returned in a `segments` structure which contains the elements used in the calculation of the total amount. This could consist of a fixed component as well as a variable component. The variable component might be capped. * `fixed` - Fixed component of the interchange fee in minor units * `basisPoints` - Variable component of the interchange fee in basis points (0.01%) * `max` - Maximum fee amount in minor units, fee capped at this amount also if transaction amount is higher * `min` - Minimum fee amount in minor units, fee will not get lower also if transaction amount is lower It is advised to use the `amount` field where all of this logic has already been applied. These elements are returned in order to give a complete picture of the interchange fee inner workings and allows for reconstruction of the interchange fee. ### Currency conversion The fee components are not necessarily in the same currency as the transaction currency but the fee service takes care of this conversion to simplify the usage of this endpoint. The used currency conversion rates are sourced from the card scheme rate tables which are published and updated on a daily basis. The version of the used rate table file is returned in `feeDate`. The `amount` is always in the transaction currency and the conversion rates used are listed in the `rates` structure containing all necessary elements to reconstruct the conversion operation. -->
post/fees/interchange/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

isRefundboolean required

Whether the transaction is a refund.

Example request

{
  "amount": {
    "currency": "EUR"
  },
  "chargeType": {
    "terminal": {
      "capabilities": [
        "contactChip",
        "contactlessChip",
        "contactMagStripe",
        "oneTap"
      ]
    }
  }
}

Response

Interchange Fee estimate

feeDatestring date required

The date of network references files used to calculate the fee

Example response

{
  "segments": {
    "currency": "EUR"
  },
  "amount": {
    "currency": "EUR"
  },
  "rates": [
    {
      "source": "EUR",
      "target": "EUR"
    }
  ]
}

Changes

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