Patient PaymentsV4

Create patient payment

Beta
POST
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
integerRequired
patient_external_id
stringRequired
allocations
list of objectsRequired
Allocations are portions of payments that are applied to specific resources, known as targets. Each allocation has and amount, defined in cents, and a target.
payment_timestamp
datetimeOptional
payment_note
stringOptional
invoice
UUIDOptional

Response

This endpoint returns 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
stringOptional
payment_timestamp
datetimeOptional
payment_note
stringOptional
invoice
UUIDOptional

Errors

POST
1curl -X POST https://api.joincandidhealth.com/api/patient-payments/v4 \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "amount_cents": 0,
6  "patient_external_id": "string",
7  "allocations": [
8    {
9      "amount_cents": 0,
10      "target": {
11        "type": "service_line_by_id",
12        "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
13      }
14    }
15  ]
16}'
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