Skip to content

Retrieve

Get funding event by ID
get/v1/funding_events/{funding_event_token}

Get funding event for program by id

Path Parameters
funding_event_tokenstring
Returns
tokenstring

Unique token ID

formatuuid
collection_resource_typeenum
Accepts one of the following: "BOOK_TRANSFER", "PAYMENT"

Collection resource type

Hide ParametersShow Parameters
"BOOK_TRANSFER"
"PAYMENT"
collection_tokensarray of string

IDs of collections, further information can be gathered from the appropriate collection API based on collection_resource_type

createdstring

Time of the creation

formatdate-time
high_watermarkstring

Time of the high watermark

formatdate-time
network_settlement_summaryarray of object

Network settlement summary breakdown by network settlement date

Hide ParametersShow Parameters
network_settlement_datestring
formatdate
settled_gross_amountnumber
formatint64
previous_high_watermarkstring

Time of the previous high watermark

formatdate-time
updatedstring

Time of the update

formatdate-time
Request example Request
curl https://api.lithic.com/v1/funding_events/$FUNDING_EVENT_TOKEN \
    -H "Authorization: $LITHIC_API_KEY"
200 Example
{
  "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"
}