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. |
Capture (capture)
Transaction captures flag existing authorizations for settlement. Only authorizations can be captured. Captures can be submitted for an amount equal to or less than the original authorization.
| Variable Name | Description |
|---|---|
| type* | Type of transaction. Values: 'capture' |
| 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 settled. This amount must be equal to or less than the original authorized amount. Format: x.xx |
| tracking_number | Shipping tracking number |
| shipping_carrier | Shipping carrier. Values: 'ups', 'fedex', 'dhl', or 'usps' |
| orderid | Order id. |
| signature_image | Cardholder signature image. Format: base64 encoded raw PNG image. (16kiB maximum) |
| * | Always required |
Comments
0 comments
Please sign in to leave a comment.