Patient RefundsV1

Get patient refund

Beta
GET
https://api.joincandidhealth.com/api/patient-refunds/v1/:patient_refund_id

Retrieves a previously created patient refund by its patient_refund_id.

Path parameters

patient_refund_id
UUID

Response

This endpoint return an object.
patient_refund_id
UUID
organization_id
UUID
refund_source
enum
amount_cents
integer
patient_external_id
string
allocations
list of objects
source_internal_id
optional string
refund_timestamp
optional datetime
refund_note
optional string
invoice
optional UUID
refund_reason
optional enum
Allowed values: OVERCHARGED
GET
/api/patient-refunds/v1/:patient_refund_id
curl https://api.joincandidhealth.com/api/patient-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
-H "Authorization: Bearer <token>"
Response
{
"patient_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"refund_source": "MANUAL_ENTRY",
"amount_cents": 0,
"patient_external_id": "string",
"allocations": [
{
"amount_cents": 0,
"target": {
"type": "service_line",
"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
}
],
"source_internal_id": "string",
"refund_timestamp": "2023-01-01T00:00:00Z",
"refund_note": "string",
"invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"refund_reason": "OVERCHARGED"
}