HealthPay24

Supergood | HealthPay24 API

Alex Klarfeld

Alex Klarfeld

— 6 min read
Supergood | HealthPay24 API

Programmatically access patient billing, balances, payment plans, estimates, and refunds in HealthPay24 with a stable REST API. Supergood builds and operates production-grade, unofficial HealthPay24 integrations so your team can automate critical patient payment and revenue cycle workflows without heavy custom engineering.

In plain English: HealthPay24 is software used by hospitals, health systems, and medical practices to let patients view statements, pay bills online or at the point of service, enroll in payment plans, and manage payment methods—all with PCI-compliant processing. With an unofficial API, you could pull real-time balances and statements, tokenize payment methods for checkout, create payments and refunds, configure payment plans, and reconcile settlements back to your EHR/practice management system.

If you’re a healthcare tech startup or provider organization building billing, practice management, or patient engagement tools, integrating your stack with HealthPay24 unlocks concrete data flows and features:

  • Pull: Patient/guarantor profiles, account balances, statements, payment methods (tokenized), transactions, payment plan schedules, pre-service estimates, settlement batches
  • Push: New or updated patients/guarantors, payment creations (card/ACH), payment plan enrollment and edits, refunds, communication triggers (email/SMS statements, reminders)
  • Build: Embedded checkout with HealthPay24 tokenization, balance-aware payment flows, estimate-to-deposit workflows, autopay and dunning orchestration, reconciliation dashboards driven by transactions and settlements

What is HealthPay24?

HealthPay24 provides a patient financial engagement platform used by provider groups, hospitals, and integrated delivery networks to modernize bill presentment and payments. Its product suite spans online bill pay, point-of-service collections, payment plans and recurring billing, cost estimates and deposits, statement delivery and reminders, and robust reporting for reconciliation. HealthPay24 operates with strong PCI compliance, supports card and ACH/eCheck payments, and integrates with clinical and accounting systems (e.g., EHRs like Epic, Cerner, and athenahealth) to keep patient accounts and balances in sync.

Core product areas include:

  • Patient self-service payment portal and mobile-friendly checkout
  • Point-of-service and call center payments
  • Payment plans and recurring/autopay arrangements
  • Pre-service cost estimates and deposit capture
  • Statement presentment, reminders, and financial communications
  • Payment method tokenization and card-on-file management
  • Refunds, settlements, and reconciliation reporting

Common data entities:

  • Patients and Guarantors
  • Accounts and Encounters
  • Statements and Invoices
  • Payment Methods (tokenized card/ACH)
  • Transactions/Payments and Receipts
  • Payment Plans (terms, schedules, autopay)
  • Estimates (procedure codes, expected patient responsibility)
  • Communications (email/SMS notifications)
  • Refunds and Settlement Batches

The HealthPay24 Integration Challenge

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

  • PCI constraints and tokenization: Card/ACH data must remain tokenized with strict segmentation; automation has to respect card brand and NACHA rules
  • Strong enterprise security: SSO/MFA and network controls complicate headless automation for staff-facing and admin portals
  • Portal-first delivery: Key payment plan setup, statement presentment, and refund actions live in web apps or batch exports, not unified public APIs
  • Ledger alignment: Payments must be posted to the right account/encounter and flow back to EHR/practice management systems with correct references
  • Batch interfaces and timing windows: Settlement files, SFTP exports, and daily reconciliation cutoffs need precise handling
  • Audit and compliance: Detailed receipts, reason codes for adjustments/refunds, and immutable audit trails are required for reviews

How Supergood Creates HealthPay24 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 patient, account, payment, and plan objects so you can integrate once across facility and product configurations
  • Aligns with customer entitlements and licensing constraints to ensure compliant access
  • Bridges batch exports and SFTP/reporting flows where applicable with signed URL retrieval and delivery

Use Cases

Balance and Statement Synchronization

  • Pull current balances and statement PDFs per account to surface in your portal or app
  • Keep patient and guarantor records aligned with your EHR/practice management system
  • Drive targeted communications based on past-due status and aging buckets

Embedded Checkout and Tokenized Payments

  • Tokenize payment methods via HealthPay24 and execute card/ACH payments from your UI
  • Attach encounter or statement references to payments for clean posting and reconciliation
  • Generate receipts and deliver confirmations automatically via email/SMS

Payment Plan Orchestration

  • Enroll eligible accounts into compliant payment plans with autopay and reminders
  • Modify plan terms, pause/resume autopay, and manage delinquency workflows
  • Surface next-due amounts and payoff calculations in your application

Estimate-to-Deposit Workflows

  • Retrieve pre-service cost estimates and present deposit options
  • Collect deposits and tie them to the upcoming encounter, reducing downstream AR
  • Track deposit balances and apply them at service time

Refunds and Reconciliation Automation

  • Initiate compliant refunds and partial reversals
  • Pull settlement batches, batch totals, and deposit dates for bank reconciliation
  • Tie transactions to general ledger accounts and produce reconciliation reports

Communications and Reminders

  • Trigger statement sends and payment reminders automatically
  • Configure cadence by aging buckets, plan status, and upcoming deposit deadlines
  • Maintain audit trails for communications

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_3a91d2",
    "name": "Billing Admin",
    "entitlements": ["patients", "payments", "payment_plans", "statements"]
  }
}

Patients

GET /patients: Retrieve patients and guarantors with account summaries for billing and messaging.

Query parameters

  • name: string (partial match)
  • email: string
  • dateOfBirth: ISO 8601 date
  • patientNumber: string
  • guarantorId: string
  • updatedSince: ISO 8601 timestamp

Example response

{
  "items": [
    {
      "patientId": "pt_9c42b1",
      "patientNumber": "P1234567",
      "name": {"first": "Jordan", "last": "Patel"},
      "dateOfBirth": "1990-07-12",
      "contact": {"email": "[email protected]", "phone": "+1-555-0101"},
      "guarantor": {"guarantorId": "gr_11a8f0", "name": "Jordan Patel"},
      "accounts": [
        {"accountId": "acct_4412bc", "encounterId": "enc_20260119_001", "balance": 284.12, "pastDue": false},
        {"accountId": "acct_4412bd", "encounterId": "enc_20251205_023", "balance": 75.00, "pastDue": true}
      ],
      "updatedAt": "2026-01-19T15:41:22Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

Payments

POST /payments: Create a card or ACH payment tied to a patient/account, using HealthPay24 tokenization. Returns transaction status and receipt metadata.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/payments \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "patientId": "pt_9c42b1",
    "accountId": "acct_4412bc",
    "amount": 150.00,
    "currency": "USD",
    "paymentMethod": {
      "type": "card",
      "tokenId": "tok_7ffa29",
      "brand": "Visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2028,
      "cardholderName": "Jordan Patel"
    },
    "channel": "online",
    "references": {
      "statementId": "stmt_20260119_1001",
      "encounterId": "enc_20260119_001"
    },
    "receipt": {"deliverEmail": true, "email": "[email protected]"},
    "idempotencyKey": "ehr-payment-42391"
  }'

Example response

{
  "transactionId": "txn_58d3e0",
  "status": "captured",
  "approvalCode": "A12345",
  "amount": 150.00,
  "currency": "USD",
  "accountId": "acct_4412bc",
  "postedAt": "2026-01-19T15:02:02Z",
  "receiptUrl": "https://download.healthpay24.example/signed/abc123...",
  "idempotencyKey": "ehr-payment-42391"
}

Payment Plans

POST /payment-plans: Enroll an account into a payment plan with autopay and reminder settings.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/payment-plans \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "patientId": "pt_9c42b1",
    "accountId": "acct_4412bc",
    "totalAmount": 284.12,
    "downPayment": 50.00,
    "installments": {
      "count": 6,
      "frequency": "monthly",
      "startDate": "2026-02-01"
    },
    "autopay": {
      "enabled": true,
      "tokenId": "tok_7ffa29",
      "dayOfMonth": 1
    },
    "reminders": {"email": true, "sms": true}
  }'

Example response

{
  "paymentPlanId": "pp_71af2b",
  "status": "active",
  "schedule": [
    {"installment": 1, "dueDate": "2026-02-01", "amount": 39.02, "status": "scheduled"},
    {"installment": 2, "dueDate": "2026-03-01", "amount": 39.02, "status": "scheduled"}
  ],
  "autopayEnabled": true,
  "nextPaymentDue": "2026-02-01",
  "createdAt": "2026-01-19T16:05:42Z"
}

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 balances, statements, transactions, and plan artifacts
  • Security: Encrypted transport, scoped tokens, and audit logging; respects HealthPay24 entitlements and PCI segmentation
  • Webhooks: Optional asynchronous delivery for payment events, plan delinquency, refunds, and settlement updates

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume payment and reconciliation pipelines
  • Reliability: Retry logic, backoff, and idempotency keys minimize duplicate charges or plan enrollments
  • 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 HealthPay24 product mix, licensing, and authentication model.

  1. Supergood Builds and Validates Your API

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

  1. Deploy with Monitoring

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

Schedule Integration Call →

Frequently Asked Questions

Q: Which HealthPay24 products can this integration cover?

Supergood supports workflows across commonly used HealthPay24 portals and provider-facing tools, subject to your licensing and entitlements. We scope coverage (e.g., statements, tokenized payments, payment plans, estimates, refunds, settlements) during integration assessment.

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

We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Payment method handling is tokenized end-to-end, keeping raw card/ACH data out of your environment while enabling charge creation, autopay, and refunds.

Q: Can I reconcile settlements and generate receipts programmatically?

Yes. You can retrieve settlement batches and transaction artifacts, link payments to accounts/encounters, and fetch receipt PDFs/URLs to support audit and patient communications.

Ready to automate your HealthPay24 workflows?

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

Get Started →

Read more