transaction.settled

webhook

transaction.settled

Sent when a transaction reaches settled. The same envelope is used
for every event type — see the WebhookEvent schema. Verify the
signature before parsing (see Webhook authentication), respond
2xx within 10 seconds, then fetch the transaction.

Payload

The body of every webhook delivery.

string

required

type

string

enum

required

Allowed:

createdAt

date-time

required

version

string

required

The API version the payload follows.

operatorId

string

required

endpointId

string

required

data

object

required

Deliberately thin. Fetch the transaction for the full object.

Headers

Omi-Signature

string

required

base64url(HMAC-SHA256(secret, "<timestamp>.<url>.<rawBody>"))

Omi-Signature-Timestamp

date-time

required

ISO 8601 timestamp included in the signed string. Reject deliveries older than 5 minutes.

Omi-Event-Id

string

required

Same as id in the body. Deduplicate on it.

Response

200

Any 2xx acknowledges the event. Anything else, or no response within 10 s, is retried.

Loading…