Skip to main content
WEBHOOK
hedge.upcoming.settlement
{
  "environment": "Live",
  "version": "1.0",
  "organizationId": "98f7e6d5-c4b3-2a10-9876-543210fedcba",
  "eventId": "hedge-upcoming-settlement_f6a7b8c9-d0e1-2345-fabc-456789012345",
  "createdAtTs": 1711180800000,
  "type": "hedge.upcoming.settlement",
  "data": {
    "hedgeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "fromCurrency": "USD",
    "fromCurrencyAmount": 100000,
    "toCurrency": "EUR",
    "toCurrencyAmount": 91250,
    "settlementType": "full",
    "externalTransactionId": "ext_tx_001",
    "settlementAt": "2026-03-26T00:00:00.000Z"
  }
}

Body

application/json
​
eventId
string
required

Deterministic unique UUID. Use for idempotency and deduplication.

​
environment
enum<string>
required

"Live" or "Sandbox".

Available options:
Live,
Sandbox,
Demo
​
createdAtTs
number
required

Unix timestamp (ms) indicating when the event was created.

​
version
string
required

Payload schema version. Currently "1.0".

​
organizationId
string<uuid>
required

UUID of the organization the event belongs to.

​
type
enum<string>
required
Available options:
hedge.upcoming.settlement
​
data
object
required

Response

200

Return 2xx within 10s to acknowledge delivery.