{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "dispute.funds-held",
"version": 1,
"timestamp": "2025-01-15T10:30:00.000Z",
"source": "transaction-service",
"company_id": "comp_123456789",
"correlation_id": "corr_987654321"
}Dispute funds held
Triggered when the payment provider places a precautionary hold on disputed
funds in the merchant’s account. Holds can be partial and incremental, so a
single dispute may emit this event multiple times with a growing
total_held_amount.
When the provider reports the exact amount it set out to hold, that figure
supersedes the dispute’s derived amount, so the entity snapshot reflects
the provider-confirmed amount at risk.
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "dispute.funds-held",
"version": 1,
"timestamp": "2025-01-15T10:30:00.000Z",
"source": "transaction-service",
"company_id": "comp_123456789",
"correlation_id": "corr_987654321"
}Body
Base structure for all webhook events
Unique event identifier
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Event type identifier
dispute.funds-held "dispute.funds-held"
Event schema version
1
Event timestamp in ISO 8601 format
"2025-01-15T10:30:00.000Z"
Service that generated the event
"transaction-service"
Company ID associated with the event
"comp_123456789"
Shared by every event that one request, inbound webhook or job item caused, so related events can be grouped. Not unique per event: use id to identify and deduplicate an event.
"corr_987654321"
Details of the precautionary hold placed on disputed funds
Show child attributes
Show child attributes
Response
Webhook received successfully