> ## 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.

# 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-submitted), [`ACCOUNT_VERIFICATION_COMPLETED`](#account-verification-completed), [`ACCOUNT_VERIFICATION_FAILED`](#account-verification-failed) |
| `RECIPIENT`            | [`RECIPIENT_CREATED`](#recipient-created), [`RECIPIENT_UPDATED`](#recipient-updated), [`RECIPIENT_DELETED`](#recipient-deleted)                                                                         |

## Event types by model

The following sections document each event type.
Each event object is nested within the standard webhook [payload structure](/webhooks/implement-handler#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.

<AccordionGroup>
  <Accordion title="ACCOUNT_VERIFICATION_SUBMITTED">
    Triggered when a bank account verification request has been successfully submitted to the verification service.

    For detailed field definitions, see [API Reference](/api-reference/payment-preparation/account-verification-events).

    ```json Example theme={null}
    {
      "id": "d53d164b-47bb-4aff-9e6a-94917c824d8a",
      "createdDate": "2025-09-19T11:19:55.194333Z",
      "updatedDate": "2025-09-19T11:19:55.194333Z",
      "state": "PENDING"
    }
    ```
  </Accordion>

  <Accordion title="ACCOUNT_VERIFICATION_COMPLETED">
    Triggered when account verification finishes successfully and the verification result is available.

    For detailed field definitions, see [API Reference](/api-reference/payment-preparation/account-verification-events).

    ```json Example theme={null}
    {
      "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****"
        }
      }
    }
    ```
  </Accordion>

  <Accordion title="ACCOUNT_VERIFICATION_FAILED">
    Triggered when account verification fails due to some issue.

    For detailed field definitions, see [API Reference](/api-reference/payment-preparation/account-verification-events).

    ```json Example theme={null}
    {
      "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"
    }
    ```
  </Accordion>
</AccordionGroup>

### RECIPIENT

Events related to Beneficiary Hub recipient management and lifecycle operations.

<AccordionGroup>
  <Accordion title="RECIPIENT_CREATED">
    Triggered when an end-user successfully adds a new recipient.

    For detailed field definitions, see [API Reference](/api-reference/beneficiary-hub/recipient-events).

    ```json Example theme={null}
    {
      "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
      "externalUserId": "c6fd6330-6932-4678-abf8-600fe155909c"
    }
    ```
  </Accordion>

  <Accordion title="RECIPIENT_UPDATED">
    Triggered when an end-user modifies any recipient information, including setting a new default recipient.

    For detailed field definitions, see [API Reference](/api-reference/beneficiary-hub/recipient-events).

    ```json Example theme={null}
    {
      "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
      "externalUserId": "d937f855-de7a-49dc-99ca-7d5f9f1f39e2"
    }
    ```
  </Accordion>

  <Accordion title="RECIPIENT_DELETED">
    Triggered when an end-user removes a recipient.

    For detailed field definitions, see [API Reference](/api-reference/beneficiary-hub/recipient-events).

    ```json Example theme={null}
    {
      "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
      "externalUserId": "a70ea3bb-c677-4af5-9ee3-ff11f96cb433"
    }
    ```
  </Accordion>
</AccordionGroup>
