v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB

Event Types

funding_event.created

Occurs when a funding event is created.

postWebhookfunding_event.created

Payload

event_type'funding_event.created' required

The type of event that occurred.

tokenstring uuid required

Unique token ID

collection_tokensstring[] required

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

previous_high_watermarkstring date-time required

Time of the previous high watermark

high_watermarkstring date-time required

Time of the high watermark

collection_resource_type'BOOK_TRANSFER' | 'PAYMENT' required

Collection resource type

createdstring date-time required

Time of the creation

updatedstring date-time required

Time of the update

Example payload

{
  "event_type": "funding_event.created",
  "token": "b68b7424-aa69-4cbc-a946-30d90181b621",
  "collection_tokens": [
    "b68b7424-aa69-4cbc-a946-30d90181b621"
  ],
  "previous_high_watermark": "2024-01-01T00:00:00Z",
  "high_watermark": "2024-01-01T00:00:00Z",
  "collection_resource_type": "PAYMENT",
  "network_settlement_summary": [
    {
      "network_settlement_date": "2024-01-01"
    }
  ],
  "created": "2024-01-01T00:00:00Z",
  "updated": "2024-01-01T00:00:00Z"
}

Response

Return a 200 status to indicate that the data was received successfully