![\"alt](\"http://docs.openpath.io/uploads/1/9/3/8/1938894/emulation-introduction-howitwork_orig.png\")
To help our customers integrate quickly, OpenPath has implemented gateway emulation for NMI. This means that our system’s frontend accepts API requests as if OpenPath was NMI.
\nIf your Point of Sales system is currently integrated into NMI, integrating to OpenPath is as easy as changing your NMI URL from secure.networkmerchants.com to the OpenPath URL of api.openpath.io and OpenPath will manage your transactions from there.
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:
\nThe type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","key":"type","type":"text","value":"sale"},{"description":"The API Login ID from the site you want to associate this transaction with.
\n","key":"username","type":"text","value":"{{basic-site_username}}"},{"description":"The Transaction Key from the site you want to associate this transaction with.
\n","key":"password","type":"text","value":"{{basic-site_password}}"},{"description":"Credit card number.
\n","key":"ccnumber","type":"text","value":"4111111111111111"},{"description":"Credit card expiration date.\nFormat: MMYY
\n","key":"ccexp","type":"text","value":"1228"},{"description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","key":"amount","type":"text","value":"19.95"}]},"url":"{{url}}/api/transact.php","description":"Transaction sales are submitted and immediately flagged for settlement.
\nNOTE: 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:
\nThe type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n"},{"key":"username","value":"{{basic-site_username}}","type":"text","description":"The API Login ID from the site you want to associate this transaction with.
\n"},{"key":"password","value":"{{basic-site_password}}","type":"text","description":"The Transaction Key from the site you want to associate this transaction with.
\n"},{"key":"ccnumber","value":"4111111111111111","type":"text","description":"Credit card number.
\n"},{"key":"ccexp","value":"1228","type":"text","description":"Credit card expiration date.\nFormat: MMYY
\n"},{"key":"cvv","value":"111","type":"text","description":"The card security code. While this is not required, it is strongly recommended.
\n"},{"key":"amount","value":"109.95","type":"text","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n"},{"key":"sec_code","value":"WEB","type":"text","description":"The Standard Entry Class code of the ACH transaction.\nValues: 'PPD', 'WEB', 'TEL', or 'CCD'
\n"},{"key":"surcharge","value":"0.95","type":"text","description":"Surcharge amount.\nFormat: x.xx
\n"},{"key":"currency","value":"USD","type":"text","description":"The transaction currency. Format: ISO 4217
\n"},{"key":"payment","value":"creditcard","type":"text","description":"The type of payment.\nDefault: 'creditcard'\nValues: 'creditcard', or 'check'
\n"},{"key":"dup_seconds","value":"360","type":"text","description":"Sets the time in seconds for duplicate transaction checking on supported processors. Set to 0 to disable duplicate checking.
\n"},{"key":"descriptor","value":"OpenPath Payments","type":"text","description":"Set payment descriptor on supported processors.
\n"},{"key":"descriptor_phone","value":"9495005555","type":"text","description":"Set payment descriptor phone on supported processors.
\n"},{"key":"descriptor_address","value":"200 Spectrum Center Drive","type":"text","description":"Set payment descriptor address on supported processors.
\n"},{"key":"descriptor_city","value":"Irvine","type":"text","description":"Set payment descriptor city on supported processors.
\n"},{"key":"descriptor_state","value":"CA","type":"text","description":"Set payment descriptor state on supported processors.
\n"},{"key":"descriptor_postal","value":"92618","type":"text","description":"Set payment descriptor postal code on supported processors.
\n"},{"key":"descriptor_country","value":"US","type":"text","description":"Set payment descriptor country on supported processors.
\n"},{"key":"descriptor_mcc","value":"6012","type":"text","description":"Set payment descriptor mcc on supported processors.
\n"},{"key":"descriptor_merchant_id","value":"555555555555","type":"text","description":"Set payment descriptor merchant id on supported processors.
\n"},{"key":"descriptor_url","value":"https://openpath.io","type":"text","description":"Set payment descriptor url on supported processors.
\n"},{"key":"order_description","value":"OpenPath Emulation API Maximum Sale Request.","type":"text","description":"Order description.\nLegacy variable includes: orderdescription
\n"},{"key":"orderid","value":"BS-139301","type":"text","description":"Order Id
\n"},{"key":"ipaddress","value":"209.160.251.114","type":"text","description":"IP address of cardholder, this field is recommended.\nFormat: xxx.xxx.xxx.xxx
\n"},{"key":"tax","value":"2.50","type":"text","description":"Total tax amount.
\n"},{"key":"shipping","value":"5.00","type":"text","description":"Total shipping amount.
\n"},{"key":"first_name","value":"Jarvis","type":"text","description":"Cardholder's first name.\nLegacy variable includes: firstname
\n"},{"key":"last_name","value":"Russel","type":"text","description":"Cardholder's last name\nLegacy variable includes: lastname
\n"},{"key":"company","value":"Senger Group","type":"text","description":"Cardholder's company
\n"},{"key":"address1","value":"869 Verdie Overpass","type":"text","description":"Card billing address
\n"},{"key":"address2","value":"Suite 4210","type":"text","description":"Card billing address, line 2.
\n"},{"key":"city","value":"Keller","type":"text","description":"Card billing city
\n"},{"key":"state","value":"CA","type":"text","description":"Card billing state.\nFormat: CC
\n"},{"key":"zip","value":"92618","type":"text","description":"Card billing zip code
\n"},{"key":"country","value":"US","type":"text","description":"Card billing country.\nCountry codes are as shown in ISO 3166. Format: CC
\n"},{"key":"phone","value":"9496006666","type":"text","description":"Billing phone number
\n"},{"key":"email","value":"Arnulfo_Dicki@yahoo.com","type":"text","description":"Billing email address
\n"},{"key":"shipping_address1","value":"070 Conrad Villages","type":"text","description":"Shipping address
\n"},{"key":"shipping_city","value":"Lake Cheyanne","type":"text","description":"Shipping city.
\n"},{"key":"shipping_state","value":"MI","type":"text","description":"Shipping state\nFormat: CC
\n"},{"key":"shipping_zip","value":"48823","type":"text","description":"Shipping zip code
\n"},{"key":"shipping_country","value":"US","type":"text","description":"Shipping country\nCountry codes are as shown in ISO 3166. Format: CC
\n"},{"key":"item_product_code_1","value":"SKU-100","type":"text","description":"Merchant defined description code of the item being purchased.
\n"},{"key":"item_description_1","value":"Very cool item #1","type":"text","description":"Description of the item(s) being supplied.
\n"},{"key":"item_unit_cost_1","value":"6.00","type":"text","description":"Unit cost of item purchased, may contain up to 4 decimal places.
\n"},{"key":"item_quantity_1","value":"1","type":"text","description":"Quantity of the item(s) being purchased.\nDefault: '1'
\n"},{"key":"item_total_amount_1","value":"6.00","type":"text","description":"Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny.
\n"},{"key":"item_product_code_2","value":"SKU-200","type":"text","description":"Merchant defined description code of the item being purchased.
\n"},{"key":"item_description_2","value":"Very cool item #2","type":"text","description":"Description of the item(s) being supplied.
\n"},{"key":"item_unit_cost_2","value":"8.00","type":"text","description":"Unit cost of item purchased, may contain up to 4 decimal places.
\n"},{"key":"item_quantity_2","value":"1","type":"text","description":"Quantity of the item(s) being purchased.\nDefault: '1'
\n"},{"key":"item_total_amount_2","value":"8.00","type":"text","description":"Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny.
\n"}]},"url":"{{url}}/api/transact.php","description":"Transaction sales are submitted and immediately flagged for settlement.
\nNOTE: 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:
\nThe type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n"},{"key":"username","value":"{{basic-site_username}}","type":"text","description":"The API Login ID from the site you want to associate this transaction with.
\n"},{"key":"password","value":"{{basic-site_password}}","type":"text","description":"The Transaction Key from the site you want to associate this transaction with.
\n"},{"key":"ccnumber","value":"4111111111111111","type":"text","description":"Credit card number.
\n"},{"key":"ccexp","value":"1228","type":"text","description":"Credit card expiration date.\nFormat: MMYY
\n"},{"key":"amount","value":"237.95","type":"text","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n"}]},"url":"{{url}}/api/transact.php","description":"Transaction authorizations are authorized immediately but are not flagged for settlement. These transactions must be flagged for settlement using the capture transaction type.
\nNOTE: 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:
\nThe type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n"},{"key":"username","value":"{{basic-site_username}}","type":"text","description":"The API Login ID from the site you want to associate this transaction with.
\n"},{"key":"password","value":"{{basic-site_password}}","type":"text","description":"The Transaction Key from the site you want to associate this transaction with.
\n"},{"key":"transactionid","value":"{{transaction_id-003}}","type":"text","description":"Original payment gateway transaction id.
\n"}]},"url":"{{url}}/api/transact.php","description":"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.
\nNOTE: 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:
\nThe type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n"},{"key":"username","value":"{{basic-site_username}}","type":"text","description":"The API Login ID from the site you want to associate this transaction with.
\n"},{"key":"password","value":"{{basic-site_password}}","type":"text","description":"The Transaction Key from the site you want to associate this transaction with.
\n"},{"key":"ccnumber","value":"4111111111111111","type":"text","description":"Credit card number.
\n"},{"key":"ccexp","value":"1228","type":"text","description":"Credit card expiration date.\nFormat: MMYY
\n"},{"key":"cvv","value":"111","type":"text","description":"The card security code. While this is not required, it is strongly recommended.
\n"},{"key":"amount","value":"109.95","type":"text","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n"},{"key":"sec_code","value":"WEB","type":"text","description":"The Standard Entry Class code of the ACH transaction.\nValues: 'PPD', 'WEB', 'TEL', or 'CCD'
\n"},{"key":"surcharge","value":"0.95","type":"text","description":"Surcharge amount.\nFormat: x.xx
\n"},{"key":"currency","value":"USD","type":"text","description":"The transaction currency. Format: ISO 4217
\n"},{"key":"payment","value":"creditcard","type":"text","description":"The type of payment.\nDefault: 'creditcard'\nValues: 'creditcard', or 'check'
\n"},{"key":"dup_seconds","value":"360","type":"text","description":"Sets the time in seconds for duplicate transaction checking on supported processors. Set to 0 to disable duplicate checking.
\n"},{"key":"descriptor","value":"OpenPath Payments","type":"text","description":"Set payment descriptor on supported processors.
\n"},{"key":"descriptor_phone","value":"9495005555","type":"text","description":"Set payment descriptor phone on supported processors.
\n"},{"key":"descriptor_address","value":"200 Spectrum Center Drive","type":"text","description":"Set payment descriptor address on supported processors.
\n"},{"key":"descriptor_city","value":"Irvine","type":"text","description":"Set payment descriptor city on supported processors.
\n"},{"key":"descriptor_state","value":"CA","type":"text","description":"Set payment descriptor state on supported processors.
\n"},{"key":"descriptor_postal","value":"92618","type":"text","description":"Set payment descriptor postal code on supported processors.
\n"},{"key":"descriptor_country","value":"US","type":"text","description":"Set payment descriptor country on supported processors.
\n"},{"key":"descriptor_mcc","value":"6012","type":"text","description":"Set payment descriptor mcc on supported processors.
\n"},{"key":"descriptor_merchant_id","value":"555555555555","type":"text","description":"Set payment descriptor merchant id on supported processors.
\n"},{"key":"descriptor_url","value":"https://openpath.io","type":"text","description":"Set payment descriptor url on supported processors.
\n"},{"key":"order_description","value":"OpenPath Emulation API Maximum Sale Request.","type":"text","description":"Order description.\nLegacy variable includes: orderdescription
\n"},{"key":"orderid","value":"BS-792887","type":"text","description":"Order Id
\n"},{"key":"ipaddress","value":"209.160.251.114","type":"text","description":"IP address of cardholder, this field is recommended.\nFormat: xxx.xxx.xxx.xxx
\n"},{"key":"tax","value":"2.50","type":"text","description":"Total tax amount.
\n"},{"key":"shipping","value":"5.00","type":"text","description":"Total shipping amount.
\n"},{"key":"first_name","value":"Tommie","type":"text","description":"Cardholder's first name.\nLegacy variable includes: firstname
\n"},{"key":"last_name","value":"Keeling","type":"text","description":"Cardholder's last name\nLegacy variable includes: lastname
\n"},{"key":"company","value":"Kihn, Stroman and Ernser","type":"text","description":"Cardholder's company
\n"},{"key":"address1","value":"13723 Denis Cape","type":"text","description":"Card billing address
\n"},{"key":"address2","value":"Suite 4210","type":"text","description":"Card billing address, line 2.
\n"},{"key":"city","value":"Strosinborough","type":"text","description":"Card billing city
\n"},{"key":"state","value":"CA","type":"text","description":"Card billing state.\nFormat: CC
\n"},{"key":"zip","value":"92618","type":"text","description":"Card billing zip code
\n"},{"key":"country","value":"US","type":"text","description":"Card billing country.\nCountry codes are as shown in ISO 3166. Format: CC
\n"},{"key":"phone","value":"9496006666","type":"text","description":"Billing phone number
\n"},{"key":"email","value":"Jabari19@gmail.com","type":"text","description":"Billing email address
\n"},{"key":"shipping_address1","value":"4686 Jerod Island","type":"text","description":"Shipping address
\n"},{"key":"shipping_city","value":"Novato","type":"text","description":"Shipping city.
\n"},{"key":"shipping_state","value":"MI","type":"text","description":"Shipping state\nFormat: CC
\n"},{"key":"shipping_zip","value":"48823","type":"text","description":"Shipping zip code
\n"},{"key":"shipping_country","value":"US","type":"text","description":"Shipping country\nCountry codes are as shown in ISO 3166. Format: CC
\n"},{"key":"item_product_code_1","value":"SKU-100","type":"text","description":"Merchant defined description code of the item being purchased.
\n"},{"key":"item_description_1","value":"Very cool item #1","type":"text","description":"Description of the item(s) being supplied.
\n"},{"key":"item_unit_cost_1","value":"6.00","type":"text","description":"Unit cost of item purchased, may contain up to 4 decimal places.
\n"},{"key":"item_quantity_1","value":"1","type":"text","description":"Quantity of the item(s) being purchased.\nDefault: '1'
\n"},{"key":"item_total_amount_1","value":"6.00","type":"text","description":"Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny.
\n"},{"key":"item_product_code_2","value":"SKU-200","type":"text","description":"Merchant defined description code of the item being purchased.
\n"},{"key":"item_description_2","value":"Very cool item #2","type":"text","description":"Description of the item(s) being supplied.
\n"},{"key":"item_unit_cost_2","value":"8.00","type":"text","description":"Unit cost of item purchased, may contain up to 4 decimal places.
\n"},{"key":"item_quantity_2","value":"1","type":"text","description":"Quantity of the item(s) being purchased.\nDefault: '1'
\n"},{"key":"item_total_amount_2","value":"8.00","type":"text","description":"Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny.
\n"}]},"url":"{{url}}/api/transact.php","description":"Transaction authorizations are authorized immediately but are not flagged for settlement. These transactions must be flagged for settlement using the capture transaction type.
\nNOTE: 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:
\nThe type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n"},{"key":"username","value":"{{basic-site_username}}","type":"text","description":"The API Login ID from the site you want to associate this transaction with.
\n"},{"key":"password","value":"{{basic-site_password}}","type":"text","description":"The Transaction Key from the site you want to associate this transaction with.
\n"},{"key":"transactionid","value":"{{transaction_id-004}}","type":"text","description":"Original payment gateway transaction id.
\n"}]},"url":"{{url}}/api/transact.php","description":"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.
\nNOTE: 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:
\nThe type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n"},{"key":"username","value":"{{basic-site_username}}","type":"text","description":"The API Login ID from the site you want to associate this transaction with.
\n"},{"key":"password","value":"{{basic-site_password}}","type":"text","description":"The Transaction Key from the site you want to associate this transaction with.
\n"},{"key":"ccnumber","value":"4111111111111111","type":"text","description":"Credit card number.
\n"},{"key":"ccexp","value":"1228","type":"text","description":"Credit card expiration date.\nFormat: MMYY
\n"}]},"url":"{{url}}/api/transact.php","description":"This action is used for doing an \"Account Verification\" on the cardholder's credit card without actually doing an authorization.
\nNOTE: 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:
\ntype\nThe type of transaction to be processed. Values: 'sale', 'auth', 'credit' or 'validate'
\nsecurity_key\nAPI Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys
\npayment_token\nThe tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.
\nccnumber\nCredit card number.
\nccexp\nCredit card expiration date. Format: MMYY
\ncvv\nThe card security code. While this is not required, it is strongly \nrecommended.
\ncheckname\nThe name on the customer's ACH account.
\ncheckaba\nThe customer's bank routing number.
\ncheckaccount\nThe customer's bank account number.
\naccount_holder_type\nThe type of ACH account the customer has. Values: 'business' or 'personal'
\naccount_type\nThe ACH account entity of the customer. Values: 'checking' or 'savings'
\nsec_code\nThe Standard Entry Class code of the ACH transaction. Values: 'PPD', 'WEB', 'TEL', or 'CCD'
\namount\nTotal amount to be charged. For validate, the amount must be omitted or set to 0.00. Format: x.xx
\nsurcharge\nSurcharge amount. Format: x.xx
\ncurrency\nThe transaction currency. Format: ISO 4217
\npayment\nThe type of payment. Default: 'creditcard' Values: 'creditcard', 'check', or 'cash'
\nprocessor_id\nIf using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).
\nauthorization_code\nSpecify authorization code. For use with \"offline\" action only.
\ndup_seconds\nSets the time in seconds for duplicate transaction checking on supported processors. Set to 0 to disable duplicate checking.
\ndescriptor Set\npayment descriptor on supported processors.
\ndescriptor_phone\nSet payment descriptor phone on supported processors.
\ndescriptor_address\nSet payment descriptor address on supported processors.
\ndescriptor_city\nSet payment descriptor city on supported processors.
\ndescriptor_state\nSet payment descriptor state on supported processors.
\ndescriptor_postal\nSet payment descriptor postal code on supported processors.
\ndescriptor_country\nSet payment descriptor country on supported processors.
\ndescriptor_mcc\nSet payment descriptor mcc on supported processors.
\ndescriptor_merchant_id\nSet payment descriptor merchant id on supported processors.
\ndescriptor_url\nSet payment descriptor url on supported processors.
\nbilling_method\nShould be set to 'recurring' to mark payment as a recurring transaction or 'installment' to mark payment as an installment transaction.\nValues: 'recurring', 'installment'
\nbilling_number\nSpecify installment billing number, on supported processors. For use when \"billing_method\" is set to installment. Values: 0-99
\nbilling_total\nSpecify installment billing total on supported processors. For use when \"billing_method\" is set to installment.
\norder_template\nOrder template ID.
\norder_description\nOrder description. Legacy variable includes: orderdescription
\norderid\nOrder Id
\nipaddress\nIP address of cardholder, this field is recommended. Format: xxx.xxx.xxx.xxx
\ntax\nTotal tax amount.
\nshipping\nTotal shipping amount
\nponumber\nOriginal purchase order
\nfirst_name Cardholder's first name. Legacy variable includes: firstname
\nlast_name\nCardholder's last name Legacy variable includes: lastname
\ncompany\nCardholder's company
\naddress1\nCard billing address
\naddress2\nCard billing address, line 2
\ncity\nCard billing city
\nstate\nCard billing state. Format: CC
\nzip\nCard billing zip code
\ncountry\nCard billing country. Country codes are as shown in ISO 3166. Format: CC
\nphone\nBilling phone number
\nfax\nBilling fax number
\nemail\nBilling email address
\nsocial_security_number\nCustomer's social security number, checked against bad check writers database if check verification is enabled.
\ndrivers_license_number\nDriver's license number.
\ndrivers_license_dob\nDriver's license date of birth.
\ndrivers_license_state\nThe state that issued the customer's driver's license.
\nshipping_firstname\nShipping first name
\nshipping_lastname\nShipping last name
\nshipping_company\nShipping company
\nshipping_address1\nShipping address
\nshipping_address2\nShipping address, line 2
\nshipping_city\nShipping city
\nshipping_state\nShipping state Format: CC
\nshipping_zip\nShipping zip code
\nshipping_country\nShipping country Country codes are as shown in ISO 3166. Format: CC
\nshipping_email\nShipping email address
\nmerchant_defined_field_#\nYou can pass custom information in up to 20 fields. Format: merchant_defined_field_1=Value
\ncustomer_receipt\nIf set to true, when the customer is charged, they will be sent a transaction receipt. Values: 'true' or 'false'
\nsignature_image\nCardholder signature image. For use with \"sale\" and \"auth\" actions only. Format: base64 encoded raw PNG image. (16kiB maximum)
\ncardholder_auth\nSet 3D Secure condition. Values: 'verified' or 'attempted'
\neci\nE-commerce indicator. Values: '0', '1', '2', '5', '6', or '7'
\ncavv\nCardholder authentication verification value. Format: base64 encoded
\nxid\nCardholder authentication transaction id. Format: base64 encoded
\nthree_ds_version\n3DSecure version. Examples: \"1.0.2\" or \"2.0\"
\ndirectory_server_id\nDirectory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication.\nFormat: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
\nsource_transaction_id\nSpecifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. Recurring specific fields
\nrecurring\nRecurring action to be processed. Values: add_subscription
\nplan_id\nCreate a subscription tied to a Plan ID if the sale/auth transaction is successful.
\nplan_payments\nThe number of payments before the recurring plan is complete. Note: Use '0' for 'until canceled'
\nplan_amount\nThe plan amount to be charged each billing cycle. Format: x.xx
\nday_frequency\nHow often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.\nmonth_frequency How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Values: 1 through 24
\nday_of_month\nThe day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. Values: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day
\nstart_date\nThe first day that the customer will be charged. Format: YYYYMMDD
\ncustomer_vault\nAssociate payment information with a Customer Vault record if the transaction is successful. Values: 'add_customer' or 'update_customer'
\ncustomer_vault_id\nSpecifies a customer vault id. If not set, the payment gateway will randomly generate a customer vault id.\nStored Credentials (CIT/MIT)
\ninitiated_by\nWho initiated the transaction. Values: 'customer' or 'merchant'
\ninitial_transaction_id\nOriginal payment gateway transaction id.
\nstored_credential_indicator\nThe indicator of the stored credential. Values: 'stored' or 'used' Use 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
\nshipping\nFreight or shipping amount included in the transaction amount Default: '0.00' Format: x.xx
\ntax\nThe sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default: '0.00' Format: x.xx
\nponumber\nPurchase order number supplied by cardholder
\norderid\nIdentifier assigned by the merchant. This defaults to gateway transaction id.
\nshipping_country\nShipping country (e.g. US) Format: CC
\nshipping_postal\nPostal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods.
\nship_from_postal\nPostal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code.
\nsummary_commodity_code\n4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes.
\nduty_amount\nAmount included in the transaction amount associated with the import of purchased goods. Default: '0.00' Format: x.xx
\ndiscount_amount\nAmount included in the transaction amount of any discount applied to complete order by the merchant. Default: '0.00' Format: x.xx
\nnational_tax_amount\nThe national tax amount included in the transaction amount. Default: '0.00' Format: x.xx
\nalternate_tax_amount\nSecond tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases.\nDefault: '0.00'\nFormat: x.xx\nalternate_tax_id Tax identification number of the merchant that reported the alternate tax amount.\nvat_tax_amount Contains the amount of any value added taxes which can be associated with the purchased item. Default: '0.00' Format: x.xx
\nvat_tax_rate\nContains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default: '0.00' Format: x.xx
\nvat_invoice_reference_number\nInvoice number that is associated with the VAT invoice.
\ncustomer_vat_registration\nValue added tax registration number supplied by the cardholder.
\nmerchant_vat_registration\nGovernment assigned tax identification number of the merchant for whom the goods or services were purchased from.
\norder_date\nPurchase order date, defaults to the date of the transaction. Format: YYMMDD
\nitem_product_code_#\nMerchant defined description code of the item being purchased.
\nitem_description_#\nDescription of the item(s) being supplied.
\nitem_commodity_code_#\nInternational description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes.
\nitem_unit_of_measure_#\nCode for units of measurement as used in international trade. Default: 'EACH'
\nitem_unit_cost_#\nUnit cost of item purchased, may contain up to 4 decimal places.
\nitem_quantity_#\nQuantity of the item(s) being purchased. Default: '1'
\nitem_total_amount_#\nPurchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny.
\nitem_tax_amount_#\nAmount of tax on specific item, amount should not be included in 'total_amount_#'. Default: '0.00'
\nitem_tax_rate_#\nPercentage representing the value-added tax applied. Default: '0.00'
\nitem_discount_amount_#\nDiscount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'.
\nitem_discount_rate_#\nDiscount rate for the line item. 1% = 1.00. Default: '0.00'
\nitem_tax_type_#\nType of value-added taxes that are being used.
\nitem_alternate_tax_id_#\nTax identification number of the merchant that reported the alternate tax amount.
\n","event":[{"listen":"prerequest","script":{"id":"487ee199-0a05-4fee-9e76-bee565ab83cf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e05a1c1e-0a42-43ec-bdb0-56882510a39e","type":"text/javascript","exec":[""]}}],"_postman_id":"04c21e4b-2b72-4b1b-ac72-335acd5f1663"},{"name":"Void & Refund","item":[{"name":"VOID - Maximum Request","event":[{"listen":"test","script":{"id":"b31f15e0-0c49-4b94-8aa9-9097f8a12002","exec":["pm.test(\"Status test\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Received an approved response\", function () {\r"," pm.expect(pm.response.text()).to.include(\"response=1\");\r","});"],"type":"text/javascript"}}],"id":"da027086-2417-47f2-a8c0-8a48fd3e1b8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Type of transaction.\nValues: 'void'
\n","key":"type","type":"text","value":"void"},{"description":"The API Login ID from the site you want to associate this transaction with.
\n","key":"username","type":"text","value":"{{basic-site_username}}"},{"description":"The Transaction Key from the site you want to associate this transaction with.
\n","key":"password","type":"text","value":"{{basic-site_password}}"},{"description":"Original payment gateway transaction id
\n","key":"transactionid","type":"text","value":"{{transaction_id-001}}"}]},"url":"{{url}}/api/transact.php","description":"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.
\nNOTE: 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:
\nThe type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","key":"type","type":"text","value":"refund"},{"key":"username","type":"text","value":"{{basic-site_username}}"},{"key":"password","type":"text","value":"{{basic-site_password}}"},{"key":"transactionid","value":"{{transaction_id-002}}","type":"text"}]},"url":"{{url}}/api/transact.php","description":"Transaction refunds will reverse a previously settled or pending settlement transaction. If the transaction has not been settled, a transaction void can also reverse it.
\nNOTE: 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:
\nThe type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","key":"type","type":"text","value":"refund"},{"key":"username","type":"text","value":"{{basic-site_username}}"},{"key":"password","type":"text","value":"{{basic-site_password}}"},{"key":"transactionid","type":"text","value":"{{transaction_id-003}}"}]},"url":"{{url}}/api/transact.php","description":"Transaction refunds will reverse a previously settled or pending settlement transaction. If the transaction has not been settled, a transaction void can also reverse it.
\nNOTE: 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:
\nAdd/Update a secure customer vault record.\nValues: 'add_customer' or 'update_customer'
\n","key":"customer_vault","type":"text","value":"add_customer"},{"key":"username","type":"text","value":"{{basic-site_username}}"},{"key":"password","type":"text","value":"{{basic-site_password}}"},{"description":"Credit card number.
\n","key":"ccnumber","type":"text","value":"4111111111111111"},{"description":"Credit card expiration date.\nFormat: MMYY
\n","key":"ccexp","type":"text","value":"1228"},{"description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","key":"amount","type":"text","value":"19.95"}]},"url":"{{url}}/api/transact.php","urlObject":{"path":["api","transact.php"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"28b3b0fa-2352-4a75-b870-adc3600ef655"},{"name":"SALE BY TOKEN - Minimum Request","event":[{"listen":"test","script":{"id":"5b532ae4-ea23-48f6-aa35-28c27a7e03d5","exec":["pm.test(\"Status test\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","// nmis sandbox does not support testing tokens, change the check for nmi\r","var environment = pm.environment.get(\"url\");\r","\r","tests[\"URL = \" + environment] = true;\r","tests[\"Is NMI? = \" + (environment == \"https://secure.networkmerchants.com\")] = true;\r","\r","if(environment == \"https://secure.networkmerchants.com\") {\r"," \r"," pm.test(\"Received an expected NMI error response\", function () {\r"," pm.expect(pm.response.text()).to.include(\"response=3\");\r"," });\r"," \r","}\r","else {\r"," \r"," pm.test(\"Received an approved response\", function () {\r"," pm.expect(pm.response.text()).to.include(\"response=1\");\r"," });\r"," \r","}\r",""],"type":"text/javascript"}}],"id":"009fb186-f56e-422f-a0ab-ce1dad093a22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Add/Update a secure customer vault record.\nValues: 'add_customer' or 'update_customer'
\n","key":"customer_vault","type":"text","value":"sale"},{"key":"username","type":"text","value":"{{basic-site_username}}"},{"key":"password","type":"text","value":"{{basic-site_password}}"},{"key":"customer_vault_id","value":"{{payment_token-001}}","type":"text"},{"description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","key":"amount","type":"text","value":"19.95"}]},"url":"{{url}}/api/transact.php","urlObject":{"path":["api","transact.php"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"009fb186-f56e-422f-a0ab-ce1dad093a22"},{"name":"SALE W/ TOKEN - Minimum Request","event":[{"listen":"test","script":{"id":"84d0a305-e653-4d3e-9f7e-9900cd24715b","exec":["pm.test(\"Status test\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Received an approved response\", function () {\r"," pm.expect(pm.response.text()).to.include(\"response=1\");\r","});\r","\r","var payementToken = getQueryVariable(pm.response.text(), 'customer_vault_id');\r","\r","pm.globals.set(\"min_payment_token\", payementToken);\r","\r","tests[\"Payment Token = \" + payementToken] = true;\r","tests[\"Payment Token Received\"] = payementToken.includes('payment_');\r","\r","function getQueryVariable(query, variable) {\r","\r"," var vars = query.split('&');\r"," \r"," for (var i = 0; i < vars.length; i++) {\r"," var pair = vars[i].split('=');\r"," if (decodeURIComponent(pair[0]) == variable) {\r"," return decodeURIComponent(pair[1]);\r"," }\r"," }\r"," \r","}"],"type":"text/javascript"}}],"id":"73505bd7-85ec-4a08-84fa-8d88ef8fb05b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Add/Update a secure customer vault record.\nValues: 'add_customer' or 'update_customer'
\n","key":"type","type":"text","value":"sale"},{"key":"username","type":"text","value":"{{basic-site_username}}"},{"key":"password","type":"text","value":"{{basic-site_password}}"},{"description":"Credit card number.
\n","key":"ccnumber","type":"text","value":"4111111111111111"},{"description":"Credit card expiration date.\nFormat: MMYY
\n","key":"ccexp","type":"text","value":"1228"},{"description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","key":"amount","type":"text","value":"19.95"},{"key":"stored_credential_indicator","value":"stored","description":"The indicator of the stored credential.\nValues: 'stored' or 'used'\nUse 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system.\nUse 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
\n","type":"text"}]},"url":"{{url}}/api/transact.php","urlObject":{"path":["api","transact.php"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"73505bd7-85ec-4a08-84fa-8d88ef8fb05b"}],"id":"742e1e3f-4020-48cf-87f3-78571850c37c","_postman_id":"742e1e3f-4020-48cf-87f3-78571850c37c","description":""},{"name":"Subscriptions","item":[{"name":"ADD SUBSCRIPTION - Yearly","id":"193dceb9-dcec-4a48-a887-f6b21b649a93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"type","value":"sale","type":"text"},{"key":"recurring","value":"add_subscription","type":"text"},{"key":"billing_method","value":"recurring","type":"text"},{"key":"username","value":"{{basic-site_username}}","type":"text"},{"key":"password","value":"{{basic-site_password}}","type":"text"},{"key":"plan_payments","value":"0","type":"text"},{"key":"plan_amount","value":"225.94","type":"text"},{"key":"start_date","value":"20200417","type":"text"},{"key":"month_frequency","value":"12","type":"text"},{"key":"day_of_month","value":"17","type":"text"},{"key":"ccnumber","value":"4111111111111111","type":"text"},{"key":"cvv","value":"123","type":"text"},{"key":"ccexp","value":"0222","type":"text"},{"key":"payment","value":"creditcard","type":"text"},{"key":"ipaddress","value":"108.162.215.246","type":"text"},{"key":"currency","value":"USD","type":"text"},{"key":"orderid","value":"252-598","type":"text"},{"key":"firstname","value":"Yvonne","type":"text"},{"key":"lastname","value":"Weissnat","type":"text"},{"key":"zip","value":"K4P 0A1","type":"text"},{"key":"country","value":"CA","type":"text"},{"key":"email","value":"Vidal94@yahoo.com","type":"text"},{"key":"invoice","value":"inv-490-998","type":"text"},{"key":"amount","value":"225.94","type":"text"},{"key":"phone","value":"8885551111","type":"text"},{"key":"tax","value":"25.99","type":"text"},{"key":"item_description_1","value":"Subscription+Yearly","type":"text"},{"key":"item_quantity_1","value":"1","type":"text"},{"key":"item_unit_cost_1","value":"199.95","type":"text"}]},"url":"{{url}}/api/transact.php","urlObject":{"path":["api","transact.php"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"193dceb9-dcec-4a48-a887-f6b21b649a93"}],"id":"2dcf24e8-bbea-49cb-a81c-145841f31193","_postman_id":"2dcf24e8-bbea-49cb-a81c-145841f31193","description":""}],"id":"51ba8a50-7d58-413b-929b-b6a20b792278","description":"These tests are to test the basic Sale, Authorize, Capture, Refund, Void, Validate, Subscription and Tokization Processes. The connection is from a site to the NMI Sandbox.
\n","_postman_id":"51ba8a50-7d58-413b-929b-b6a20b792278"}]}