Capture
Use supported POST formats like Query String (not recommended), Form Data, or X-WWW Form URL Encoded (recommended) for transactions. The capture function allows settlement of authorized transactions, with specific parameters.
POST
POST URL:
[https://api.openpath.io/v1/nmi](https://api.openpath.io/api/transact.php)
The OpenPath NMI Emulation API can receive transactions posted in the following formats:
| Format | Description |
|---|---|
| Query String (Not Recommended) | A query string is part of a URL that assigns values to specified parameters. It is commonly used for HTML or multimedia content navigation. |
| Form Data | The FormData interface allows constructing key/value pairs representing form fields and values, sent using the XMLHttpRequest.send() method, in the multipart/form-data encoding. |
| X-WWW Form URL Encoded (Recommended) | application/x-www-form-urlencoded is the default encoding used by web forms. It must be specified explicitly for multipart/form-data submissions. |
Capture (capture)
capture)Capture transactions flag existing authorizations for settlement. Only authorizations can be captured.The amount submitted for capture must be equal to or less than the original authorization amount.
Request Parameters
| Variable Name | Description |
|---|---|
type* | Type of transaction.<br>Value: capture |
username* | Site Username (API Login ID) assigned to the merchant account |
password* | Site Password (Transaction Key) assigned to the merchant account |
transactionid* | Original payment gateway transaction ID |
amount* | Total amount to be settled.<br>Format: x.xx<br>Must be ≤ original authorized amount |
tracking_number | Shipping tracking number |
shipping_carrier | Shipping carrier<br>Values: ups, fedex, dhl, usps |
orderid | Order ID |
signature_image | Cardholder signature image<br>Format: Base64 encoded PNG image (max 16KiB) |
***** Required fields
Updated 10 days ago
What’s Next