Get patient payment

Beta

GET

Retrieves a previously created patient payment by its patient_payment_id.

Path parameters

patient_payment_idUUIDRequired

Response

This endpoint returns an object.

patient_payment_idUUID

organization_idUUID

payment_sourceenum

amount_centsinteger

patient_external_idstring

allocationslist of objects

source_internal_idstringOptional

payment_timestampdatetimeOptional

payment_notestringOptional

invoiceUUIDOptional

Errors

GET

1 curl https://api.joincandidhealth.com/api/patient-payments/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>"

1 {
2   "patient_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4   "payment_source": "MANUAL_ENTRY",
5   "amount_cents": 0,
6   "patient_external_id": "string",
7   "allocations": [
8     {
9       "amount_cents": 0,
10       "target": {
11         "type": "service_line",
12         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
13         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
15       }
16     }
17   ],
18   "source_internal_id": "string",
19   "payment_timestamp": "2023-01-01T00:00:00Z",
20   "payment_note": "string",
21   "invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
22 }

Built with

1	curl https://api.joincandidhealth.com/api/patient-payments/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2	-H "Authorization: Bearer <token>"

1	{
2	"patient_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3	"organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4	"payment_source": "MANUAL_ENTRY",
5	"amount_cents": 0,
6	"patient_external_id": "string",
7	"allocations": [
8	{
9	"amount_cents": 0,
10	"target": {
11	"type": "service_line",
12	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
13	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
15	}
16	}
17	],
18	"source_internal_id": "string",
19	"payment_timestamp": "2023-01-01T00:00:00Z",
20	"payment_note": "string",
21	"invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
22	}