Skip to content
Stainless Stainless Stainless SDKs

Retrieve

Get network total
get/v1/reports/settlement/network_totals/{token}

Retrieve a specific network total record by token. Not available in sandbox.

Path Parameters
tokenstring
formatuuid
Returns
tokenstring

Globally unique identifier.

formatuuid
amountsobject
Hide ParametersShow Parameters
gross_settlementnumber

Total settlement amount excluding interchange, in currency's smallest unit.

interchange_feesnumber

Interchange amount, in currency's smallest unit.

net_settlementnumber

gross_settlement net of interchange_fees and visa_charges (if applicable), in currency's smallest unit.

visa_chargesnumber
optional

Charges specific to Visa/Interlink, in currency's smallest unit.

createdstring

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

formatdate-time
currencystring

3-character alphabetic ISO 4217 code.

institution_idstring

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

networkenum
Accepts one of the following: "VISA", "MASTERCARD", "MAESTRO", "INTERLINK"

Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or INTERLINK.

Hide ParametersShow Parameters
"VISA"
"MASTERCARD"
"MAESTRO"
"INTERLINK"
report_datestring

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

formatdate
settlement_institution_idstring

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

settlement_servicestring

Settlement service.

updatedstring

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

formatdate-time
cyclenumber
optional

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

Request example Request
curl https://api.lithic.com/v1/reports/settlement/network_totals/$TOKEN \
    -H "Authorization: $LITHIC_API_KEY"
200 Example
{
  "token": "12cf7505-06a8-435e-b1c7-4c430d02f6c3",
  "amounts": {
    "gross_settlement": 100,
    "interchange_fees": -25,
    "net_settlement": 85,
    "visa_charges": 10
  },
  "created": "2025-02-25T13:07:31.419631Z",
  "currency": "CAD",
  "institution_id": "1000000000",
  "network": "VISA",
  "report_date": "2025-02-25",
  "settlement_institution_id": "1000000001",
  "settlement_service": "015",
  "updated": "2025-02-25T13:07:31.419631Z",
  "cycle": 0
}