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:
Query String (Not Recommended) |
A query string is a part of a uniform resource locator (URL) that assigns values to specified parameters. A query string commonly includes fields added to a base URL by a Web browser or other client application, for example as part of an HTML, choosing the appearance of a page, or jumping to positions in multimedia content. |
Form Data | The FormData interface provides a way to easily construct a set of key/value pairs representing form fields and their values, which can then be easily sent using the XMLHttpRequest.send() method. It uses the same format a form would use if the encoding type were set to "multipart/form-data". |
X-WWW Form URL Encoded (Recommended) |
"application/x-www-form-urlencoded" is the default encoding (in HTTP terms Content-Type) a web form uses to transfer data, not multipart/form-data. To send an HTTP post request on form submission with a Content Type of multipart/form-data, one must explicitly specify this as the enctype value. |
Void (void)
Transaction voids will cancel an existing sale or captured authorization. In addition, non-captured authorizations can be voided to prevent any future capture. Voids can only occur if the transaction has not been settled.
Variable Name | Description |
---|---|
type* | Type of transaction. Values: 'void' |
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 |
void_reason** | Reason the EMV transaction is being voided. Values: 'fraud', 'user_cancel', 'icc_rejected', 'icc_card_removed', 'icc_no_confirmation', or 'pos_timeout' |
payment*** | The type of payment. Default: 'creditcard' Values: 'creditcard' or 'check' |
* | Always required |
** | Conditionally required for EMV transactions |
*** | Required for ACH transactions |
Comments
0 comments
Please sign in to leave a comment.