Integrate void transactions to cancel a previous payment transaction
NOTE: A void cannot be completed after the transfer of funds has been initiated, the timing of which may vary based on scenario. (Please consult your InstaMed Integrations Manager for specific timing rules for your scenario)
Integration Options
Voids may use a different implementation than payment transactions.
Single Sign-On
Review the wizard below for interface display options, code examples and integration details.
REST
Recommended for new integrations where the user experience is heavily controlled by the software application.
Explore our REST documentation. If you need a Sandbox API Key, apply for one here.
NVP
HTTP POST Name Value Pair (NVP) is a simple to use format that works across all platforms.
Sample Request
POST /payment/NVP.aspx HTTP/1.1
Host: connect.instamed.com
Content-Type: application/x-www-form-urlencoded
Content-Length: NNN
transactionType=CreditCard&transactionAction=Void&MerchantID=123123123&StoreID=123&TerminalID=123&primaryCardPresentStatus=PresentManualKey&primaryTransactionID=EE52401813A74328AAA7D93319FF4383&
Sample Response
responseCode=000&responseMessage=APPROVED&transactionStatus=C&primaryTransactionID=EE52401813A74328AAA7D93319FF4383&primaryTransactionStatus=V
SOAP
SOAP Web Services utilizing SOAP version 1.1 or SOAP version 1.2 to transport data. Connectivity requires 2048 bit TLS security.
DoCreditCardSecondaryVoid
https://connect.instamed.com/payment/service.asmx?op=DoCreditCardSecondaryVoid
InstaMed Online
Standalone portal for software vendors who do not yet have a consumer-facing application to embed into.
Using Payment Quick Search, find the payment and click void on the receipt.
https://online.instamed.com/providers/Form/PatientPayments/PaymentQuickSearch