InterchangeFee

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-interchange-fee-schema.json",
  "title": "InterchangeFee",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-interchange-fee-api-openapi.yml#/components/schemas/InterchangeFee",
  "type": "object",
  "properties": {
    "transactionIdentification": {
      "$ref": "#/$defs/TransactionIdentification"
    },
    "contractIdentification": {
      "$ref": "#/$defs/ContractIdentification"
    },
    "postingDate": {
      "type": "string",
      "format": "date",
      "description": "Date when this transaction is posted on the merchant balance (yyyy-mm-dd)"
    },
    "transactionFeeType": {
      "type": "string",
      "description": "Type of transaction fee."
    },
    "transactionDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "transaction posting datetime (yyyy-mm-dd hh:mm:ss)"
    },
    "interchangeFeeAmount": {
      "$ref": "#/$defs/Amount"
    },
    "interchangeRateDesignatorCode": {
      "type": "string",
      "description": "Interchange Rate Designator Code"
    },
    "issuerRegion": {
      "type": "string",
      "description": "Region of the issuer"
    },
    "issuerRegionCode": {
      "type": "string",
      "description": "Region of the issuer code"
    },
    "paymentProductCode": {
      "type": "string",
      "description": "Payment product code"
    },
    "creditDebitIndicator": {
      "type": "string",
      "description": "Credit or Debit indicator. i.e. C = Credit. D = Debit"
    },
    "paymentProductTypeCode": {
      "type": "string",
      "description": "Card product type code"
    },
    "region": {
      "type": "string",
      "description": "Region of the payment scheme. Regional classification used by the schemes which indicates the location of the acquirer compared to the issuer. i.e. VPAY Netherland, Intra-European, VISA Germany"
    },
    "regionCode": {
      "type": "string",
      "description": "Region of the payment scheme code"
    },
    "channel": {
      "type": "string",
      "description": "Processing channel for transactions"
    },
    "transactionConditionCode": {
      "type": "string",
      "description": "Code for Condition in which the transaction took place"
    },
    "brand": {
      "type": "string",
      "description": "Brand"
    }
  },
  "$defs": {
    "Amount": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "string",
          "format": "unlimited size decimal",
          "description": "Amount in the major units of the currency according to ISO 4217.\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n"
        },
        "currency": {
          "type": "string",
          "description": "Currency of the amount"
        }
      }
    },
    "ContractIdentification": {
      "type": "object",
      "properties": {
        "acquirerId": {
          "type": "string",
          "description": "Unique identification of the acquirer, determined by equensWorldline"
        },
        "holdingId": {
          "type": "integer",
          "format": "int32",
          "description": "Unique identification of the holding, determined by equensWorldline"
        },
        "merchantId": {
          "type": "string",
          "description": "Unique identification of the merchant, determined by the acquirer"
        },
        "contractId": {
          "type": "string",
          "description": "Unique identification of the contract, determined by the acquirer"
        },
        "cardAcceptorId": {
          "type": "string",
          "description": "Unique identification of the cardAcceptor within the contract"
        },
        "siteId": {
          "type": "integer",
          "format": "int32",
          "description": "Unique identification of the site within the contract"
        },
        "terminalId": {
          "type": "string",
          "description": "Unique code identifying the terminal at the Card acceptor location"
        }
      }
    },
    "TransactionIdentification": {
      "type": "object",
      "properties": {
        "transactionId": {
          "type": "string",
          "description": "Unique identification for a Cardholder Initiated Transaction"
        }
      }
    }
  }
}