POST /api/webhooks/patient-payment

Changed on

Elation-specific webhook: absolute-set patient payment by billId. Caps at ledger paid + remaining PATIENT_AR; excess is unallocated PATIENT_CASH.

Request

  • Base URL
    https://forecaster.cairhealth.com
  • URL
    https://forecaster.cairhealth.com/api/webhooks/patient-payment
  • Auth
    none required

Request body

billIdstring required

Elation bill.id that maps to Claim.identifier with system 'https://fhir.cairhealth.com/fhir/identifier/claim-id'

paymentAmountnumber required

Payment amount in USD

paymentDatestring date

ISO 8601 date string (e.g., '2024-01-15'). Defaults to current date if not provided.

paymentMethodstring

Payment method (e.g., 'Credit Card', 'Debit Card', 'Stripe', 'Check', 'Cash')

paymentTraceIdstring

Stripe payment intent ID or transaction ID (e.g., 'pi_1234567890')

Response

Payment processed successfully

successboolean required

Indicates whether the payment was processed successfully

messagestring required

Success message

Changes

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status