Patient PaymentsV4

Get patient payment

Beta
GET
https://api.joincandidhealth.com/api/patient-payments/v4/:patient_payment_id

Retrieves a previously created patient payment by its patient_payment_id.

Path parameters

patient_payment_id
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
GET
/api/patient-payments/v4/:patient_payment_id
curl https://api.joincandidhealth.com/api/patient-payments/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
-H "Authorization: Bearer <token>"
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"
}