JOjoincandidhealth
v4

Create patient payment

Changed on

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

Request

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

Request body

amount_centsinteger required
payment_timestampstring date-time
payment_notestring
patient_external_idstring required
invoicestring uuid
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

patient_payment_idstring uuid required
organization_idstring uuid required
source_internal_idstring
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
payment_notestring
invoicestring uuid

Changes

  • 24b2d80d577aRevision changes
    • breaking

      added the new required request property /

    • breaking

      the request property type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id create removed and replaced with v4_create