Payment Request Created/Updated

Introduction

The payment_request.created and payment_request.updated webhook notifies the biller when a payment request has been created or the details updated within Ontime. Updates to the payment request may occur when:

The status of the payment request is updated e.g. Confirmed to PaidIn

The actual_amount is updated with the confirmed amount we are receiving from the customer

The expected_pay_date is updated to reflect any new information received by Ontime

You cancel the payment request

🔹 Webhook Event Format

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

Webhook

WebhookPaymentRequestPayload

{
    "event_id": "8f3e1d97-1234-4abc-9876-abcdef123456",
    "event_type": "payment_request.updated",
    "event_timestamp": "2024-03-02T15:30:00Z",
    "payload": {
        "payment_request_id": "5f537228-224f-4783-bfc9-928c2a0f33c8",
        "mandate_id": "12a3500a-eecf-47e2-8352-3a36693e84d9",
        "status": "Submitted"
    }
}

Payment Request Created/Updated

Introduction#

🔹 Webhook Event Format#

Introduction

🔹 Webhook Event Format