Sign in
v4

Create patient payment

Creates a new patient payment record and returns the newly created PatientPayment object. The allocations can describe whether the payment is being applied toward a specific service line, claim, or billing provider.

post/api/patient-payments/v4

Headers

Authorizationstring required

OAuth authentication

Request body

amount_centsinteger required
payment_timestampstring date-time
payment_notestring
patient_external_idstring required
invoicestring uuid
payment_method_detailV4PaymentMethodDetailCreate — unresolved $ref
payment_source'MANUAL_ENTRY' | 'PHREESIA' | 'SHERPA_HEALTH' | 'LOCKBOX'

Allowed payment sources when creating a patient payment via the API.

source_internal_idstring

Response

Response with status 200

V4PatientPayment required— unresolved $ref

Changes

Changed in 2 of the 5 revisions of this API.2

  • 293f25b8a5c71See the full diff
    • ○

      added the new LOCKBOX enum value to the request property payment_source

      request-property-enum-value-added

  • bb0d15478d651See the full diff
    • ○

      added the new optional request property allocation_restrictions

      new-optional-request-property