v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-1770249709.0 KB

Webhook event: paykey.event.v1

Triggered when there are important updates to a Paykey's status or associated bank account. This includes verification status changes, fraud detection alerts, or modifications to usage permissions.

postWebhookpaykey.event.v1

Payload

event_typestring required

Type of the event

event_idstring uuid required

UUID of the event

account_idstring uuid required

UUID of the account associated with this event

Example payload

{
  "event_type": "paykey.event.v1",
  "event_id": "85df84c7-a298-44bc-8040-7bd2ae372cbf",
  "account_id": "857c679a-8e80-47f1-9334-39dd08ea801f"
}

Response

Webhook processed successfully