---
title: "Get patient refund"
method: GET
path: "/api/patient-refunds/v1/{patient_refund_id}"
tags: ["v1"]
---

# Get patient refund

`GET /api/patient-refunds/v1/{patient_refund_id}`

## Request

- Base URL: `https://pre-api.joincandidhealth.com`
- URL: `https://pre-api.joincandidhealth.com/api/patient-refunds/v1/{patient_refund_id}`
- Auth: HTTP bearer

Retrieves a previously created patient refund by its `patient_refund_id`.

## Path parameters

- `patient_refund_id` string, uuid, required

## Response `200`

Response with status 200

- PatientRefundsV1PatientRefund
  - `patient_refund_id` string, uuid, required
  - `organization_id` string, uuid, required
  - `source_internal_id` string
  - `refund_source` 'MANUAL_ENTRY' | 'CHARGEBEE' | 'SQUARE' | 'STRIPE' | 'ELATION' | 'CEDAR' | 'HEALTHIE' | 'REALLOCATION' | 'PHREESIA' | 'INSTAMED' | 'SHERPA_HEALTH' | 'LOCKBOX', required
  - `amount_cents` integer, required
  - `patient_external_id` string, required
  - `refund_timestamp` string, date-time
  - `refund_note` string
  - `allocations` FinancialsAllocation[], required
    - `allocation_id` string, uuid
    - `amount_cents` integer, required
    - `target` union, required: Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.
      - object
        - `type` 'service_line', required: Discriminator value: service_line
        - `service_line_id` string, uuid, required
        - `claim_id` string, uuid, required
        - `encounter_id` string, uuid, required
      - object
        - `type` 'claim', required: Discriminator value: claim
        - `claim_id` string, uuid, required
        - `encounter_id` string, uuid, required
      - object
        - `type` 'billing_provider_id', required: Discriminator value: billing_provider_id
        - `billing_provider_id` string, uuid, required
      - object
        - `type` 'appointment', required: Discriminator value: appointment
        - `appointment_id` string, required
        - `patient_external_id` string, required
      - object
        - `type` 'unattributed', required: Discriminator value: unattributed
    - `earmark` FinancialsBalanceEarmark: Represents an active balance earmarking record that holds allocated funds for future auto-allocation. Earmarks are created when funds are allocated but should be held for a specific encounter or date of service. Only active (non-deleted) earmarks are returned.
      - `id` string, uuid, required
      - `target` union, required: If enabled for your organization, defines how a patient prepayment allocation should be earmarked for future auto-allocation. Earmarks hold the allocation until a matching encounter is created, then attempt to allocate to that encounter. Only applicable for unattributed allocations.
        - object: Earmark for auto-allocation to an encounter with this specific date of service
          - `type` 'date_of_service', required: Discriminator value: date_of_service
          - `value` string, required: ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
        - object: Earmark for auto-allocation to an encounter with this specific external ID (more specific than date of service)
          - `type` 'external_encounter_id', required: Discriminator value: external_encounter_id
          - `value` string, required
      - `amount_earmarked_cents` integer: The amount earmarked in cents for future allocation
      - `created_by_allocation_id` string, uuid
    - `allocated_on` string, date-time
  - `invoice` string, uuid
  - `refund_reason` 'OVERCHARGED' | 'ENTERED_IN_ERROR' | 'TRANSFER'

## Other responses

- `403`: Error response with status 403
- `404`: Error response with status 404

## Changes

- **2026-09-17** `24b2d80d577a`: 1 breaking, 1 warning, 13 info
  - the response's body type changed from no type to `object` for status `200`
  - deleted the `header` request parameter `Authorization`
  - the endpoint scheme security `OAuthScheme` was added to the API
  - for the `path` request parameter `patient_refund_id`, the type was generalized from no type to `string`, and format from no format to `uuid`
  - …11 more
- **2026-09-12** `3a81ee81d4ed`: 1 info
  - api operation id `get` removed and replaced with `v1_get_10`

[Operation history](https://skmtc.dev/joincandidhealth/apis/api-reference/changes/api/patient-refunds/v1/:patient_refund_id/get.md)

---

[API](https://skmtc.dev/joincandidhealth/apis/api-reference.md) - [All operations](https://skmtc.dev/joincandidhealth/apis/api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/joincandidhealth/apis/api-reference/revisions/d8b0a61873e2?raw)