PatientPaymentsV4

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.

post/api/patient-payments/v4

Request

  • Base URL: https://api.taigabilling.com
  • URL: https://api.taigabilling.com/api/patient-payments/v4
  • Auth: HTTP bearer

Request body

OR

Response

patient_payment_idstring uuid required
organization_idstring uuid required
source_internal_idstring nullable
payment_source'MANUAL_ENTRY' | 'CHARGEBEE' | 'SQUARE' | 'STRIPE' | 'ELATION' | 'CEDAR' | 'HEALTHIE' | 'REALLOCATION' | 'PHREESIA' | 'INSTAMED' | 'SHERPA_HEALTH' | 'LOCKBOX' required
amount_centsinteger required
patient_external_idstring required
payment_timestampstring date-time nullable
payment_notestring nullable
invoicestring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.