List

List funding events

get/v1/funding_events

Get all funding events for program

Query Parameters

ending_beforestring

optional

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.

formatuuid

page_sizenumber

optional

Page size (for pagination).

maximum100

minimum1

starting_afterstring

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.

Returns

dataarray of object

Funding Event Response

Hide ParametersShow Parameters

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

has_moreboolean

Request example Request

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

200 Example

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