Insurance RefundsV1

Get insurance refund

Beta
GET
https://api.joincandidhealth.com/api/insurance-refunds/v1/:insurance_refund_id

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

Path parameters

insurance_refund_id
UUID

Response

This endpoint return an object.
insurance_refund_id
UUID
payer
object
amount_cents
integer
allocations
list of objects
refund_timestamp
optional datetime
refund_note
optional string
refund_reason
optional enum
Allowed values: OVERCHARGED
GET
/api/insurance-refunds/v1/:insurance_refund_id
curl https://api.joincandidhealth.com/api/insurance-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
-H "Authorization: Bearer <token>"
Response
{
"insurance_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payer": {
"payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payer_id": "string",
"payer_name": "string"
},
"amount_cents": 0,
"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"
}
}
],
"refund_timestamp": "2023-01-01T00:00:00Z",
"refund_note": "string",
"refund_reason": "OVERCHARGED"
}