Payout status update webhook

Called by Peach Payments to notify of payout status updates.
Applies to all payout methods: realtime-eft and mobile money.
Mobile money payout status transitions are driven by background polling.

Payload

A payout status notification sent for all payout methods (realtime-eft and mobile money) when a payout state changes.

string
enum
required

The current state of the payout.

Allowed:
string
required
length between 36 and 36
^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}$

A valid v4 UUID expressed in lowercase with dashes.

string
required

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

string
required
length between 12 and 12
^2[0-9]{3}\.[0-9]{3}\.[0-9]{3}$

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

Response
200

Payout status notification received.

LoadingLoading…