Sign in

Webhook event: payout.event.v1

Triggered throughout the payout lifecycle to indicate status changes and important events. This includes successful processing, failed attempts, rail selection optimization, and final settlement status.

postWebhookpayout.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": "payout.event.v1",
  "event_id": "85df84c7-a298-44bc-8040-7bd2ae372cbf",
  "account_id": "857c679a-8e80-47f1-9334-39dd08ea801f",
  "data": {
    "related_payments": {
      "aa30db0d-2bda-452a-902d-cdd6a217ed4c": "resubmit",
      "f76040f5-3e77-4284-8719-98cfda13c91c": "refund"
    }
  }
}

Response

Webhook processed successfully

Changes