Home
Home
  1. Webhooks
  • Welcome
    • About Ontime
    • Overview
    • Test and Learn Projects
  • Authentication
  • Availability Check
    • Light Availability Check
      POST
    • Full Availability Check
      POST
  • Payment Management
    • Mandates
      • Create a new mandate
      • Cancel an existing mandate
      • Get a Mandate
      • Get many Mandates
    • Payment Requests
      • Instruct a new payment request
      • Cancel an existing payment request
      • Get a Payment
      • Get many Payments
  • Payouts
    • Get a Payout
      GET
    • Get Available Payouts
      GET
  • Webhooks
    • Mandate Created/Updated
    • Payment Request Created/Updated
    • Payout Created
  1. Webhooks

Payout Created

Introduction#

The payout.created webhook notifies the biller when a payout has been created and the resulting bank transfer instructed.
INFO
All Ontime amounts are expected and presented in the lowest common denominator for the currency. In our example: 500000 = 500000p = £5000

🔹 Webhook Event Format#

All Ontime webhooks share a consistent structure with a top-level event object.
Webhook

WebhookPayoutPayload

{
    "event_id": "8f3e1d97-1234-4abc-9876-abcdef123456",
    "event_type": "payment_request.updated",
    "event_timestamp": "2024-03-02T15:30:00Z",
    "payload": {
        "payout_reference": "3a36693e84d9",
        "total_amount": "500000",
        "currency": "GBP"
    }
}
Previous
Payment Request Created/Updated