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 the object field containing event-specific information.

ACCOUNT_VERIFICATION

Events related to bank account verification processes and status updates.

ACCOUNT_VERIFICATION.SUBMITTED

Triggered when a bank account verification request has been successfully submitted to the verification service.Object structure:

string (uuid)

required

Unique identifier of the verification request.

Example

{
  "id": "4d79092d-0366-46b5-8b9f-4efe361c780d"
}

ACCOUNT_VERIFICATION.COMPLETED

Triggered when account verification finishes successfully and the verification result is available.Object structure:

string (uuid)

required

Unique identifier of the verification request.

Example

{
  "id": "4d79092d-0366-46b5-8b9f-4efe361c780d"
}

ACCOUNT_VERIFICATION.FAILED

Triggered when account verification fails due to some issue.Object structure:

string (uuid)

required

Unique identifier of the verification request.

Example

{
  "id": "4d79092d-0366-46b5-8b9f-4efe361c780d"
}

RECIPIENT

Events related to Beneficiary Hub recipient management and lifecycle operations.

RECIPIENT.CREATED

Triggered when an end-user successfully adds a new recipient.Object structure:

string (uuid)

required

Unique identifier of the newly created recipient.

externalUserId

string

required

Your system’s unique identifier for the user who added this recipient.

Example

{
  "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
  "externalUserId": "c6fd6330-6932-4678-abf8-600fe155909c"
}

RECIPIENT.UPDATED

Triggered when an end-user modifies any recipient information, including setting a new default recipient.Object structure:

string (uuid)

required

Unique identifier of the updated recipient.

externalUserId

string

required

Your system’s unique identifier for the user who updated this recipient.

Example

{
  "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
  "externalUserId": "d937f855-de7a-49dc-99ca-7d5f9f1f39e2"
}

RECIPIENT.DELETED

Triggered when an end-user removes a recipient.Object structure:

string (uuid)

required

Unique identifier of the deleted recipient.

externalUserId

string

required

Your system’s unique identifier for the user who deleted this recipient.

Example

{
  "id": "ed110f81-efab-434a-ba5f-0efcf5f11eeb",
  "externalUserId": "a70ea3bb-c677-4af5-9ee3-ff11f96cb433"
}

Get Started

Payment Preparation

Beneficiary Hub

Gamgem

Webhooks

Available events

Event types by model

ACCOUNT_VERIFICATION

RECIPIENT

Get Started

Payment Preparation

Beneficiary Hub

Gamgem

Webhooks

​Available events

​Event types by model

​ACCOUNT_VERIFICATION

​RECIPIENT

Available events

Event types by model

ACCOUNT_VERIFICATION

RECIPIENT