Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paysway.io/llms.txt

Use this file to discover all available pages before exploring further.

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. 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.
Triggered when a bank account verification request has been successfully submitted to the verification service.For detailed field definitions, see API Reference.
Example
{
  "id": "d53d164b-47bb-4aff-9e6a-94917c824d8a",
  "createdDate": "2025-09-19T11:19:55.194333Z",
  "updatedDate": "2025-09-19T11:19:55.194333Z",
  "state": "PENDING"
}
Triggered when account verification finishes successfully and the verification result is available.For detailed field definitions, see API Reference.
Example
{
  "id": "d53d164b-47bb-4aff-9e6a-94917c824d8a",
  "createdDate": "2025-09-19T11:19:55.194333Z",
  "updatedDate": "2025-09-19T11:19:56.114042Z",
  "state": "COMPLETED",
  "result": {
    "accountStatus": "ACTIVE",
    "accountHolderName": {
      "verifiedName": "LE*** ZA****"
    }
  }
}
Triggered when account verification fails due to some issue.For detailed field definitions, see API Reference.
Example
{
  "id": "d53d164b-47bb-4aff-9e6a-94917c824d8a",
  "createdDate": "2025-09-19T11:19:55.194333Z",
  "updatedDate": "2025-09-19T11:19:56.114042Z",
  "state": "FAILED",
  "failureReason": "UNAVAILABLE_FINANCIAL_INSTITUTION"
}

​
RECIPIENT

Events related to Beneficiary Hub recipient management and lifecycle operations.
Triggered when an end-user successfully adds a new recipient.For detailed field definitions, see API Reference.
Example
{
  "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
  "externalUserId": "c6fd6330-6932-4678-abf8-600fe155909c"
}
Triggered when an end-user modifies any recipient information, including setting a new default recipient.For detailed field definitions, see API Reference.
Example
{
  "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
  "externalUserId": "d937f855-de7a-49dc-99ca-7d5f9f1f39e2"
}
Triggered when an end-user removes a recipient.For detailed field definitions, see API Reference.
Example
{
  "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
  "externalUserId": "a70ea3bb-c677-4af5-9ee3-ff11f96cb433"
}