Skip to main content
PATCH
cURL

Overview

Absolutely updates an existing patient payment on a claim lifecycle (PatientPaymentDetails + patientPaidAmount). Returns 404 if no prior payment exists for that lifecycle. Overpayment above patient responsibility creates an unallocated credit. This is an edit path, not an additive post. To add a partial payment or refund, use Patient Payment.

Authentication

JWT Bearer token from /api/token.

Path Parameters

string
required
Cair claim lifecycle id.

Request Body

number
required
Absolute paid amount to set (>= 0).
string
ISO 8601 payment date.
string
Payment method.
string
Processor transaction id.

Example

Response

Path Parameters

claimLifecycleId
string
required

Body

application/json
paymentAmount
number
required

Absolute paid amount to set

Required range: x >= 0
paymentDate
string<date>
paymentMethod
string
paymentTraceId
string

Response

Payment updated