Candid Health subpackage_patient-payments.subpackage_patient-payments/v4 API

The subpackage_patient-payments.subpackage_patient-payments/v4 API from Candid Health — 2 operation(s) for subpackage_patient-payments.subpackage_patient-payments/v4.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health subpackage_patient-payments.subpackage_patient-payments/v4 API is one of 54 APIs that Candid Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include subpackage_patient-payments.subpackage_patient-payments/v4. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 20 schemas. It is described by OpenAPI 3.1.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 operations 2 paths 20 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

1.0.0

Base URL

https://api.joincandidhealth.com

Authentication

HTTP Bearer

Resource Areas

Authentication & Security 1

Candid Health subpackage_patient-payments.subpackage_patient-payments/v4 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.

subpackage_patient-payments.subpackage_patient-payments/v4 5

GET

/api/patient-payments/v4

Get patient payments

get-multi 13 params → 200403422

POST

/api/patient-payments/v4

Create patient payment

create 1 param body → 200403404422

GET

/api/patient-payments/v4/{patient_payment_id}

Get patient payment

get 2 params → 200403404

PATCH

/api/patient-payments/v4/{patient_payment_id}

Update

update 2 params body → 200403404422

DELETE

/api/patient-payments/v4/{patient_payment_id}

Delete patient payment

delete 2 params → 200403404422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are type_financials:AllocationCreate (3 properties), type_commons:UnprocessableEntityErrorMessage (1 property), type_commons:UnauthorizedErrorMessage (1 property), type_commons:EntityNotFoundErrorMessage (1 property). Each schema is shown below with its type and property counts.

type_financials:InvoiceUpdate

type_commons:EntityNotFoundErrorMessage

object

1 property 1 required

type_commons:ClaimId

string

type_commons:ProviderId

string

type_commons:EncounterExternalId

string

type_commons:UnauthorizedErrorMessage

object

1 property

type_financials:NoteUpdate

type_commons:AppointmentId

string

type_commons:PatientExternalId

string

type_financials:AllocationTargetCreate

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:UnprocessableEntityErrorMessage

object

1 property

type_commons:SortDirection

string

type_financials:PatientPaymentCreateSource

string

Allowed payment sources when creating a patient payment via the API.

type_commons:Date

string

ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)

type_commons:InvoiceId

string

type_financials:AllocationEarmarkType

If enabled for your organization, defines how a patient prepayment allocation should be earmarked for future auto-allocation. Earmarks hold the allocation unti…

type_commons:PageToken

string

type_financials:PatientTransactionSource

string

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 properties 2 required

type_commons:ServiceLineId

string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Candid Health publishes across the network.

Candid Health Patient Collections API

AE Profile APIs.io

Candid Health Charge Capture API

AE Profile APIs.io

Candid Health Exports API

AE Profile APIs.io

Candid Health Patients API

AE Profile APIs.io

Candid Health Credentialing API

AE Profile APIs.io

Candid Health Auth API

AE Profile APIs.io

Candid Health subpackage_auth.subpackage_auth/default API

AE Profile APIs.io

Candid Health subpackage_billing-notes.subpackage_billing-notes/v2 API

AE Profile APIs.io

Candid Health subpackage_charge-capture-bundles.subpackage_charge-capture-bundles/v1 API

AE Profile APIs.io

Candid Health subpackage_charge-capture.subpackage_charge-capture/v1 API

AE Profile APIs.io

Candid Health subpackage_contracts.subpackage_contracts/v2 API

AE Profile APIs.io

Candid Health subpackage_contracts.subpackage_contracts/v3 API

AE Profile APIs.io

#subpackage_patient-payments.subpackage_patient-payments/v4

← Back to C APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Candid Health subpackage_patient-payments.subpackage_patient-payments/v4 API

Metadata

Authentication & Security 1

Paths & Operations 5

Schemas 20

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Candid Health subpackage_patient-payments.subpackage_patient-payments/v4 API

Metadata

Authentication & Security 1

Paths & Operations 5

Schemas 20

Specification

Source

More from Candid Health 12

API Details

Provider

Explore more