PEpeachpayments
Payouts

Payout status update webhook

Called by Peach Payments to notify of payout status updates.

postWebhookpayoutStatusUpdated

Payload

status'pending' | 'processing' | 'failed' | 'successful' | 'cancelled' | 'reversed' required

The current state of the payout.

payoutIdstring required

A valid v4 UUID expressed in lowercase with dashes.

lastUpdatedstring date-time required

The ISO-8601 timestamp of when the payout was last updated.

resultCodestring string required

The result code indicating the status or error of the payout.

Example payload

{
  "status": "processing",
  "payoutId": "84920878-fc32-494f-8e30-6a2465c9a456",
  "lastUpdated": "2024-03-14T22:00:00.000Z",
  "resultCode": "2900.000.003"
}

Response

Payout status notification received.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.