Lithic · Schema

settlement Summary Details

FinTechBaaSCard IssuingPaymentsEmbedded Finance

Properties

Name Type Description
currency string 3-character alphabetic ISO 4217 code.
disputes_gross_amount integer The total gross amount of disputes settlements.
institution string The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE for Visa).
interchange_gross_amount integer The total amount of interchange.
network string Card network where the transaction took place
other_fees_gross_amount integer Total amount of gross other fees outside of interchange.
settled_net_amount integer The total net amount of cash moved. (net value of settled_gross_amount, interchange, fees).
transactions_gross_amount integer The total amount of settlement impacting transactions (excluding interchange, fees, and disputes).
View JSON Schema on GitHub

JSON Schema

lithic-settlement-summary-details-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/settlement-summary-details",
  "title": "settlement Summary Details",
  "properties": {
    "currency": {
      "description": "3-character alphabetic ISO 4217 code.",
      "example": "USD",
      "maxLength": 3,
      "minLength": 3,
      "type": "string"
    },
    "disputes_gross_amount": {
      "description": "The total gross amount of disputes settlements.",
      "example": 0,
      "type": "integer"
    },
    "institution": {
      "description": "The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE for Visa).",
      "example": "00001",
      "type": "string"
    },
    "interchange_gross_amount": {
      "description": "The total amount of interchange.",
      "example": -7,
      "type": "integer"
    },
    "network": {
      "description": "Card network where the transaction took place",
      "enum": [
        "AMEX",
        "INTERLINK",
        "MAESTRO",
        "MASTERCARD",
        "UNKNOWN",
        "VISA"
      ],
      "example": "MASTERCARD",
      "type": "string"
    },
    "other_fees_gross_amount": {
      "description": "Total amount of gross other fees outside of interchange.",
      "example": 0,
      "type": "integer"
    },
    "settled_net_amount": {
      "description": "The total net amount of cash moved. (net value of settled_gross_amount, interchange, fees).",
      "example": 1893,
      "type": "integer"
    },
    "transactions_gross_amount": {
      "description": "The total amount of settlement impacting transactions (excluding interchange, fees, and disputes).",
      "example": 1900,
      "type": "integer"
    }
  },
  "type": "object"
}