Patient PaymentsV4

Create patient payment

Beta
POST
https://api.joincandidhealth.com/api/patient-payments/v4
Creates a new patient payment record and returns the newly created PatientPayment object. The allocations can describe whether the payment is being applied toward a specific service line, claim, or billing provider.

Request

This endpoint expects an object.
amount_cents
integer
patient_external_id
string
allocations
list of objects
payment_timestamp
optional datetime
payment_note
optional string
invoice
optional UUID

Response

This endpoint return an object.
patient_payment_id
UUID
organization_id
UUID
payment_source
enum
amount_cents
integer
patient_external_id
string
allocations
list of objects
source_internal_id
optional string
payment_timestamp
optional datetime
payment_note
optional string
invoice
optional UUID
POST
/api/patient-payments/v4
curl -X POST https://api.joincandidhealth.com/api/patient-payments/v4 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"amount_cents": 0,
"patient_external_id": "string",
"allocations": [
{
"amount_cents": 0,
"target": {
"type": "service_line_by_id",
"value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
}
]
}'
Response
{
"patient_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payment_source": "MANUAL_ENTRY",
"amount_cents": 0,
"patient_external_id": "string",
"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"
}
}
],
"source_internal_id": "string",
"payment_timestamp": "2023-01-01T00:00:00Z",
"payment_note": "string",
"invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}