Skip to navigation

Create patient payment

Records an already-collected patient payment. Each request may contain only claim_by_id allocations or only appointment_by_id_and_patient_external_id allocations; mixed target types are rejected. unattributed, service_line_by_id, claim_by_encounter_external_id, billing_provider_by_id, and malformed targets are unsupported. Claim and appointment payments require 1–25 positive allocations, a verified financial patient MRN, and exactly one in-scope billing_provider_npi allocation restriction; any service_facility_id restriction must also be in scope. Each claim must match both the patient and restricted NPI; every appointment must belong to the patient. For claim and appointment payments, unknown fields and invalid scope or target proofs are refused with 403 before creating a payment. See Creating patient payments for requirements and a minimal request.

Authentication

AuthorizationBearer
Send your Taiga API key as a Bearer token. Create and manage keys in the Taiga developer portal.

Request

This endpoint expects an object.
Claim paymentobjectRequired
OR
Appointment paymentobjectRequired

Response

patient_payment_idstringformat: "uuid"
organization_idstringformat: "uuid"
payment_sourceenum
amount_centsinteger
patient_external_idstring
allocationslist of objects
source_internal_idstring or nullOptional
payment_timestampdatetime or nullOptional
payment_notestring or nullOptional
invoicestring or nullOptionalformat: "uuid"
payment_method_detailobject or nullOptional

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error