Integrate refund (or credit) transactions to transfer funds to a consumer account
A Simple Refund is refund tied to a specific transaction and can only be made to an amount less than or equal to the original transaction amount. It can be performed up to one year following a transaction using the original transaction ID.
Integration Options
Refunds may be implemented differently than payment transactions.
Refund Payment SSO
Refunds may be integrated via Single Sign-On (SSO) for provider facing implementations. The receipt is generated by InstaMed.
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=SimpleRefund&MerchantID=123123123&StoreID=123&TerminalID=123&primaryTransactionID=2FA23B1C2C8C4E0D951C24EB300DCCFB&primaryCardPresentStatus=PresentManualKey&amount=10.00&
Sample Response
IsEMVVerifiedByPIN=false&isEMVTransaction=FALSE&EMVCardEntryMode=KEYED&cardBrand=DISCOVER&cardExpirationMonth=12&cardExpirationYear=2019&cardBINNumber=601100&cardHolderName=JOE MONTANA&paymentCardType=CREDIT&lastFourDigits=9424&authorizationNumber=9A5DDA&responseCode=000&responseMessage=APPROVAL&transactionStatus=C&primaryTransactionID=D5E2BF0800AB41CEAC2D8CBF406E800E&authorizationText=THE ABOVE AMOUNT HAS BEEN REFUNDED.&transactionID=96A66FDA25964C8F9C0AEB0EF8123AAF&transactionDate=2016-04-27T19:17:05.2770143Z&saveOnFileTransactionID=2FA23B1C2C8C4E0D951C24EB300DCCFB
SOAP
SOAP Web Services utilizing SOAP version 1.1 or SOAP version 1.2 to transport data. Connectivity requires 2048 bit TLS security.
DoCreditCardSimpleRefund
https://connect.instamed.com/payment/service.asmx?op=DoCreditCardSimpleRefund
DoCreditCardCredit
https://connect.instamed.com/payment/service.asmx?op=DoCreditCardCredit
DoECheckCredit
https://connect.instamed.com/payment/service.asmx?op=DoECheckCredit
InstaMed Online
Standalone portal for software vendors who do not yet have a consumer-facing application to embed into.
https://online.instamed.com/providers/Form/PatientPayments/NewPatientPayment