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

NexHealth Payments API

Payments resources to view and create payments

NexHealth Payments API is one of 33 APIs that NexHealth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 3 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version v20240412.

Requests are made against a single base URL, https://nexhealth.info.

3 operations 2 paths 16 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v20240412
Base URL
https://nexhealth.info
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

NexHealth Payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 3

Payments resources to view and create payments

GET
/payments
View payments
getPayments 15 params → 200400401403500
POST
/payments
Create payment
postPayments 3 params body → 202400401403500
GET
/payments/{id}
View payment
getPaymentsId 4 params → 200400401403500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are API_V20240412_Entities_Ledger_PaymentWithIncludes (24 properties), API_V2_Entities_PatientBasic (20 properties), API_V2_Entities_Provider (19 properties), API_V20240412_Entities_Ledger_Payment (17 properties). Each schema is shown below with its type and property counts.

API_V20240412_Entities_Ledger_PaymentType
object
4 properties
API_Errors_InternalServerError
object
APIErrorsInternalServerError model
4 properties
API_Errors_Forbidden
object
APIErrorsForbidden model
4 properties
API_V2_Entities_PaymentPlan
object
6 properties
API_V20240412_Entities_Ledger_Payment
object
17 properties
API_V20240412_Entities_Ledger_PaymentWithIncludes_Response
object
APIV20240412EntitiesLedgerPaymentWithIncludesResponse model
5 properties
API_Errors_Unauthorized
object
APIErrorsUnauthorized model
4 properties
postPayments
object
Create payment
1 property 1 required
API_V20240412_Entities_Ledger_PaymentWithIncludes
object
24 properties
API_V2_Entities_PatientBasic
object
20 properties
API_Errors_BadRequest
object
APIErrorsBadRequest model
4 properties
API_V2_Entities_Patient_Ledger_Charge
object
16 properties
API_V2_Entities_Provider
object
19 properties
API_V2_Entities_Price
object
2 properties
API_V2_Entities_Ledger_Insurance_ClaimBasic
object
14 properties
API_V20240412_Entities_Ledger_Payment_Collection_Response_WithCursor
object
APIV20240412EntitiesLedgerPaymentCollectionResponseWithCursor model
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nexhealth-payments-api-openapi.yml Raw ↑

Other APIs NexHealth publishes across the network.

NexHealth Adjustment Types API
NexHealth Adjustments API
NexHealth Appointment Types API
NexHealth Appointments API
NexHealth Authenticates API
NexHealth Available Slots API
NexHealth Balances API
NexHealth Charges API
NexHealth Claims API
NexHealth Clinical Notes API
NexHealth Document Types API
NexHealth Fee Schedules API