CAcairhealth

POST /api/webhooks/patient-payment-v2

Changed on

Additive patient payment (or refund with negative amount) by claimControlNumber. Without claimControlNumber, patientId creates an unallocated PATIENT_CASH credit. Caps at ledger paid + remaining PATIENT_AR. paymentTraceId is required; retries return the prior result.

Request

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

Request body

claimControlNumberstring

Claim control number (claim-id / PCN). Required for claim-targeted payments.

patientIdstring

External patient id. Uses org patients.patientIdentifierSystem when configured; otherwise https://fhir.cairhealth.com/fhir/identifier/customer-patient-id. Required when claimControlNumber is not provided (unallocated credit).

paymentAmountnumber required

Non-zero USD amount. Positive = additive payment; negative = refund (notes required).

paymentDatestring date

ISO 8601 date string. Defaults to current date if omitted.

paymentMethodstring

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

paymentTraceIdstring required

Required processor transaction id. Same org + trace returns prior 200 without duplicate post.

notesstring

Required for refunds (negative paymentAmount).

Response

Payment or credit processed successfully (or idempotent replay)

successboolean required
messagestring required
idempotentReplayboolean

Changes