Insurance PaymentsV1

Create insurance payment

Beta
POST
https://api.joincandidhealth.com/api/insurance-payments/v1

Creates a new insurance payment record and returns the newly created InsurancePayment object. This endpoint should only be used for insurance payments that do not have a corresponding ERA (for example: a settlement check from a payer). If the payment is an ERA, then you should used the insurance-adjudications API.

Request

This endpoint expects an object.
payer_identifier
union
amount_cents
integer
allocations
list of objects
payment_timestamp
optional datetime
payment_note
optional string

Response

This endpoint return an object.
insurance_payment_id
UUID
payer
object
amount_cents
integer
allocations
list of objects
payment_timestamp
optional datetime
payment_note
optional string

Errors

POST
/api/insurance-payments/v1
curl -X POST https://api.joincandidhealth.com/api/insurance-payments/v1 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"payer_identifier": {
"type": "payer_info",
"payer_id": "string",
"payer_name": "string"
},
"amount_cents": 0,
"allocations": [
{
"amount_cents": 0,
"target": {
"type": "service_line_by_id",
"value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
}
]
}'
Response
{
"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"
}