• Integration Overview
  • Consumer Payments
  • Consumer Billing
  • Healthcare
  • Disbursement Hub

Consumer Payments

  • Consumer Initiated Payments
  • Staff Initiated Payments
  • Payment Plans
  • Tokenization
  • Automatic Payment Collection
    • Automatic Payments Enrollment
    • Automatic Payments Trigger
      • Balance File Specification
      • Balance File Acknowledgement
    • Auto Payment Collect Batch Enrollment
      • Batch Unenrollment
    • Enhanced Enrollment File
    • Automatic Payments Sign Up File
  • Receipts
  • Voids
  • Refunds
  • Payment Posting
    • Polling Payment Response
    • Posting File Formats
      • EOD Posting File 1.4
      • EOD Posting File 1.3
      • EOD Posting File 1.2.2
      • EOD Posting File 1.2/1.2 CR
      • EOD Posting File 1.2.1
      • EOD Posting File 1.1/1.1 CR
      • EOD Posting File 1.1.1
      • EOD Posting File 1.0
      • EOD Posting File X12 835 1.0
      • EOD Posting File X12 835 2.0
      • EOD Posting File Lockbox A
      • EOD Posting File Lockbox A1.1
      • EOD Posting File Lockbox A v2
      • EOD Posting File Lockbox B
      • EOD Posting File Lockbox C
      • EOD Posting File Lockbox C v2
      • EOD Posting File Lockbox D
      • EOD Posting File Lockbox E
      • EOD Posting File Lockbox F
      • EOD Posting File Lockbox G
      • EOD Posting File Lockbox G v2
      • EOD Posting File LockBox H
      • EOD Posting File Lockbox I v1
      • EOD Posting File Lockbox L
      • Member Payments EOD Posting File v1.0
      • Payment Deposit File 1.0
      • Payment Deposit File 2.0
    • Webhook
    • Payment Interface Testing
    • Payment Transaction Import
      • Payment Transaction Import Data Fields
      • IDF Acknowledgement Data Fields
  • PCI Compliance
    • Recommended Options for PCI Compliance
    • Software Development Impact of PCI Compliance
    • Hosting Impact of PCI Compliance
    • P2PE Devices
  • Consumer Profile
    • Consumer Experience
    • Staff Experience
  • Digital Wallet
  • Google Pay
  • Member Payments
    • Manage Member Payment Methods
    • New Member Payment
    • View Member Payment History
    • View Member Payment Receipt
    • Member Payments Webhook
  • Member Effectuation
  • Member IDF Import v1.1
  • User Management
  • Request Sandbox API Key
  • Contact
  • Terms of Use
Skip to content
InstaMed Developer Portal
  • Integration Overview
  • Consumer Payments
  • Consumer Billing
  • Healthcare
  • Disbursement Hub
  • Consumer Initiated
    • In App Apple Pay
  • Staff Initiated
  • Payment Plans
  • Tokenization
  • Automatic Payment Collection
    • Enrollment
    • Trigger
      • Balance File Specification
      • Balance File Acknowledgement
    • Batch Enrollment
      • Batch Unenrollment
    • Enhanced Enrollment File
    • Sign Up File
  • Receipts
  • Voids
  • Refunds
  • Payment Posting
    • Polling Payment Response
    • Posting File Formats
      • EOD Posting File 1.4
      • EOD Posting File 1.3
      • EOD Posting File 1.2.2
      • EOD Posting File 1.2/1.2 CR
      • EOD Posting File 1.2.1
      • EOD Posting File 1.1/1.1 CR
      • EOD Posting File 1.1.1
      • EOD Posting File 1.0
      • EOD Posting File X12 835 1.0
      • EOD Posting File X12 835 2.0
      • EOD Posting File Lockbox A
      • EOD Posting File Lockbox A1.1
      • EOD Posting File Lockbox A v2
      • EOD Posting File Lockbox B
      • EOD Posting File Lockbox C
      • EOD Posting File Lockbox C v2
      • EOD Posting File Lockbox D
      • EOD Posting File Lockbox E
      • EOD Posting File Lockbox F
      • EOD Posting File Lockbox G
      • EOD Posting File Lockbox G v2
      • EOD Posting File LockBox H
      • EOD Posting File Lockbox I v1
      • EOD Posting File Lockbox L
      • Member Payments EOD Posting File v1.0
      • Payment Deposit File 1.0
      • Payment Deposit File 2.0
    • Webhook
    • Payment Interface Testing
    • Payment Transaction Import
      • Payment Transaction Import Data Fields
      • IDF Acknowledgement Data Fields
  • PCI Compliance
    • Recommended Options
    • Software Development Impact
    • Hosting Impact
    • P2PE Devices
  • Consumer Profile
    • Consumer Experience
    • Staff Experience
  • Digital Wallet
  • Google Pay
  • Member Payments
    • Manage Payment Methods
    • New Payment
    • View Payment History
    • View Receipt
    • Webhook
  • Member Effectuation
  • Member IDF Import v1.1
  • User Management
  • Request Sandbox API Key
  • Contact
  • Terms of Use

Webhook

Applications can receive real-time notifications whenever a transaction is processed or updated via the InstaMed Webhook interface.

With webhooks enabled, InstaMed sends a simple HTTP POST containing the relevant transaction information (i.e. Patient info, Amount, Transaction Date, TransactionID, etc) to the application URL in the requested format (JSON, XML, NVP).

Response and Error Handling

Return a HTTP status code 200 only if you successfully store the webhook message. If the HTTP post is not successfully stored, return “Status-Code” indicating the post was not successful (ex. “400” or “500”). Along with a standard HTTP “Status Code” optionally include a “Response Phrase” which InstaMed can parse and pass as the Webhook Posting Message for client review and reference.

If the initial webhook post is unsuccessful, InstaMed retries the webhook post every 30 minutes for up to five attempts. InstaMed assigns the transaction a pending posting retry workflow status when a message is being re-attempted. If after five attempts the terminal message is unsuccessful, InstaMed assigns a posting error workflow status. If InstaMed does not receive or has an issue receiving a Status for a Webhook HTTP post, the post will timeout for 20 seconds, and then retry. After two attempts the post will fail.

Security

 

In order to secure a webhook end point, it is recommended that the following InstaMed IP addresses be whitelisted:

  • 216.177.67.4
  • 216.39.105.164
  • 67.20.173.212
  • 69.164.118.196
  • 216.200.100.194
  • 64.124.41.130
  • 64.124.41.161
  • 216.200.100.225

Authentication is an optional security method. There are three main options:

  1. Certificate-based (public key) authentication: InstaMed can use Certificate Based Mutual Authentication (Mutual SSL Authentication) to initiate the webhook with the customer’s server.  Certificate authentication can be added to either Basic Authentication or Open Authentication protocols.  
  2. Basic authentication (username/password): InstaMed can use the verified authentication version (leveraging a username and password challenge) of Basic Authentication to deliver a webhook.    
  3. Open Authorization (OAuth 2.0): InstaMed can use the recognized ID service Ping Federated 2.0 to exchange a secure token with the customer in order to deliver the webhook.  Contact an InstaMed Implementation Manager for information on using other ID services. 

InstaMed can use either Basic or Open Authentication, but not both for a specific webhook.  A certificate can be used for either Basic or Open if desired.

PLEASE NOTE: Authentication is not available for Member Payments when using the InstaMed Webhook interface


Notifications Available via Webhook

Webhook supports all messages including asynchronous messages and messages generated from the InstaMed platform, including:

Payment Triggers

  • Approved
  • Declined
  • Voided
  • Refunded
  • Returned
  • Chargeback
  • Settlement
  • Error

Payment Plan Triggers

  • Created
  • Updated

Note: The TransactionID received via the real-time notification can be used to process a void or simple refund via InstaMed Connect Web Services.

Webhook Integration Fields Table


Webhook Samples Wizard

Loading, please wait
Unable to load InstaMed webhook wizard. Your browser is not compatible.
Please try again using modern browser such as Google Chrome or Microsoft Edge.

Build a better healthcare payments experience with InstaMed

Talk With an InstaMed Expert
  • Request Sandbox API Key
  • Contact
  • Terms of Use

InstaMed is a wholly owned subsidiary and is a registered MSP/ISO of JPMorgan Chase Bank, N.A. Additionally, InstaMed is a registered ISO of Wells Fargo Bank, N.A., Concord, CA; a registered ISO of U.S. Bank, N.A.; and a registered MSP/ISO of Elavon, Inc. Georgia.

  • Twitter
  • LinkedIn
  • YouTube

© 2023 JPMorgan Chase & Co. All rights reserved.Privacy StatementTerms of Use