Capture

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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
Query Params
string
required

The type of transaction to be processed.
Values: 'sale', 'auth', 'credit', 'validate', or 'offline'

string
required

The API Login ID from the site you want to associate this transaction with.

string
required

The Transaction Key from the site you want to associate this transaction with.

integer
required

Original payment gateway transaction id.

string

Shipping carrier. Values: 'ups', 'fedex', 'dhl', or 'usps'

string

Order id.

string

Cardholder signature image. Format: base64 encoded raw PNG image. (16kiB maximum)

Form Data
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!