Get patient payment

1 import uuid 2 3 from candid import CandidApiClient 4 5 client = CandidApiClient( 6 client_id="YOUR_CLIENT_ID", 7 client_secret="YOUR_CLIENT_SECRET", 8 ) 9 client.patient_payments.v_4.get( 10 patient_payment_id=uuid.UUID( 11 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 12 ), 13 )

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": 1, 6 "patient_external_id": "patient_external_id", 7 "allocations": [ 8 { 9 "amount_cents": 1, 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 "amount_cents": 1, 19 "target": { 20 "type": "service_line", 21 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 22 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 23 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 24 } 25 } 26 ], 27 "source_internal_id": "source_internal_id", 28 "payment_timestamp": "2024-01-15T09:30:00Z", 29 "payment_note": "payment_note", 30 "invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 31 }

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_idstring or null

payment_timestampdatetime or null

payment_notestring or null

invoiceUUID or null

Path parameters

Headers

Response

Errors