Beta

Create patient refund

POST

/api/patient-refunds/v1

POST

1 curl -X POST https://api.joincandidhealth.com/api/patient-refunds/v1 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "amount_cents": 0,
6   "patient_external_id": "string",
7   "allocations": [
8     {
9       "amount_cents": 0,
10       "target": {
11         "type": "service_line_by_id",
12         "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
13       }
14     }
15   ]
16 }'

Play

200Successful

1 {
2   "patient_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4   "refund_source": "MANUAL_ENTRY",
5   "amount_cents": 0,
6   "patient_external_id": "string",
7   "allocations": [
8     {
9       "amount_cents": 0,
10       "target": {
11         "type": "service_line",
12         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
13         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
15       }
16     }
17   ],
18   "source_internal_id": "string",
19   "refund_timestamp": "2023-01-01T00:00:00Z",
20   "refund_note": "string",
21   "invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
22   "refund_reason": "OVERCHARGED"
23 }

Creates a new patient refund record and returns the newly created PatientRefund object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.

Request

This endpoint expects an object.

amount_centsintegerRequired

patient_external_idstringRequired

allocationslist of objectsRequired

refund_timestampdatetimeOptional

refund_notestringOptional

invoiceUUIDOptional

refund_reasonenumOptional

Allowed values:

Response

This endpoint returns an object.

patient_refund_idUUID

organization_idUUID

refund_sourceenum

amount_centsinteger

patient_external_idstring

allocationslist of objects

source_internal_idstringOptional