HealthiPay

Supergood | HealthiPay API

Alex Klarfeld

Alex Klarfeld

— 6 min read
Supergood | HealthiPay API

Programmatically access patient eligibility, cost estimates, digital statements, payment requests, transactions, and reconciliation workflows in HealthiPay with a stable REST API. Supergood builds and operates production-grade, unofficial HealthiPay integrations so your team can automate front-office and revenue cycle operations without heavy custom engineering.

In plain English: HealthiPay (branded publicly as Health iPASS at healthipass.com) is software that helps medical practices and provider groups verify insurance, estimate patient responsibility, streamline check-in, send digital statements, collect payments online/in-office, and manage payment plans. With an unofficial API, you could trigger real-time eligibility checks, generate cost estimates, create and send pay links for statements, post and reconcile payments, and surface balances and settlements anywhere in your product.

If you’re a healthcare tech startup focused on billing, practice management, or provider services, integrating with HealthiPay means you can pull current balances and estimates, push new patient demographics and appointment details, and embed payment flows directly in your app. You can build pre-arrival estimation and eligibility features, automate statement delivery and reminders, store card-on-file tokens for future charges, manage payment plans, and reconcile deposits and batch settlements in your analytics.

If you’re a clinic, provider group, or revenue cycle team, integrating your tech stack with HealthiPay unlocks concrete data flows and features:

  • Pull: Patient profiles and balances, insurance eligibility responses, cost estimates, statement line items, payment request statuses, transaction histories, settlement batches
  • Push: Updated patient demographics from your EHR/PM, appointment/encounter details, estimate requests with CPT codes, pay link creation and delivery (SMS/email), refunds and voids
  • Build: Pre-arrival estimation and eligibility verification, self-service check-in and consent capture, digital statements with pay links, auto-pay and card-on-file workflows, reconciliation dashboards spanning transactions and settlements

What is HealthiPay?

HealthiPay (Health iPASS) provides patient intake and payment solutions for healthcare practices, helping front offices and revenue cycle teams increase point-of-service and post-visit collections while improving patient financial transparency. Common functionality spans real-time eligibility checks, cost estimation for scheduled services, patient self-service check-in, digital statements with online payments, payment plans, card-on-file, refunds/voids, and settlement reporting.

Core product areas include:

  • Eligibility verification and benefits breakdown
  • Cost estimation (CPT/HCPCS codes, modifiers, contracted rates)
  • Patient intake (demographics, insurance, consents) and check-in
  • Digital statements and reminders with pay links
  • Payment processing (card, ACH) and card-on-file tokenization
  • Payment plans and auto-pay scheduling
  • Settlement batches and reconciliation reporting

Common data entities:

  • Patients and guarantors
  • Insurance policies and eligibility responses
  • Appointments/encounters and service codes (CPT/HCPCS)
  • Estimates (allowed amounts, payer coverage, patient responsibility)
  • Statements/invoices and line items
  • Payment requests (links, channels, expirations)
  • Transactions (auth/capture/settlement, fees, net amounts)
  • Payment methods (tokenized card/ACH)
  • Payment plans (installments, schedules)
  • Settlement batches and deposit summaries

The HealthiPay Integration Challenge

Organizations rely on HealthiPay daily, but turning portal-based patient payment workflows into automated pipelines is hard:

  • PCI and tokenization constraints: Card and ACH data must be handled via token vaults and strict role-based access; card-on-file requires careful scope control
  • Portal-first delivery: Eligibility, estimate generation, statement management, and settlement reports often live in web apps or batch exports, not unified public APIs
  • Device and channel nuances: EMV terminals, kiosks, and SMS/email pay links follow distinct flows with timing windows and audit requirements
  • Batch interfaces and reconciliation: Settlement files, fees, and deposits reconcile on a delay and require consistent mapping to requests/statements
  • Enterprise security: SSO/MFA and network controls complicate headless automation for intake and billing operations

How Supergood Creates HealthiPay APIs

Supergood reverse-engineers authenticated browser flows, batch interfaces, and network interactions to deliver a resilient API endpoint layer.

  • Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
  • Maintains session continuity with automated refresh and change detection
  • Normalizes eligibility, estimate, statement, and transaction objects across practice configurations
  • Aligns with customer entitlements and licensing constraints to ensure compliant access
  • Bridges batch exports and SFTP settlement files with signed URL retrieval and delivery
  • Observes PCI boundaries: tokenized payment methods only, redaction of sensitive PAN/ACH details in logs and payloads

Use Cases

Pre-Arrival Estimation and Eligibility

  • Validate eligibility in near real time for scheduled appointments
  • Generate cost estimates with payer coverage, copays, coinsurance, and expected patient responsibility
  • Reduce surprises and increase point-of-service collections

Front-Office Check-In and POS

  • Pull patient demographics and balances into your check-in experience
  • Push signed consents and updated contact/insurance data back to HealthiPay
  • Prepare payment requests for co-pays or deposits and capture card-on-file

Digital Statements and Collections

  • Create pay links and deliver via SMS/email with due dates and reminders
  • Track payment request statuses and route exception handling to staff
  • Update PM/EHR with paid amounts and remaining balance

Reconciliation and Reporting

  • Pull transaction histories with fees and net amounts
  • Map settlements and deposits to batches for accounting
  • Power dashboards for finance and RCM teams

Available Endpoints

Authentication

POST /sessions: Establish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/sessions \
  --header 'Authorization: Basic <Base64 encoded token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "[email protected]",
    "password": "<password>",
    "mfa": {
      "type": "totp",
      "code": "123456"
    }
  }'

Example response

{
  "authToken": "eyJhbGciOi...",
  "expiresIn": 3600,
  "user": {
    "id": "u_77c91a",
    "name": "RCM Analyst",
    "entitlements": ["patients", "estimates", "payments", "transactions"]
  }
}

Estimates

GET /estimates: Retrieve cost estimates for upcoming or recent services, including payer coverage and patient responsibility. Use this to inform scheduling and point-of-service collection.

Query parameters

  • patientId: string
  • appointmentId: string
  • cptCode: string
  • facilityId: string
  • activeOn: ISO 8601 date

Example response

{
  "items": [
    {
      "estimateId": "est_9a1b23",
      "patientId": "pat_52f8d0",
      "appointmentId": "appt_2026_0119_001",
      "payer": {
        "name": "BlueCross PPO",
        "memberId": "M123456789",
        "planType": "PPO"
      },
      "services": [
        {
          "cpt": "99213",
          "modifiers": [],
          "allowedAmount": 145.00,
          "payerCoverage": 95.00,
          "patientResponsibility": 50.00,
          "breakdown": {"copay": 20.00, "deductibleApplied": 15.00, "coinsurance": 15.00}
        }
      ],
      "status": "final",
      "validThrough": "2026-02-01",
      "createdAt": "2026-01-19T15:45:12Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

Payment Requests

POST /payments/requests: Create a payment request (pay link) for a statement or deposit. Supergood can optionally send via SMS/email and track statuses.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/payments/requests \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "patientId": "pat_52f8d0",
    "statementId": "stmt_8c771f",
    "amount": 50.00,
    "currency": "USD",
    "dueDate": "2026-02-05",
    "channel": "sms",
    "message": "Your visit balance is due. Pay securely using the link below.",
    "send": true,
    "referenceId": "ehr-stmt-42391"
  }'

Example response

{
  "requestId": "pyr_71af2b",
  "payLinkUrl": "https://pay.healthipay.example/link/abc123...",
  "status": "pending",
  "expiresAt": "2026-02-05T23:59:59Z",
  "channel": "sms",
  "referenceId": "ehr-stmt-42391"
}

Transactions

GET /transactions: List payment transactions with authorization/capture timing, fees, net amounts, and settlement batch references for reconciliation.

Query parameters

  • patientId: string
  • statementId: string
  • dateFrom/dateTo: ISO 8601 datetime
  • status: string (authorized, captured, succeeded, failed, voided, refunded)
  • methodType: string (card, ach)

Example response

{
  "items": [
    {
      "transactionId": "txn_58d3e0",
      "requestId": "pyr_71af2b",
      "statementId": "stmt_8c771f",
      "patientId": "pat_52f8d0",
      "amount": 50.00,
      "currency": "USD",
      "method": {"type": "card", "cardBrand": "Visa", "last4": "1111", "tokenId": "tok_33aa7d"},
      "status": "succeeded",
      "authorizedAt": "2026-01-19T16:02:45Z",
      "capturedAt": "2026-01-19T16:03:12Z",
      "fees": {"processing": 1.45},
      "netAmount": 48.55,
      "settlementBatchId": "set_2026_0119_a",
      "reconciliationStatus": "settled"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

Get full API Specs →

Technical Specifications

  • Authentication: Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
  • Response format: JSON with consistent resource schemas and pagination
  • Rate limits: Tuned for enterprise throughput while honoring licensing and usage controls
  • Session management: Automatic reauth and cookie/session rotation with health checks
  • Data freshness: Near real-time retrieval of eligibility, estimates, statements, and transaction artifacts
  • Security: Encrypted transport, scoped tokens, audit logging; respects HealthiPay entitlements and PCI constraints (tokenized methods only)
  • Webhooks: Optional asynchronous delivery for payment request events, transaction updates, and settlement availability

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume payment and batch settlement pipelines
  • Reliability: Retry logic, backoff, and idempotency keys minimize duplicate actions
  • Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates

Getting Started

  1. Schedule Integration Assessment

Book a 30-minute session to confirm your HealthiPay product mix, licensing, and authentication model.

  1. Supergood Builds and Validates Your API

We deliver a hardened HealthiPay adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

Go live with continuous monitoring and automatic adjustments as HealthiPay evolves.

Schedule Integration Call →

Frequently Asked Questions

Q: Which HealthiPay products can this integration cover?

Supergood supports workflows across commonly used HealthiPay/Health iPASS portals and practice-facing tools, subject to your licensing and entitlements. We scope coverage (e.g., eligibility, estimates, statements, payment requests, transaction retrieval, settlement reconciliation) during integration assessment.

Q: How are MFA, SSO, PCI, and device flows handled for automation?

We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. For payments, we adhere to PCI boundaries, use tokenized methods, and do not store raw PAN/ACH. Where applicable, we orchestrate kiosk/EMV flows and manage pay link delivery with audit trails.

Q: Can I post payments and reconcile deposits programmatically?

Yes. You can create payment requests, track transaction statuses, and pull settlement batches with fees/net amounts. We return artifacts and references to support accounting and RCM reconciliation.

Ready to automate your HealthiPay workflows?

Supergood can have your HealthiPay integration live in days with no ongoing engineering maintenance.

Get Started →

Read more