Token

UUID

Required Token of the network total record to retrieve

Response Codes

200 OK

Object

• token: UUID, required.

  • Globally unique identifier.

• network: string, enum, required.

  • Card network where the transaction took place.
  • Possible values: AMEX, VISA, MASTERCARD, MAESTRO, INTERLINK.

• institution_id: string, required.

  • The institution that activity occurred on. For Mastercard: ICA (Interbank Card Association). For Maestro: institution ID. For Visa: lowest level SRE (Settlement Reporting Entity).

• settlement_institution_id: string, required.

  • The institution responsible for settlement. For Mastercard: same as institution_id. For Maestro: billing ICA. For Visa: Funds Transfer SRE (FTSRE).

• settlement_service: string, required.

  • Settlement service.

• report_date: date, required.

  • Date that the network total record applies to. YYYY-MM-DD format.

• cycle: integer.

  • The clearing cycle that the network total record applies to. Mastercard only.

• currency: string, required.

  • 3-character alphabetic ISO 4217 code.

• is_complete: boolean, required.

  • Indicates that all settlement records related to this Network Total are available in the details endpoint.

• amounts: object, required.

  • gross_settlement: integer, required.
    • Total settlement amount excluding interchange, in currency's smallest unit.
  • interchange_fees: integer, required.
    • Interchange amount, in currency's smallest unit.
  • visa_charges: integer.
    • Charges specific to Visa/Interlink, in currency's smallest unit.
  • net_settlement: integer, required.
    • gross_settlement net of interchange_fees and visa_charges (if applicable), in currency's smallest unit.

• created: date-time, required.

  • RFC 3339 timestamp for when the record was created. UTC time zone.

• updated: date-time, required.

  • RFC 3339 timestamp for when the record was last updated. UTC time zone.

Error Codes

• 400: A parameter in the query given in the request does not match the valid queries for the endpoint.
• 401: User has not been authenticated - Invalid or missing API key.
• 404: The specified resource was not found.
• 422: Unprocessable entity.
• 429: Client has exceeded the number of allowed requests in a given time period.

Example CURL Command

curl --request GET \
     --url https://sandbox.lithic.com/v1/reports/settlement/network_totals/token \
     --header 'accept: application/json'

Example Response

{
  "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "network": "AMEX",
  "institution_id": "string",
  "settlement_institution_id": "string",
  "settlement_service": "string",
  "report_date": "2026-07-18",
  "cycle": 0,
  "currency": "string",
  "is_complete": true,
  "amounts": {
    "gross_settlement": 0,
    "interchange_fees": 0,
    "visa_charges": 0,
    "net_settlement": 0
  },
  "created": "2026-07-18T00:25:41.426Z",
  "updated": "2026-07-18T00:25:41.426Z"
}