PaySway webhook events are organized by model types, where each event type follows the format MODEL.ACTION. This structure helps you understand which part of the system triggered the event and what action occurred.

Available events

Model typeEvent types
ACCOUNT_VERIFICATIONACCOUNT_VERIFICATION.SUBMITTED, ACCOUNT_VERIFICATION.COMPLETED, ACCOUNT_VERIFICATION.FAILED
RECIPIENTRECIPIENT.CREATED, RECIPIENT.UPDATED, RECIPIENT.DELETED

Event types by model

The following sections document each event type and its specific data structure. Each event object is nested within the standard webhook payload structure, with unique data in the object field containing event-specific information.

ACCOUNT_VERIFICATION

Events related to bank account verification processes and status updates.

RECIPIENT

Events related to Beneficiary Hub recipient management and lifecycle operations.