Get insurance payments

1 curl https://api.joincandidhealth.com/api/insurance-payments/v1 \ 2 -H "Authorization: Bearer <token>"

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": "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 }, 33 { 34 "amount_cents": 1, 35 "target": { 36 "type": "service_line", 37 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 38 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 39 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 40 } 41 } 42 ], 43 "payment_timestamp": "2024-01-15T09:30:00Z", 44 "payment_note": "payment_note" 45 }, 46 { 47 "insurance_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 48 "payer": { 49 "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 50 "payer_id": "payer_id", 51 "payer_name": "payer_name", 52 "availity_payer_name": "availity_payer_name", 53 "availity_claims_payer_id": "availity_claims_payer_id", 54 "availity_eligibility_id": "availity_eligibility_id", 55 "availity_remittance_payer_id": "availity_remittance_payer_id", 56 "street_address": { 57 "address1": "address1", 58 "city": "city", 59 "state": "AA", 60 "zip_code": "zip_code", 61 "zip_plus_four_code": "zip_plus_four_code", 62 "address2": "address2" 63 } 64 }, 65 "amount_cents": 1, 66 "allocations": [ 67 { 68 "amount_cents": 1, 69 "target": { 70 "type": "service_line", 71 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 72 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 73 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 74 } 75 }, 76 { 77 "amount_cents": 1, 78 "target": { 79 "type": "service_line", 80 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 81 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 82 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 83 } 84 } 85 ], 86 "payment_timestamp": "2024-01-15T09:30:00Z", 87 "payment_note": "payment_note" 88 } 89 ], 90 "next_page_token": "next_page_token", 91 "prev_page_token": "prev_page_token" 92 }

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:

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 or null

prev_page_tokenstring or null

Headers

Query parameters

Response

Errors