Sign in

v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB
Settlement Report

Get settlement summary

Get the settlement report for a specified report date. Not available in sandbox.

get/v1/reports/settlement/summary/{report_date}

Path parameters

report_datestring date required

Date of the settlement report to retrieve.

Response

OK

createdstring date-time required

Date and time when the transaction first occurred. UTC time zone.

currencystring required

3-character alphabetic ISO 4217 code. (This field is deprecated and will be removed in a future version of the API.)

disputes_gross_amountinteger required

The total gross amount of disputes settlements. (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

interchange_gross_amountinteger required

The total amount of interchange. (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

is_completeboolean required

Indicates that all data expected on the given report date is available.

other_fees_gross_amountinteger required

Total amount of gross other fees outside of interchange. (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

report_datestring required

Date of when the report was first generated.

settled_net_amountinteger required

The total net amount of cash moved. (net value of settled_gross_amount, interchange, fees). (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

transactions_gross_amountinteger required

The total amount of settlement impacting transactions (excluding interchange, fees, and disputes). (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

updatedstring date-time required

Date and time when the transaction first occurred. UTC time zone.

Example response

{
  "created": "2023-06-01T00:00:00",
  "currency": "USD",
  "details": [
    {
      "currency": "USD",
      "institution": "00001",
      "interchange_gross_amount": -7,
      "network": "MASTERCARD",
      "settled_net_amount": 1893,
      "transactions_gross_amount": 1900
    }
  ],
  "interchange_gross_amount": -7,
  "report_date": "2023-06-01",
  "settled_net_amount": 1893,
  "transactions_gross_amount": 1900,
  "updated": "2023-06-01T00:00:00"
}