---
title: "Payment Link Requested"
method: POST
path: "/registered_url_for_receipt_payment_requested_events"
tags: ["Receipt Webhooks"]
---

# Payment Link Requested

`POST /registered_url_for_receipt_payment_requested_events`

When a payment link is requested against an appointment, a webhook event is sent to the registered endpoint containing the appointment ID, doctor ID, patient ID, net amount and the payment checkout URL.

The receiving system can share the `url` with the patient to let them complete the payment, or use the other identifiers to reconcile the request in their own system.

**Field Definitions**

• **service**: string - The type of service. For this event, this will be `appointment`.

• **event**: string - The type of event. For a payment link request, this will be `receipt_payment.requested`.

• **event_time**: integer - Event occurrence timestamp in milliseconds.

• **transaction_id**: string - Unique transaction identifier for the event.

• **timestamp**: integer - Timestamp of the event.

• **business_id**: string - The eka ID of the business.

• **client_id**: string - Client ID associated with the event.

• **data**: object - Contains detailed information about the payment request.

• **appointment_id**: string - Unique identifier for the appointment.

• **doctor_id**: string - Unique identifier for the doctor.

• **patient_id**: string - Unique identifier for the patient.

• **net_amount**: number - Net payable amount for which the payment link is generated.

• **url**: string - Payment checkout URL to be shared with the patient to complete the payment.

**Example Webhook Request**

**Endpoint:** [https://your-registered-webhook-url.com](https://your-registered-webhook-url.com)

**Method:** POST

## Request body

- object
  - `service` string, required — Type of service
  - `event` 'receipt_payment.requested', required — Type of event
  - `event_time` integer, required — Event occurrence timestamp in milliseconds
  - `transaction_id` string, required — Unique transaction identifier for the event
  - `timestamp` integer, required — Timestamp of the event
  - `business_id` string, required — Business ID for the payment request
  - `client_id` string — Client ID for the payment request
  - `data` object, required
    - `appointment_id` string, required — Unique identifier for the appointment
    - `doctor_id` string, required — Unique identifier for the doctor
    - `patient_id` string, required — Unique identifier for the patient
    - `net_amount` number, required — Net payable amount for which the payment link is generated
    - `url` string, required — Payment checkout URL to be shared with the patient to complete the payment

## Response `200`

---

[API](https://skmtc.dev/eka/apis/eka-developer-apis.md) · [All operations](https://skmtc.dev/eka/apis/eka-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/eka/eka-developer-apis/revisions/9ea23456f722/schema)