Lithic API Documentation | Reports › Settlement

Reports

reports

Domain types

NetworkTotal = { token, amounts, created, 9 more... }

SettlementDetail = { token, account_token, card_program_token, 18 more... }

SettlementReport = { created, currency, details, 8 more... }

SettlementSummaryDetails = { currency, disputes_gross_amount, institution, 5 more... }

Reports

Settlement

reports.settlement

Methods

List Settlement Details -> CursorPage<

SettlementDetail

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

List details.

path Parameters

report_date: string

(format: date)

query Parameters

ending_before: string

Optional

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.

page_size: number

Optional

(minimum: 1, maximum: 500, default: 50)

Number of records per page.

starting_after: string

Optional

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.

Response fields

data: Array<

SettlementDetail

has_more: boolean

More data exists.

Request example

curl https://api.lithic.com/v1/reports/settlement/details/$REPORT_DATE \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "account_token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "card_program_token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "card_token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "USD",
      "disputes_gross_amount": 0,
      "event_tokens": [
        "e34a817f-119d-4976-9fb3-8b020b8bbec3"
      ],
      "institution": "00001",
      "interchange_fee_extended_precision": -70000,
      "interchange_gross_amount": -7,
      "network": "MASTERCARD",
      "other_fees_details": {
        "ISA": 0
      },
      "other_fees_gross_amount": 0,
      "report_date": "2023-06-01",
      "settlement_date": "2023-06-01",
      "transaction_token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "transactions_gross_amount": 1900,
      "type": "CLEARING",
      "updated": "2019-12-27T18:11:19.117Z",
      "fee_description": "INTERCHANGE COMPLIANCE ADJUSTMENT FOR : 11/12/24"
    }
  ],
  "has_more": true
}

Get Settlement Summary ->

SettlementReport

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

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

Reports Settlement

Network Totals

reports.settlement.network_totals

Methods

List Network Totals -> CursorPage<

NetworkTotal

get/v1/reports/settlement/network_totals

List network total records with optional filters. Not available in sandbox.

Get Network Total ->

NetworkTotal

get/v1/reports/settlement/network_totals/{token}

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