Lithic API Documentation | Funding Events › Get Funding Event Details

Funding Events

funding_events

Methods

List Funding Events -> CursorPage<

FundingEvent

get/v1/funding_events

Get all funding events for program

Get Funding Event By ID ->

FundingEvent

get/v1/funding_events/{funding_event_token}

Get funding event for program by id

path Parameters

funding_event_token: string

Response fields

FundingEvent

Request example

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

200Example

{
  "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"
}

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

path Parameters

funding_event_token: string

(format: uuid)

Response fields

token: string

(format: uuid)

Unique token ID

settlement_details_url: string

(format: uri)

URL of the settlement details

settlement_summary_url: string

(format: uri)

URL of the settlement summary

Request example

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

200Example

{
  "token": "b68b7424-aa69-4cbc-a946-30d90181b621",
  "settlement_details_url": "https://example.com",
  "settlement_summary_url": "https://example.com"
}

Domain types

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