Webhooks

Float top-up webhook

Called by Peach Payments when a deposit is allocated to your float (same configured payouts webhook URL as payout status updates). Only sent when webhookOptions.floatAllocationUpdates is enabled. See the update webhook endpoints API for more details.

postWebhookfloatAllocationUpdated

Payload

currencystring required
lastTransactionDatestring date-time required

ISO 8601 timestamp of the latest account transaction used for the balance snapshot.

availableBalanceinteger required

Available float balance after the top-up, in smallest currency units (cents).

topupAmountinteger required

Amount credited from the allocated deposit(s), in smallest currency units (cents).

Example payload

{
  "currency": "ZAR",
  "availableBalance": 1234,
  "topupAmount": 1200
}

Response

Float allocation 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.