Settlement Report Structure

Required Fields

• report_date: Date of the settlement report to retrieve.
• created: Date and time when the transaction first occurred. UTC time zone.
• is_complete: Indicates that all data expected on the given report date is available.
• updated: Date and time when the transaction first occurred. UTC time zone.

Details Structure

• details: Array of objects containing additional transaction details.
  • currency: 3-character alphabetic ISO 4217 code.
  • disputes_gross_amount: Total gross amount of disputes settlements.
  • institution: The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE for Visa).
  • interchange_gross_amount: The total amount of interchange.
  • network: Card network where the transaction took place (e.g., AMEX, INTERLINK, MAESTRO, MASTERCARD, UNKNOWN, VISA).
  • other_fees_gross_amount: Total amount of gross other fees outside of interchange.
  • settled_net_amount: The total net amount of cash moved.
  • transactions_gross_amount: The total amount of settlement impacting transactions (excluding interchange, fees, and disputes).

Example Response

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

Error Codes

• 400: A parameter in the query given in the request does not match the valid queries for the endpoint.
• 401: User has not been authenticated, invalid or missing API key.
• 404: The specified resource was not found.
• 422: Unprocessable entity.
• 429: Client has exceeded the number of allowed requests in a given time period.

Sample cURL Request

curl --request GET \
     --url https://sandbox.lithic.com/v1/reports/settlement/summary/report_date \
     --header 'accept: application/json'