v1

Updates the non-insurance payer refund record matching the provided non_insurance_payer_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.

patch/api/non-insurance-payer-refunds/v1/{non_insurance_payer_refund_id}

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/non-insurance-payer-refunds/v1/{non_insurance_payer_refund_id}
  • Auth
    HTTP bearer

Path parameters

non_insurance_payer_refund_idstring uuid required

Request body

refund_timestampstring date-time

Response

Response with status 200

non_insurance_payer_refund_idstring uuid required
amount_centsinteger required
refund_timestampstring date-time
refund_notestring
check_numberstring
refund_reason'OVERCHARGED' | 'ENTERED_IN_ERROR' | 'TRANSFER'
invoice_idstring uuid

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

      for the path request parameter non_insurance_payer_refund_id, the type was generalized from no type to string, and format from no format to uuid

    • 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

      api operation id update removed and replaced with v1_update_18