Beta

Get insurance refunds

GET

/api/insurance-refunds/v1

GET

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

Play

200Retrieved

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

Returns all insurance refunds satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.

Query parameters

limitintegerOptional

Defaults to 100. The value must be greater than 0 and less than 1000.

payer_uuidUUIDOptional

claim_idUUIDOptional

service_line_idUUIDOptional

billing_provider_idUUIDOptional

sortenumOptional

Defaults to refund_timestamp

Allowed values:

sort_directionenumOptional

Sort direction. Defaults to descending order if not provided.

Allowed values:

page_tokenstringOptional

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Get insurance refunds

Headers

Query parameters

Response

Errors