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 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.
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
Authentication is an optional security method. There are options:
- Certificate-based (public key) authentication
- Basic authentication (username/password)
Notifications Available via Webhook
Webhook supports all messages including asynchronous messages and messages generated from the InstaMed platform, including:
Payments
- Approved
- Declined
- Voided
- Refunded
- Returned
- Chargeback
- Settlement
- Error
Payment Plans
- 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.
| InstaMed Connect Configuration Options | |
| MerchantPaymentTransactionNotificationWebhookURL: | URL to application |
| MerchantPaymentTransactionNotificationSendPaymentNotifications: | true or false (default) |
| MerchantPaymentTransactionNotificationSendPaymentPlanNotifications: | true or false (default) |
| MerchantPaymentNotificationInterface: | Specify JSON, XML, NVP (default) |
Webhook Integration Fields Table