For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
        • GETGet insurance refunds
        • GETGet insurance refund
        • POSTCreate insurance refund
        • PATCHUpdate
        • DELDelete insurance refund
Contact Sales
LogoLogo
API ReferenceInsurance RefundsV1

Get insurance refunds

Beta
GET
/api/insurance-refunds/v1
GET
/api/insurance-refunds/v1
$curl https://api.joincandidhealth.com/api/insurance-refunds/v1 \
>     -H "Authorization: Bearer <token>"
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": "payer_id",
8        "payer_name": "payer_name",
9        "availity_payer_name": "availity_payer_name",
10        "availity_claims_payer_id": "availity_claims_payer_id",
11        "availity_eligibility_id": "availity_eligibility_id",
12        "availity_remittance_payer_id": "availity_remittance_payer_id",
13        "street_address": {
14          "address1": "address1",
15          "city": "city",
16          "state": "AA",
17          "zip_code": "zip_code",
18          "zip_plus_four_code": "zip_plus_four_code",
19          "address2": "address2"
20        }
21      },
22      "amount_cents": 1,
23      "allocations": [
24        {
25          "amount_cents": 1,
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          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
33          "earmark": {
34            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
35            "target": {
36              "type": "date_of_service",
37              "value": "target"
38            },
39            "amount_earmarked_cents": 1,
40            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
41          },
42          "allocated_on": "2024-01-15T09:30:00Z"
43        },
44        {
45          "amount_cents": 1,
46          "target": {
47            "type": "service_line",
48            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
49            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
50            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
51          },
52          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
53          "earmark": {
54            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
55            "target": {
56              "type": "date_of_service",
57              "value": "target"
58            },
59            "amount_earmarked_cents": 1,
60            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
61          },
62          "allocated_on": "2024-01-15T09:30:00Z"
63        }
64      ],
65      "refund_timestamp": "2024-01-15T09:30:00Z",
66      "refund_note": "refund_note",
67      "refund_reason": "OVERCHARGED"
68    },
69    {
70      "insurance_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
71      "payer": {
72        "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
73        "payer_id": "payer_id",
74        "payer_name": "payer_name",
75        "availity_payer_name": "availity_payer_name",
76        "availity_claims_payer_id": "availity_claims_payer_id",
77        "availity_eligibility_id": "availity_eligibility_id",
78        "availity_remittance_payer_id": "availity_remittance_payer_id",
79        "street_address": {
80          "address1": "address1",
81          "city": "city",
82          "state": "AA",
83          "zip_code": "zip_code",
84          "zip_plus_four_code": "zip_plus_four_code",
85          "address2": "address2"
86        }
87      },
88      "amount_cents": 1,
89      "allocations": [
90        {
91          "amount_cents": 1,
92          "target": {
93            "type": "service_line",
94            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
95            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
96            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
97          },
98          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
99          "earmark": {
100            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
101            "target": {
102              "type": "date_of_service",
103              "value": "target"
104            },
105            "amount_earmarked_cents": 1,
106            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
107          },
108          "allocated_on": "2024-01-15T09:30:00Z"
109        },
110        {
111          "amount_cents": 1,
112          "target": {
113            "type": "service_line",
114            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
115            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
116            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
117          },
118          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
119          "earmark": {
120            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
121            "target": {
122              "type": "date_of_service",
123              "value": "target"
124            },
125            "amount_earmarked_cents": 1,
126            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
127          },
128          "allocated_on": "2024-01-15T09:30:00Z"
129        }
130      ],
131      "refund_timestamp": "2024-01-15T09:30:00Z",
132      "refund_note": "refund_note",
133      "refund_reason": "OVERCHARGED"
134    }
135  ],
136  "next_page_token": "next_page_token",
137  "prev_page_token": "prev_page_token"
138}

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

Was this page helpful?
Previous

Get insurance refund

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

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_tokenstring
prev_page_tokenstring

Errors

403
Unauthorized Error
422
Unprocessable Entity Error