Receipt Webhooks

Receipt Events

When a Receipt is created, updated or deleted, a webhook is sent to the registered endpoint containing the Doctor Id, Patient Id, Clinic Id etc. The receiving system can use these details as per their need.

post/registered_url_for_receipt_events

Request

Request body

event'receipt.created' | 'receipt.updated' | 'receipt.deleted' required

Type of event

event_timeinteger required

Event occurred timestamp

timestampinteger required

Timestamp of the event

client_idstring required

Client ID for the schedule

business_idstring required

Business ID for the schedule

Example request

{
  "event": "receipt.created",
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "67978400352a61001d64e9fb",
  "business_id": "174159057718553",
  "data": {
    "receipt_id": 2579,
    "aid": "d-75f3dcf1-5de3-40fc-8ccd-f42c8d54e8e8",
    "doctor_oid": "161467756044203",
    "clinic_id": "60b0ee0c0b5804795509aefb",
    "patient_oid": "176345969121476",
    "created_at": 1763476917560,
    "updated_at": 1763476917560,
    "receipt_url": "https://doc-receipt.s3.ap-south-1.amazonaws.com/v2/b-161467756044203/161467756044203/60b0ee0c0b5804795509aefb/1763476916985.pdf",
    "receipt_status": "SUCCESS",
    "receipt_amount": 120,
    "additional_discount_value": 10,
    "additional_discount_type": "AMOUNT",
    "additional_discount_amount": 10,
    "net_amount": 120,
    "name": "gc baby normal",
    "mobile": "+919008888888",
    "sku_discount_amount": 10,
    "amount_due": 10,
    "payment_id": "ret-dfwef-dsfsd-fwefdsf",
    "payment_link": "https://example.link.com",
    "amount_paid": 10,
    "actor": "doctor"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.