JOjoincandidhealth
v1

Get insurance refund

Changed on

Retrieves a previously created insurance refund by its insurance_refund_id. If the refund does not exist, a 403 will be thrown.

get/api/insurance-refunds/v1/{insurance_refund_id}

Request

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

Path parameters

insurance_refund_idstring uuid required

Response

Response with status 200

insurance_refund_idstring uuid required
amount_centsinteger required
refund_timestampstring date-time
refund_notestring
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

      for the path request parameter insurance_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 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 get removed and replaced with v1_get_20