API Reference
  1. Paysquad Webhooks API

Paysquad Succeeded Event

wbhk
paysquad.succeeded

This event is sent when the basket total has been paid by all cumulative contribution(s) and the payment status changes to ‘complete’.

This event is triggered when a PaySquad is completed, once all of the contributions have been made and the total amount has been reached (along with payments processing completely). Once you have received this, you should use the Get Paysquad endpoint to validate this status.

Payload

A webhook sent when a Paysquad completes successfully

uuid

The ID of the Paysquad has been completed

string | null

The type of webhook

Headers
string
required

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

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

Updated almost 2 years ago

What’s Next
LoadingLoading…

Updated almost 2 years ago

What’s Next