post

wbhk

paysquad.failed

This is the event sent when a Paysquad expires before the contribution goal has been reached

The PaySquad failed event sends the information about a failed PaySquad to your server. This can generally happen when the total amount hasn't been reached before the expiry of the PaySquad or if the anchor hasn't paid their contribution.

Payload

Sent when a Paysquad ends in Failed status, either because no contributions were made (abandoned) or the total was not met by the expiry (expired).

paySquadId

uuid

The ID of the Paysquad that failed.

reason

string | null

enum

High-level failure reason.

Allowed:

subReason

string | null

enum

Optional secondary reason, mirroring Stripe refund reasons. Null in most failure cases.

Allowed:

eventName

string | null

The event type. Always paysquad.failed for this payload.

Headers

X-Paysquad-Signature

string

required

The signature for this webhook. This should be validated against the provided webhook signing key to ensure the webhook is valid.

X-Paysquad-Environment

string

enum

required

The Paysquad environment this webhook originates from, so you can know which signing key to use.

Allowed:

Response

200

Return a 200 status to indicate that the data was received successfully

Loading…