Patient Payment V2
V2 additive patient payment (or refund with negative amount) by claimLifecycleId. Without claimLifecycleId, patientFhirId creates an unallocated credit. Temporarily disabled (503) while payment/ledger work continues.
Overview
Additive patient payment API keyed byclaimLifecycleId (or patientFhirId for unallocated credit). Negative paymentAmount records a refund (floored at $0 paid). Overpayments create unallocated patient credits. Self-pay claims also update the patient ledger.
This endpoint is temporarily disabled and returns 503 while payment/ledger work continues. For live Elation billId posts, use Patient Payment.
Use Cases
- Payment Processing Integration: Integrate with payment processors to automatically record patient payments
- EHR Integration: Connect with EHR systems that know
claimLifecycleId - Partial payments: Post any positive amount less than remaining PR
- Refunds: Post a negative
paymentAmountwithnotes - Unallocated credits: Omit
claimLifecycleIdand passpatientFhirIdto create wallet credit
Authentication
This endpoint requires JWT access token authentication. First, obtain an access token by calling the/api/token endpoint with your clientId and clientSecret:
Request Body
patientFhirId only.claimLifecycleId is not provided. Creates an unallocated
patient credit (positive paymentAmount only).notes required).pi_*).paymentAmount < 0). Optional otherwise.Example Request
Response
Temporarily Disabled (503)
Success Response (200) — when re-enabled
excessAmount / excessCreditId appear only on overpay. refundAmount appears only for refunds.
Error Responses
- 400 — validation errors, refund exceeds paid, missing notes on refund
- 401 — invalid/missing token
- 404 — claim / organization not found
- 503 — API temporarily disabled (current)
Payment Processing Logic
- Resolve claim via
claimLifecycleId - Add
paymentAmountto current lifecycle paid (or subtract for refunds) - Cap positive payments at patient responsibility; excess → unallocated
PatientCredit - Sync
PatientPaymentDetails, FHIRPaymentReconciliation, and (self-pay) ledger - Refunds append
PatientRefundLogand never create negative claim paid
Related Endpoints
Body
Patient payment information
Non-zero USD amount. Positive = additive payment; negative = refund (notes required).
Cair claim lifecycle id. Required for claim-targeted payments.
1Required when claimLifecycleId is not provided (unallocated credit).
ISO 8601 date string. Defaults to current date if omitted.
Payment method (e.g., Credit Card, Stripe, Check)
Processor transaction id (e.g., Stripe pi_*)
Required for refunds (negative paymentAmount).

