Contact Sales
Search...
/
Introduction
Getting Started
Candid Environments
Payer Information
API Principles
Design Principles
Development Lifecycle
Breaking Changes
Conventions
Additional Resources
Postman
OpenAPI
Legacy Documentation
Support
API Reference
Auth
Billing Notes
Contracts
Custom Schemas
Eligibility
Encounter Providers
Encounters
Expected Network Status
Exports
External Payment Account Config
Fee Schedules
Guarantor
Import Invoice
Insurance Adjudications
Insurance Payments
Insurance Refunds
Medication Dispense
Non Insurance Payer Payments
Non Insurance Payer Refunds
Non Insurance Payers
Organization Service Facilities
Organization Providers
Patient Payments
V4
GET
Get patient payments
GET
Get patient payment
POST
Create patient payment
PATCH
Update
DEL
Delete patient payment
Patient Refunds
Payers
Service Lines
Tasks
Write Offs
Pre Encounter
Diagnoses
Service Facility
Contact Sales
API Reference
Patient Payments
V4
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
Required
Response
This endpoint returns an object.
patient_payment_id
UUID
organization_id
UUID
payment_source
enum
Show 7 enum values
amount_cents
integer
patient_external_id
string
allocations
list of objects
Show 2 properties
source_internal_id
string
Optional
payment_timestamp
datetime
Optional
payment_note
string
Optional
invoice
UUID
Optional
Errors
403
Unauthorized Error
404
Entity Not Found Error
Built with