Skip to content
Documentation
Get started

Events

Webhook: payment.succeeded

POST

Signed event notification. Verify the signature before applying business effects.

webhook-id
required
string

Standard Webhooks message identifier. Equals the event id in the body and is the consumer’s idempotency key.

webhook-timestamp
required
string
/^[0-9]+$/

Unix seconds at which the delivery was signed. Reject a timestamp outside a five-minute tolerance.

webhook-signature
required
string
/^v1,[A-Za-z0-9+/=]+( v1,[A-Za-z0-9+/=]+)*$/

Space-separated list of v1, HMAC-SHA256 signatures over ... Accept the delivery when any entry matches.

Media typeapplication/json

Signed event delivered after the gateway durably records approval.

object
id
required

Event identifier, equal to the webhook-id header.

string
/^event_[0-9a-hjkmnp-tv-z]{24,}$/
type
required
string
Allowed value: payment.succeeded
apiVersion
required

The current contract identity that rendered this delivered event.

string
Allowed value: 2026-10-01
occurredAt
required
string format: date-time
data
required
object
id
required

The Payment the event is about.

string
/^payment_[0-9a-hjkmnp-tv-z]{24,}$/
object
required
string
Allowed value: payment

The event was accepted.