Candid Health Patient Payments API is one of 53 APIs that Candid Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Patient Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
5 operations
across 2 paths,
and defines 41 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 10 base URLs: https://pre-api.joincandidhealth.com, https://pre-api-staging.joincandidhealth.com, https://sandbox-pre-api.joincandidhealth.com, https://staging-pre-api.joincandidhealth.com, http://localhost:4000, https://api.joincandidhealth.com, https://api-staging.joincandidhealth.com, https://sandbox-api.joincandidhealth.com, https://staging-api.joincandidhealth.com, http://localhost:5050.
5 operations2 paths41 schemas1 DELETE2 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.joincandidhealth.com
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Candid Health Patient Payments API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (OAuthScheme).
OAuthScheme — OAuth 2.0 authentication
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Patient Payments 5
GET
/api/patient-payments/v4
Get patient payments
getMulti13 params→ 200403422
POST
/api/patient-payments/v4
Create patient payment
create1 parambody→ 200403404422
GET
/api/patient-payments/v4/{patient_payment_id}
Get patient payment
get2 params→ 200403404
PATCH
/api/patient-payments/v4/{patient_payment_id}
Update
update2 paramsbody→ 200403404422
DELETE
/api/patient-payments/v4/{patient_payment_id}
Delete patient payment
delete2 params→ 200403404422
Schemas 41
The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are type_patient-payments_v4_PatientPayment (11 properties), type_commons_StreetAddressShortZip (6 properties), type_financials_Allocation (5 properties), type_financials_BalanceEarmark (4 properties). Each schema is shown below with its type and property counts.
type_commons_PageToken
string
type_patient-payments_v4_PatientPaymentsPage
object
3 properties1 required
type_financials_PatientPaymentCreateSource
string
Allowed payment sources when creating a patient payment via the API.
type_commons_OrganizationId
string
type_patient-payments_v4_PaymentMethod
type_commons_ClaimId
string
type_financials_AllocationRestrictionType
string
The dimension along which a payment's auto-allocation can be restricted.
If enabled for your organization, defines how a patient prepayment allocation should be earmarked for future auto-allocation. Earmarks hold the allocation unti…
type_financials_AllocationTarget
Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.
type_commons_EncounterExternalId
string
type_commons_UnprocessableEntityErrorMessage
object
1 property
type_commons_EntityNotFoundErrorMessage
object
1 property1 required
type_financials_BalanceEarmark
object
Represents an active balance earmarking record that holds allocated funds for future auto-allocation. Earmarks are created when funds are allocated but should…
4 properties2 required
type_commons_EncounterId
string
type_financials_NoteUpdate
type_financials_AllocationCreate
object
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.
3 properties2 required
type_commons_InvoiceId
string
type_commons_SortDirection
string
type_financials_PatientTransactionSource
string
type_financials_Allocation
object
5 properties2 required
type_patient-payments_v4_PatientPayment
object
11 properties6 required
type_commons_State
string
type_patient-payments_v4_PatientPaymentId
string
type_commons_AppointmentId
string
type_commons_ServiceLineId
string
type_patient-payments_v4_PatientPaymentSortField
string
type_commons_UnauthorizedErrorMessage
object
1 property
type_financials_AllocationRestrictionCreate
object
Constrains which claims a payment's credit can be auto-allocated to. Restrictions of the same restrictiontype are OR'd together (any value may match); differen…
Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.
type_patient-payments_v4_PaymentMethodCreate
type_commons_ProviderId
string
type_commons_AllocationId
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Candid Health Patient Payments API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
