List network totals
report_date
- date
Singular report date to filter on (YYYY-MM-DD). Cannot be populated in conjunction with report_date_begin or report_date_end.
report_date_begin
- date
Earliest report date to filter on, inclusive (YYYY-MM-DD).
report_date_end
- date
Latest report date to filter on, inclusive (YYYY-MM-DD).
network
- string
enum
Network to filter on.
Allowed:AMEX,VISA,MASTERCARD,MAESTRO,INTERLINK
institution_id
- string
Institution ID to filter on.
settlement_institution_id
- string
Settlement institution ID to filter on.
begin
- date-time
Datetime in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.
end
- date-time
Datetime in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.
page_size
- integer
1 to 100
Defaults to 50
Number of records per page.
starting_after
- uuid
A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.
ending_before
- uuid
A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.
Responses
200 OK
- object
- data
- array of objects
- required
- data
- object
- token
- uuid
- required
- Globally unique identifier.
- network
- string
- enum
- required
- Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO, or 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
- amounts object
- 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.
- has_more
- boolean
- required
- Indicates whether there are more network total records to be retrieved.
- token
- object
- data
- required
- array of objects
- data
400
- A parameter in the query given in the request does not match the valid queries for the endpoint.
401
| Error | Description |
|---|---|
| User has not been authenticated | Invalid or missing API key |
| API key is not active | The API key used is no longer active |
| Could not find API key | The API key provided is not associated with any user |
| Please provide API key in Authorization header | The Authorization header is not in the request |
| Please provide API key in the form Authorization: [api-key] | The Authorization header is not formatted properly |
| Insufficient privileges. Issuing API key required | Write access requires an Issuing API key. Reach out at lithic.com/contact |
| Insufficient privileges to create virtual cards. | Creating virtual cards requires an additional privilege |
422
- Unprocessable entity.
429
- Client has exceeded the number of allowed requests in a given time period.
| Error | Description |
|---|---|
| Rate limited, too many requests per second | User has exceeded their per second rate limit |
| Rate limited, reached daily limit | User has exceeded their daily rate limit |
| Rate limited, too many keys tried | One IP has queried too many different API keys |
Example Request
curl --request GET \
--url 'https://sandbox.lithic.com/v1/reports/settlement/network_totals?page_size=50' \
--header 'accept: application/json'
Example Response
{
"data": [
{
"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.424Z",
"updated": "2026-07-18T00:25:41.424Z"
}
],
"has_more": true
}