Get insurance payments

Beta

GET

/api/insurance-payments/v1

Returns all non-ERA originated insurance payments satisfying the search criteria

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 payment_timestamp

Allowed values: amount_centspayment_timestamppayment_note

sort_direction"asc" or "desc"Optional

Sort direction. Defaults to descending order if not provided.

Allowed values: ascdesc

page_tokenstringOptional

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Errors

GET

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

1 {
2   "items": [
3     {
4       "insurance_payment_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       },
14       "amount_cents": 0,
15       "allocations": [
16         {
17           "amount_cents": 0,
18           "target": {
19             "type": "service_line",
20             "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
21             "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
22             "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
23           }
24         }
25       ],
26       "payment_timestamp": "2023-01-01T00:00:00Z",
27       "payment_note": "string"
28     }
29   ],
30   "next_page_token": "string",
31   "prev_page_token": "string"
32 }

Built with

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

1	{
2	"items": [
3	{
4	"insurance_payment_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	},
14	"amount_cents": 0,
15	"allocations": [
16	{
17	"amount_cents": 0,
18	"target": {
19	"type": "service_line",
20	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
21	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
22	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
23	}
24	}
25	],
26	"payment_timestamp": "2023-01-01T00:00:00Z",
27	"payment_note": "string"
28	}
29	],
30	"next_page_token": "string",
31	"prev_page_token": "string"
32	}