Settlement Report

List settlement details

Changed on

List details.

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

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/reports/settlement/details/{report_date}
  • Auth
    API key in header Authorization

Path parameters

report_datestring date required

Date of the settlement report to retrieve. Not available in sandbox.

Query parameters

ending_beforestring

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_sizeinteger

Number of records per page.

starting_afterstring

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

OK

has_moreboolean required

More data exists.

Example response

{
  "data": [
    {
      "account_token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "card_program_token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "card_token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "created": "2023-06-01T00:00:00",
      "currency": "USD",
      "event_tokens": [
        "e34a817f-119d-4976-9fb3-8b020b8bbec3"
      ],
      "fee_description": "INTERCHANGE COMPLIANCE ADJUSTMENT FOR : 11/12/24",
      "institution": "00001",
      "interchange_fee_extended_precision": -70000,
      "interchange_gross_amount": -7,
      "network": "MASTERCARD",
      "report_date": "2023-06-01",
      "settlement_date": "2023-06-01",
      "token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "transaction_token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "transactions_gross_amount": 1900,
      "type": "CLEARING",
      "updated": "2023-06-01T00:00:00"
    }
  ]
}

Changes

  • fac001c63373Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • warning

      added the new NON_FINANCIAL enum value to the // response property for the response status

    • info

      removed the NON-FINANCIAL enum value from the // response property for the response status

  • ab626b78e088Revision changes
    • warning

      added the new AMEX enum value to the // response property for the response status