The Openpath NMI Emulation API accepts transactions via query string, form data, or recommended URL-encoded POST. Responses include metadata in custom headers like PacketId and GatewayName.
Post Formats
The OpenPath NMI Emulation API accepts transactions in any of the following formats:
Query String (Not Recommended)
Transactions can be submitted using a URL query string, where key/value pairs are appended to the URL. While functional, this method is less secure and not recommended for transmitting sensitive data.
Form Data
This format uses multipart/form-data encoding, commonly used in file uploads and form submissions. It allows key/value pairs to be sent via HTTP POST using the XMLHttpRequest.send() method or equivalent.
Form URL Encoded (Recommended)
This is the default format for web forms (application/x-www-form-urlencoded). Key/value pairs are encoded in the body of an HTTP POST request. This format is secure, efficient, and recommended for transaction submission.
Response Headers
NOTE: Besides the response body, OpenPath will also include our internal payment packet ID, the server which executed the transaction, the OpenPath Payment Provider/Gateway "Connector" ID and the name of that connector in the following format:
- X-OpenPath-PacketId
- X-OpenPath-Server
- X-OpenPath-GatewayId
- X-OpenPath-GatewayName