JOjoincandidhealth
v1

Create patient refund

Changed on

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

post/api/patient-refunds/v1

Request

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

Request body

amount_centsinteger required
refund_timestampstring date-time
refund_notestring
patient_external_idstring required
invoicestring uuid
refund_reason'OVERCHARGED' | 'ENTERED_IN_ERROR' | 'TRANSFER'
raise_on_overdraftboolean

If true, the refund will be rejected if it would cause any account to be overdrafted. Defaults to false.

Response

Response with status 200

patient_refund_idstring uuid required
organization_idstring uuid required
source_internal_idstring
refund_source'MANUAL_ENTRY' | 'CHARGEBEE' | 'SQUARE' | 'STRIPE' | 'ELATION' | 'CEDAR' | 'HEALTHIE' | 'REALLOCATION' | 'PHREESIA' | 'INSTAMED' | 'SHERPA_HEALTH' | 'LOCKBOX' required
amount_centsinteger required
patient_external_idstring required
refund_timestampstring date-time
refund_notestring
invoicestring uuid
refund_reason'OVERCHARGED' | 'ENTERED_IN_ERROR' | 'TRANSFER'

Changes

  • 24b2d80d577aRevision changes
    • 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 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 v1_create_10