Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Candid Health

Candid Health subpackage_non-insurance-payer-refunds.subpackage_non-insurance-payer-refunds/v1 API

The subpackage_non-insurance-payer-refunds.subpackage_non-insurance-payer-refunds/v1 API from Candid Health — 2 operation(s) for subpackage_non-insurance-payer-refunds.subpackage_non-insurance-payer-refunds/v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health subpackage_non-insurance-payer-refunds.subpackage_non-insurance-payer-refunds/v1 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_non-insurance-payer-refunds.subpackage_non-insurance-payer-refunds/v1. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 9 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 9 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
1

Authentication & Security 1

Candid Health subpackage_non-insurance-payer-refunds.subpackage_non-insurance-payer-refunds/v1 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_non-insurance-payer-refunds.subpackage_non-insurance-payer-refunds/v1 5
GET
/api/non-insurance-payer-refunds/v1
Get non-insurance payer refunds refunds
get-multi 8 params → 200422
POST
/api/non-insurance-payer-refunds/v1
Create non-insurance payer refund
create 1 param body → 200404422
GET
/api/non-insurance-payer-refunds/v1/{non_insurance_payer_refund_id}
Get non-insurance payer refund
get 2 params → 200404
PATCH
/api/non-insurance-payer-refunds/v1/{non_insurance_payer_refund_id}
Update
update 2 params body → 200404422
DELETE
/api/non-insurance-payer-refunds/v1/{non_insurance_payer_refund_id}
Delete non-insurance payer refund
delete 2 params → 200404422

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are type_commons:UnprocessableEntityErrorMessage (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:PageToken
string
type_financials:RefundReason
string
type_commons:UnprocessableEntityErrorMessage
object
1 property
type_commons:SortDirection
string
type_financials:NoteUpdate
type_commons:InvoiceId
string
type_financials:RefundReasonUpdate

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-non-insurance-payer-refunds-subpackage-non-insurance-payer-refunds-v1-api-openapi.yml Raw ↑

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_non-insurance-payer-refunds.subpackage_non-insurance-payer-refunds/v1
← Back to C APIs
API Details
ID
candid-health:candid-health-subpackage-non-insurance-payer-refunds-subpackage-non-insurance-payer-refunds-v1-api
Base URL
https://api.joincandidhealth.com
Docs
https://docs.joincandidhealth.com/api-reference/eligibility/v-2
Provider
Candid Health
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network