Refund
OpenPath NMI Emulation API supports secure POST requests in multiple formats to process refunds, allowing merchants to reverse settled transactions using minimal, structured parameters.
POST
POST URL:
https://api.openpath.io/v1/nmi
The Openpath NMI Emulation API can receive Transactions posted in any of the following formats listed below:
| Format | Description |
|---|---|
| Query String (Not Recommended) | A query string is part of a URL that assigns values to specified parameters. It is commonly used in browsers for HTML display or media navigation. |
| Form Data | Uses the multipart/form-data encoding format. |
| X-WWW Form URL Encoded (Recommended) | Uses the application/x-www-form-urlencoded encoding, the default format for form submissions. To send a request with multipart/form-data, you must explicitly specify it using the enctype attribute. |
Refund (refund)
refund)Transaction refunds reverse a previously settled or pending settlement transaction. If the transaction has not been settled, a transaction void can also reverse it.
Request Parameters
| Variable Name | Description |
|---|---|
type* | Type of transaction. Value: refund |
username* | Site Username assigned to a merchant Site account as API Login ID. |
password* | Site Password assigned to a merchant Site account as Transaction Key. |
transactionid* | Original payment gateway transaction ID. |
amount | Total amount to be refunded. Must be less than or equal to the settled amount. Set to 0.00 to refund the entire amount. Format: x.xx |
payment** | Type of payment. Default: creditcard. Values: creditcard or check. |
Note:
- Always required
** Required for ACH transactions
Updated 7 days ago
What’s Next