Lithic API Documentation | Funding Events

Funding Events

funding_events

Methods

List Funding Events -> CursorPage<

FundingEvent

get/v1/funding_events

Get all funding events for program

query Parameters

ending_before: string

Optional

(format: 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.

page_size: number

Optional

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

Page size (for pagination).

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<

FundingEvent

Funding Event Response

has_more: boolean

Request example

curl https://api.lithic.com/v1/funding_events \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "b68b7424-aa69-4cbc-a946-30d90181b621",
      "collection_resource_type": "PAYMENT",
      "collection_tokens": [
        "b68b7424-aa69-4cbc-a946-30d90181b621"
      ],
      "created": "2024-01-01T00:00:00Z",
      "high_watermark": "2024-01-01T00:00:00Z",
      "network_settlement_summary": [
        {
          "network_settlement_date": "2024-01-01",
          "settled_gross_amount": 0
        }
      ],
      "previous_high_watermark": "2024-01-01T00:00:00Z",
      "updated": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true
}

Get Funding Event By ID ->

FundingEvent

get/v1/funding_events/{funding_event_token}

Get funding event for program by id

Get Funding Event Details -> { token, settlement_details_url, settlement_summary_url }

get/v1/funding_events/{funding_event_token}/details

Get funding event details by id

Domain types

FundingEvent = { token, collection_resource_type, collection_tokens, 5 more... }