Beta

Get insurance refund

GET

/api/insurance-refunds/v1/:insurance_refund_id

GET

1 curl https://api.joincandidhealth.com/api/insurance-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>"

Play

200Retrieved

1 {
2   "insurance_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "payer": {
4     "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5     "payer_id": "string",
6     "payer_name": "string",
7     "availity_payer_name": "string",
8     "availity_claims_payer_id": "string",
9     "availity_eligibility_id": "string",
10     "availity_remittance_payer_id": "string",
11     "street_address": {
12       "address1": "string",
13       "city": "string",
14       "state": "AA",
15       "zip_code": "string",
16       "zip_plus_four_code": "string",
17       "address2": "string"
18     }
19   },
20   "amount_cents": 0,
21   "allocations": [
22     {
23       "amount_cents": 0,
24       "target": {
25         "type": "service_line",
26         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
27         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
28         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
29       }
30     }
31   ],
32   "refund_timestamp": "2023-01-01T00:00:00Z",
33   "refund_note": "string",
34   "refund_reason": "OVERCHARGED"
35 }

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_idUUIDRequired

Response

This endpoint returns an object.

insurance_refund_idUUID

payerobject

amount_centsinteger

allocationslist of objects

refund_timestampdatetimeOptional

refund_notestringOptional

refund_reasonenumOptional

Allowed values:

Get insurance refund

Path parameters

Headers

Response

Errors