Payment Link Requested

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

Method: POST

{
  "service": "appointment",
  "event": "receipt_payment.requested",
  "event_time": 1784875356443,
  "transaction_id": "d-486ddbf4-a22b-4266-8420-167191b7d370:receipt_payment.requested:1784875356443",
  "business_id": "7178133497043052",
  "data": {
    "appointment_id": "d-486ddbf4-a22b-4266-8420-167191b7d370",
    "doctor_id": "do1783067124676",
    "patient_id": "178487533949192",
    "net_amount": 850,
    "url": "https://payment.eka.care/payment_checkout?transaction_id=345rjeklfsdf"
  }
}