Webhooks
Event types
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 type | Event types |
|---|---|
ACCOUNT_VERIFICATION | ACCOUNT_VERIFICATION.SUBMITTED, ACCOUNT_VERIFICATION.COMPLETED, ACCOUNT_VERIFICATION.FAILED |
RECIPIENT | RECIPIENT.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 theobject field containing event-specific information.
ACCOUNT_VERIFICATION
Events related to bank account verification processes and status updates.ACCOUNT_VERIFICATION.SUBMITTED
ACCOUNT_VERIFICATION.SUBMITTED
Triggered when a bank account verification request has been successfully submitted to the verification service.Object structure:
Unique identifier of the verification request.
Example
ACCOUNT_VERIFICATION.COMPLETED
ACCOUNT_VERIFICATION.COMPLETED
Triggered when account verification finishes successfully and the verification result is available.Object structure:
Unique identifier of the verification request.
Example
ACCOUNT_VERIFICATION.FAILED
ACCOUNT_VERIFICATION.FAILED
Triggered when account verification fails due to some issue.Object structure:
Unique identifier of the verification request.
Example
RECIPIENT
Events related to Beneficiary Hub recipient management and lifecycle operations.RECIPIENT.CREATED
RECIPIENT.CREATED
RECIPIENT.UPDATED
RECIPIENT.UPDATED