Webhook: payment.declined

POST

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

Parameters

Header parameters

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.

Request body^required

Media typeapplication/json

Signed event delivered once for each attempt the provider definitively declines. The Payment stays open for another attempt until it expires; retrieve it for lastDecline, or for a split share’s split.parts[].lastDecline.

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.declined

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

Responses

2XX

2XX

The event was accepted.