Insurance PaymentsV1

Get insurance payments

Beta
GET
https://api.joincandidhealth.com/api/insurance-payments/v1
Returns all non-ERA originated insurance payments satisfying the search criteria

Query parameters

limit
optional integer
Defaults to 100. The value must be greater than 0 and less than 1000.
payer_uuid
optional UUID
claim_id
optional UUID
service_line_id
optional UUID
billing_provider_id
optional UUID
sort
optional enum
Defaults to payment_timestamp
Allowed values: amount_centspayment_timestamppayment_note
sort_direction
optional enum
Sort direction. Defaults to descending order if not provided.
Allowed values: ascdesc
page_token
optional string

Response

This endpoint return an object.
items
list of objects
next_page_token
optional string
prev_page_token
optional string

Errors

GET
/api/insurance-payments/v1
curl -G https://api.joincandidhealth.com/api/insurance-payments/v1 \
-H "Authorization: Bearer <token>" \
-d limit=0 \
-d payer_uuid=d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32
Response
{
"items": [
{
"insurance_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payer": {
"payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payer_id": "string",
"payer_name": "string"
},
"amount_cents": 0,
"allocations": [
{
"amount_cents": 0,
"target": {
"type": "service_line",
"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
}
],
"payment_timestamp": "2023-01-01T00:00:00Z",
"payment_note": "string"
}
],
"next_page_token": "string",
"prev_page_token": "string"
}