The value that appears on an internet-connected device when it is not yet registered or has been deregistered.
\n","type":"text"},{"key":"deviceNickname","value":"TestDevice1","description":"When sent will appear on the POI Device screen and in the UI License Manager, as well as in Estate Management queries.
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/v2/devices/register","description":"Customer-Present Cloud requires that a POI Device is registered to the Merchant Gateway account prior to its use with Customer-Present Cloud. This means that integrators will need to complete a registration request using one of the Device Management APIs (Registration API).
\n","urlObject":{"protocol":"https","path":["api","v2","devices","register"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"6c966f26-c2fc-4b9a-88b1-b4cdcb7c8265","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"registrationCode","value":"T00001","description":"The value that appears on an internet-connected device when it is not yet registered or has been deregistered.","type":"text"},{"key":"deviceNickname","value":"TestDevice1","description":"When sent will appear on the POI Device screen and in the UI License Manager, as well as in Estate Management queries.","type":"text"}]},"url":"https://secure.nmi.com/api/v2/devices/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Jun 2023 14:11:18 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit18006"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"poiDevice\": {\n \"poiDeviceId\": \"cac7a885-4cf3-4729-bc10-000000000000\",\n \"deviceNickname\": \"TestDevice1\",\n \"deviceLicense\": \"cac7a885-4cf3-4729-bc10-000000000000\",\n \"serialNumber\": \"518370PT683249\",\n \"registrationStatus\": \"registered\"\n }\n}"},{"id":"d2647dc8-c86e-406c-8e4a-968ccf2cbf8d","name":"Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"registrationCode","value":"T00002","description":"The value that appears on an internet-connected device when it is not yet registered or has been deregistered.","type":"text"},{"key":"deviceNickname","value":"TestDevice2","description":"When sent will appear on the POI Device screen and in the UI License Manager, as well as in Estate Management queries.","type":"text"}]},"url":"https://secure.nmi.com/api/v2/devices/register"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Jun 2023 14:13:35 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit18006"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"300\",\n \"refId\": 1388350319,\n \"message\": \"Invalid registration code. Please try again\"\n }\n ]\n}"}],"_postman_id":"80e46453-8c39-49cd-a89f-0735aa2bf818"},{"name":"Deregister a Cloud Device","id":"a6738708-e91e-4e35-a895-5ab2c0878b45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"poiDeviceId","value":"{{PoiDeviceId}}","description":"The device id returned back as poiDeviceId in the register response.
\n","type":"text"}]},"url":"https://secure.nmi.com/api/v2/devices/deregister","description":"Should a registered POI Device no longer be needed, merchants may deregister the device. This is completed by performing a deregistration request utilizing the Device Management API. This request will only require the POI Device Id be passed within the request. Upon a successful deregister request any specified POI Device will be removed on the Merchant account and allowed to be reregistered if needed.
\n","urlObject":{"protocol":"https","path":["api","v2","devices","deregister"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6738708-e91e-4e35-a895-5ab2c0878b45"},{"name":"Device Query","id":"a65ff87b-0a60-401f-bbe6-e91ec2004576","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"poiDeviceId","value":"{{PoiDeviceId}}","description":"The POI device ID value that was returned back in the original registration response.
\n","type":"text"},{"key":"currentStatus","value":"true","description":"Set to true to receive extra information about a device. For supported devices it will return information about the device's Wi-Fi connection or its battery charge status.\nWi-Fi information is only returned for Miura devices. Battery information is returned for Ingenico Link 2500 devices and Miura devices. Note: when connected to a power source, Miura devices will return one of three percentage values: 30%, 70% and 100%.
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/v2/devices/list","description":"Integrations may utilize the Device Estate Management API in order to query a Gateway Account for any currently or previously registered devices. Utilizing the Device Estate Management API integrators may pass a specific POI Device Id in order to query a specific device's status. The API will return device model information, registration date, last connection date and even current connection status.
\n","urlObject":{"protocol":"https","path":["api","v2","devices","list"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"9a6f1b5f-1068-42c7-a0f4-7e6cc0199379","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"poiDeviceId","value":"{{PoiDeviceId}}","description":"The POI device ID value that was returned back in the original registration response.","type":"text"},{"key":"currentStatus","value":"true","description":"Set to true to receive extra information about a device. For supported devices it will return information about the device's Wi-Fi connection or its battery charge status.\nWi-Fi information is only returned for Miura devices. Battery information is returned for Ingenico Link 2500 devices and Miura devices. Note: when connected to a power source, Miura devices will return one of three percentage values: 30%, 70% and 100%.","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/v2/devices/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Jun 2023 14:15:11 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit14009"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"poiDevices\": [\n {\n \"deviceId\": \"5a2e38c6-5b5a-44ad-be1e-000000000000\",\n \"make\": \"ingenico\",\n \"model\": \"IPP320\",\n \"lastTransactionDate\": null,\n \"dateRegistered\": \"2023-06-13 14:14:50\",\n \"dateDeregistered\": null,\n \"serialNumber\": \"756888PT999969\",\n \"connectionStatus\": \"unknown\",\n \"lastConnectedDate\": null,\n \"lastDisconnectedDate\": null,\n \"deviceNickname\": \"Registered Device\",\n \"registrationStatus\": \"registered\"\n }\n ]\n}"}],"_postman_id":"a65ff87b-0a60-401f-bbe6-e91ec2004576"}],"id":"5b54179b-da2b-4729-96c4-394141ebd8ad","description":"Customer-Present Cloud integrations will need to utilize different API Endpoints in order to complete required actions to set up a POI Device prior to completing transactions. Within the Device Management API integrators may register/deregister any supported devices. Additionally, with the Device Estate Management API integrators may query device information on any current or previously registered devices within their Gateway account.
\n","_postman_id":"5b54179b-da2b-4729-96c4-394141ebd8ad"},{"name":"Transaction Processing","item":[{"name":"POI Device Prompts","id":"45615e84-8793-4411-a768-2c011aa86091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate'
\n","type":"text"},{"key":"poi_device_id","value":"{{PoiDeviceId}}","description":"The registered terminal ID. Provide on transaction types of sale, auth, credit and validate.
\n","type":"text"},{"key":"response_method","value":"asynchronous","description":"The type of response you wish to see returned. Set to 'synchronous' to wait for a final transaction ID. Set to 'asynchronous' to receive an async_status_guid value to poll against.\nDefault: 'synchronous'\nValues: 'synchronous' or 'asynchronous'
\n","type":"text"},{"key":"amount","value":"1.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","type":"text"},{"key":"first_name","value":"","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.
\n","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state.\nFormat: CC
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing zip code.
\n","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country. Country codes are as shown in ISO 3166. \nFormat: CC
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.
\n","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order Description.
\n","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order Id.
\n","type":"text","disabled":true},{"key":"tip","value":"1.00","description":"The final tip amount, included in the transaction amount, associated with the purchase.\nFormat: x.xx
\n","type":"text","disabled":true},{"key":"poi_prompt_tip","value":"true","description":"When set to 'true', will allow the cardholder to type in a tip amount via the POI Device. When sent in with the 'tip' value, this will show a confirmation of the tip value.\nFormat: boolean (true/false)\nDefault: false
\n","type":"text","disabled":true},{"key":"poi_prompt_quicktip_amounts","value":"1.00,2.00,3.00,4.00","description":"Show an on-screen list of quick tip amount options when tipping via the POI Device.\nFormat: X.XX, comma delimited up to 4 options.\nExample: 1.50,3.00,4.50
\n","type":"text","disabled":true},{"key":"poi_prompt_quicktip_percentages","value":"10.00,20.00,30.00,40.00","description":"Show an on-screen list of quick tip percentage options when tipping via the POI Device.\nFormat: XX.XX, comma delimited up to 4 options.\nExample: 10.00,15.50,20.34
\n","type":"text","disabled":true},{"key":"poi_enable_keyed","value":"true","description":"When set to 'true', provides the option to key-in the card details via the POI Device. This POI Device Prompt is not supported with Miura devices.\nFormat: boolean (true/false)\nDefault: false
\n","type":"text","disabled":true},{"key":"poi_required_keyed","value":"","description":"When set to 'true', forces the cardholder to key-in the card details via the POI Device. This prompt does not allow any other entry method when set.\nNote: Cannot be set to 'true' when poi_enable_keyed is also set to 'true'.\nFormat: boolean (true/false)\nDefault: false
\n","type":"text","disabled":true},{"key":"poi_prompt_cvv","value":"","description":"When set to 'false', the CVV code will not be requested from the customer via the POI Device on a keyed transaction. Invalid when sent with poi_enable_keyed set to 'false' or when poi_enable_keyed is not sent. This POI Device Prompt is not supported with Miura devices.\nFormat: boolean (true/false)\nDefault: true
\n","type":"text","disabled":true},{"key":"poi_prompt_zip","value":"","description":"When set to 'true', will enforce zip code/postal entry via the POI Device. Note: Entry on the device will override a zip code sent via API in the initial request.\nFormat: boolean (true/false)\nDefault: false
\n","type":"text","disabled":true},{"key":"poi_prompt_amount_confirmation","value":"","description":"When set to 'true', will force the user to confirm the amount being charged via the POI Device.\nFormat: boolean (true/false)\nDefault: false
\n","type":"text","disabled":true},{"key":"poi_prompt_signature","value":"","description":"When set to 'true', will force the user to sign via the POI Device where supported. When set to 'false', will skip the signature capture step for magstripe transactions. Will be overridden via Chip Card/POI Device interaction when applicable.\nFormat: boolean (true/false)\nDefault: true
\n","type":"text","disabled":true},{"key":"poi_request","value":"cancellation","description":"If you wish to reset the POI Device before a transaction has been processed, but after the transaction has been requested, you may request a cancellation. If the authorization has already begun, you will need to void the transaction after it has completed.\nValue: 'cancellation'
\n","type":"text","disabled":true},{"key":"poi_automatic_fall_forward","value":"","description":"When set to 'true', will enable Fall Forward (EMV Contactless upgrade to EMV Contact) in-line via the POI Device where supported. When set to 'false', transactions will need to be restarted when tapped cards that are rejected by the Issuer require a contact/EMV insert to occur.\nFormat: boolean (true/false)\nDefault: true
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"With the POI Device Prompts Customer-Present Cloud integrations have more control over what a POI Device will request during a transaction. These prompts allow integrators to request customers to input tip amounts, confirm final amounts, request zip codes or even cancel in process transactions.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"45615e84-8793-4411-a768-2c011aa86091"},{"name":"AsyncStatus API","id":"6e4d113a-e972-46a2-86c5-caf05aaacca9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://secure.nmi.com/api/asyncstatus/:asyncStatusGuid","description":"When utilizing Customer-Present Cloud it is recommended that any transaction request performed, is done asynchronously. An asynchronous transaction allows integrations to issue a request and immediately get a GUID in return. The GUID is then used to poll the transaction using the AsyncStatus API, which will return the current state of the transaction.
\n","urlObject":{"protocol":"https","path":["api","asyncstatus",":asyncStatusGuid"],"host":["secure","nmi","com"],"query":[{"disabled":true,"description":{"content":"The type of response you wish to see returned. Set to\n'synchronous' to wait for a final transaction ID. Set to\n'asynchronous' to receive inFlight async status responses.\nDefault: 'asynchronous'\nValues: 'synchronous' or 'asynchronous'
\n","type":"text/plain"},"key":"responseMethod","value":"asynchronous"}],"variable":[{"id":"c74bf17b-413d-47f9-b2d6-78abf1c0f187","description":{"content":"The async_status_guid returned from the transaction response.\nExample: 04249b3a-02f9-4838-b7b5-2bef4d4e7f7d
\n","type":"text/plain"},"type":"any","value":"{{AsyncStatusGuid}}","key":"asyncStatusGuid"}]}},"response":[{"id":"bf66445a-a652-42b1-b53d-177a99783b6d","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://secure.nmi.com/api/asyncstatus/:asyncStatusGuid","protocol":"https","host":["secure","nmi","com"],"path":["api","asyncstatus",":asyncStatusGuid"],"query":[{"key":"responseMethod","value":"asynchronous","description":"The type of response you wish to see returned. Set to\n'synchronous' to wait for a final transaction ID. Set to\n'asynchronous' to receive inFlight async status responses.\nDefault: 'asynchronous'\nValues: 'synchronous' or 'asynchronous'","disabled":true}],"variable":[{"key":"asyncStatusGuid","value":"{{AsyncStatusGuid}}","description":"The async_status_guid returned from the transaction response.\nExample: 04249b3a-02f9-4838-b7b5-2bef4d4e7f7d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\r\n \"transaction\": {\r\n \"id\": 8440939560,\r\n \"type\": \"sale\",\r\n \"success\": true,\r\n \"condition\": \"pendingsettlement\",\r\n \"approval\": null,\r\n \"authorizedAmount\": \"0.00\",\r\n \"authCode\": \"123456\",\r\n \"emvMetaData\": {\r\n \"customerVerificationMethod\": \"onlinePin\",\r\n \"applicationId\": \"A0000000031010\",\r\n \"applicationLabel\": \"VISA CREDIT\",\r\n \"applicationPreferredName\": \"CREDITO DE VISA\",\r\n \"applicationPanSequenceNumber\": \"01\",\r\n \"transactionStatusInformation\": \"E800\",\r\n \"maskedMerchantNumber\": \"xxxxxxxx9911\"\r\n }\r\n },\r\n \"platformId\": \"1daf30a4-171e-4f84-aedb-000000000000\",\r\n \"asyncStatusGuid\": \"1daf30a4-171e-4f84-aedb-000000000000\",\r\n \"asyncStatus\": \"interactionComplete\"\r\n}"}],"_postman_id":"6e4d113a-e972-46a2-86c5-caf05aaacca9"}],"id":"5a381961-4164-4ee1-b150-a14d057ae60c","description":"Customer-Present Cloud allows integrators to provide additional functions to their integrations during the transaction process. Utilizing Cloud integrators may request certain supported POI Devices to provide additional prompts during transactions, such as a request for customers to input a custom tip amount. Additionally, Customer-Present Cloud allows for the use of asynchronous requests to better improve transaction handling during the transaction process.
\n","_postman_id":"5a381961-4164-4ee1-b150-a14d057ae60c"},{"name":"Standalone Device Inputs","item":[{"name":"Query a Standalone Device Input","id":"0285a137-74d8-41c9-b569-bb5505f3d261","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://secure.nmi.com/api/asyncdevicestatus/:asyncStatusGuid","description":"When utilizing one of the Standalone Device Inputs integrations will receive an Async Status Guid within the request response. This may be used in order to query the result of a standalone device input, this will need to be used to determine whether a customer’s interaction with the POI device has been completed or not and to confirm if the request was successful.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"18adb5e4-5b61-4b04-8061-72f7db778b64","id":"18adb5e4-5b61-4b04-8061-72f7db778b64","name":"Standalone Device Inputs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","asyncdevicestatus",":asyncStatusGuid"],"host":["secure","nmi","com"],"query":[{"disabled":true,"description":{"content":"The type of response you wish to see returned. Set to\n'synchronous' to wait for a final status of the request.\nDefault: 'asynchronous'\nValues: 'synchronous' or 'asynchronous'
\n","type":"text/plain"},"key":"responseMethod","value":"asynchronous"}],"variable":[{"id":"d8410ea8-11f9-4231-98b4-c20240c5a103","type":"any","value":null,"key":"asyncStatusGuid"}]}},"response":[{"id":"a21e86ee-ac1e-4a64-998d-1526bc12fef2","name":"Query a Standalone Device Input","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":{"raw":"https://secure.nmi.com/api/asyncdevicestatus/:asyncStatusGuid","protocol":"https","host":["secure","nmi","com"],"path":["api","asyncdevicestatus",":asyncStatusGuid"],"variable":[{"key":"asyncStatusGuid","value":"{{AsyncStatusGuid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"reference\": \"df5ea4b0-05d9-4ddd-ad7b-c1c63857fffd\",\n \"status\": \"complete\",\n \"result\": 2\n}"}],"_postman_id":"0285a137-74d8-41c9-b569-bb5505f3d261"},{"name":"Standalone Signature Capture","id":"5da6fc31-ab71-4d71-a0f2-fcae893f4f6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://secure.nmi.com/api/v2/devices/sign/:poiDeviceId","description":"Customer-Present Cloud allows integrations to perform standalone signature captures on POI Devices. This means that this signature Capture prompt may be completed outside of the normal transaction flow. This action is supported by the Ingenico Lane 5000/7000 and the Miura M021.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"18adb5e4-5b61-4b04-8061-72f7db778b64","id":"18adb5e4-5b61-4b04-8061-72f7db778b64","name":"Standalone Device Inputs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v2","devices","sign",":poiDeviceId"],"host":["secure","nmi","com"],"query":[],"variable":[{"id":"8ce133ae-a833-491e-9890-d929aff824f5","description":{"content":"The POI device ID you want to interact with.
\n","type":"text/plain"},"type":"any","value":"{{PoiDeviceId}}","key":"poiDeviceId"}]}},"response":[],"_postman_id":"5da6fc31-ab71-4d71-a0f2-fcae893f4f6e"},{"name":"Yes/No Prompts","id":"0e8bb7d8-14f2-42c7-8675-554138c071dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"header","value":"","description":"Header text you want to display on device.\nValue must match expression: ^[a-zA-Z0-9.,?!&/#'-= ]{0,100}$
\n","type":"text","disabled":true},{"key":"message","value":"","description":"Message text you want to display on device\nValue must match expression: ^[a-zA-Z0-9.,?!&/#'-= ]{0,100}$
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/v2/devices/yesno/:poiDeviceId","description":"Customer-Present Cloud allows integrations to capture a customer’s answer to a yes/no question with an on-screen header and optional message. This action is supported by the Ingenico Lane 3000/5000/7000, the Link 2500 and the Miura M020/M021.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"18adb5e4-5b61-4b04-8061-72f7db778b64","id":"18adb5e4-5b61-4b04-8061-72f7db778b64","name":"Standalone Device Inputs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v2","devices","yesno",":poiDeviceId"],"host":["secure","nmi","com"],"query":[],"variable":[{"id":"d3809f0f-2c20-4025-b2e6-855f9c03ba07","description":{"content":"The POI device ID you want to interact with.
\n","type":"text/plain"},"type":"any","value":"{{PoiDeviceId}}","key":"poiDeviceId"}]}},"response":[{"id":"02e86a3d-dda2-4081-93c9-81210bef8774","name":"Yes/No Prompts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://secure.nmi.com/api/v2/devices/yesno/:poiDeviceId","protocol":"https","host":["secure","nmi","com"],"path":["api","v2","devices","yesno",":poiDeviceId"],"variable":[{"key":"poiDeviceId","value":"{{PoiDeviceId}}","description":"The POI device ID you want to interact with."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"async_status_guid\": \"ae168319-9b4e-4ba8-b501-188027b23849\",\n \"status\": \"in_progress\"\n}"}],"_postman_id":"0e8bb7d8-14f2-42c7-8675-554138c071dd"},{"name":"Multiple Choice Prompts","id":"60ad4f6d-b54a-4e10-a905-abc8f6e4c176","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"header","value":"","description":"Header text you want to display on device.\nValue must match expression: ^[a-zA-Z0-9.,?!/#&'-= ]{0,24}$
\n","type":"text","disabled":true},{"key":"options","value":"","description":"List of options you want to display on device. A minimum of 2 options are required and there can be a maximum of 20 options.\nEach option must match expression: ^[a-zA-Z0-9.,?!/#&'-= ]{0,24}$
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/v2/devices/menuselection/:poiDeviceId","description":"Customer-Present Cloud allows integrations to capture a customer’s answer to a multiple choice question with an on-screen header and options. This action is supported by the Ingenico Lane 3000/5000/7000, the Link 2500 and the Miura M020/M021.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"18adb5e4-5b61-4b04-8061-72f7db778b64","id":"18adb5e4-5b61-4b04-8061-72f7db778b64","name":"Standalone Device Inputs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v2","devices","menuselection",":poiDeviceId"],"host":["secure","nmi","com"],"query":[],"variable":[{"id":"bac5313b-faf9-4eba-8ed8-23b6efc2ab7e","description":{"content":"The POI device ID you want to interact with.
\n","type":"text/plain"},"type":"any","value":"{{PoiDeviceId}}","key":"poiDeviceId"}]}},"response":[],"_postman_id":"60ad4f6d-b54a-4e10-a905-abc8f6e4c176"}],"id":"18adb5e4-5b61-4b04-8061-72f7db778b64","description":"Standalone Device Inputs are used for completing smaller operational tasks which do not require a transaction to be processed. With Standalone Device Inputs integrations may create requests for customers to input various different prompts, such as a \"Yes/No\" prompt.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{ApiKey}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d3637448-f1f6-400f-8007-c08ffa614825"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"39a5b7fb-a148-43d4-a1a5-0fd186d5ee81"}}],"_postman_id":"18adb5e4-5b61-4b04-8061-72f7db778b64"}],"id":"afb6c1f3-5ea0-4026-86bf-00a2cad42e82","_postman_id":"afb6c1f3-5ea0-4026-86bf-00a2cad42e82","description":""},{"name":"Payment API","item":[{"name":"Payment Types","item":[{"name":"Sale","id":"b67b6386-7a09-4977-ae07-c3293a6ee142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","type":"text"},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","type":"text"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address
\n","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card billing city
\n","type":"text","disabled":true},{"key":"state","value":"NY","description":"Card billing state.\nFormat: CC
\n","type":"text","disabled":true},{"key":"zip","value":"00000","description":"Card billing zip code
\n","type":"text","disabled":true},{"key":"country","value":"United States","description":"Card billing country.\nCountry codes are as shown in ISO 3166. Format: CC
\n","type":"text","disabled":true},{"key":"phone","value":"1111111111","description":"Billing phone number
\n","type":"text","disabled":true},{"key":"email","value":"test@example.com","description":"Billing email address
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"The transaction type Sale performs both an authorization and a capture of an authorized amount for a transaction. This transaction type will perform a full start to end transaction within a single request, unlike utilizing an Auth and Capture method for transactions.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"20232dc1-b350-4e56-8e8d-ba6fe045f8ec","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'","type":"text"},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx","type":"text"},{"key":"first_name","value":"John","description":"Cardholder's first name.","type":"text","disabled":true},{"key":"last_name","value":"Smith","description":"Cardholder's last name.","type":"text","disabled":true},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card billing city","type":"text","disabled":true},{"key":"state","value":"NY","description":"Card billing state.\nFormat: CC","type":"text","disabled":true},{"key":"zip","value":"00000","description":"Card billing zip code","type":"text","disabled":true},{"key":"country","value":"United States","description":"Card billing country.\nCountry codes are as shown in ISO 3166. Format: CC","type":"text","disabled":true},{"key":"phone","value":"1111111111","description":"Billing phone number","type":"text","disabled":true},{"key":"email","value":"test@example.com","description":"Billing email address","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"response=1&responsetext=SUCCESS&authcode=123456&transactionid=8426615217&avsresponse=&cvvresponse=M&orderid=&type=sale&response_code=100"},{"id":"34ebce12-e5ac-4e61-b9a2-a68c385d2165","name":"Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'","type":"text"},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx","type":"text"},{"key":"first_name","value":"John","description":"Cardholder's first name.","type":"text","disabled":true},{"key":"last_name","value":"Smith","description":"Cardholder's last name.","type":"text","disabled":true},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card billing city","type":"text","disabled":true},{"key":"state","value":"NY","description":"Card billing state.\nFormat: CC","type":"text","disabled":true},{"key":"zip","value":"00000","description":"Card billing zip code","type":"text","disabled":true},{"key":"country","value":"United States","description":"Card billing country.\nCountry codes are as shown in ISO 3166. Format: CC","type":"text","disabled":true},{"key":"phone","value":"1111111111","description":"Billing phone number","type":"text","disabled":true},{"key":"email","value":"test@example.com","description":"Billing email address","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"response=3&responsetext=Authentication Failed&authcode=&transactionid=0&avsresponse=&cvvresponse=&orderid=&type=&response_code=300"}],"_postman_id":"b67b6386-7a09-4977-ae07-c3293a6ee142"},{"name":"Auth","event":[{"listen":"test","script":{"exec":["var match = responseBody.match(/transactionid=(\\d+)/);\r","if (match != null) {\r"," pm.environment.set(\"TransactionId\", match[1])\r","}"],"type":"text/javascript","id":"ce8af655-12df-40ec-8c06-f9038fcc0a94"}}],"id":"df6b07ee-c93c-43be-ba99-9a7d3413fd84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"auth","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","type":"text"},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","type":"text"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address
\n","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card billing city
\n","type":"text","disabled":true},{"key":"state","value":"NY","description":"Card billing state.\nFormat: CC
\n","type":"text","disabled":true},{"key":"zip","value":"00000","description":"Card billing zip code
\n","type":"text","disabled":true},{"key":"country","value":"United States","description":"Card billing country.\nCountry codes are as shown in ISO 3166. Format: CC
\n","type":"text","disabled":true},{"key":"phone","value":"1111111111","description":"Billing phone number
\n","type":"text","disabled":true},{"key":"email","value":"test@example.com","description":"Billing email address
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"The transaction type Auth or Authorization provides an approval from a credit card issuer that states the cardholder has sufficient funds available to cover the cost of the transaction being performed. This transaction type requires an additional capture transaction upon successful completion of the Auth transaction.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"df6b07ee-c93c-43be-ba99-9a7d3413fd84"},{"name":"Capture","id":"398eccd9-e839-47d0-ba04-8c43275c5940","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"capture","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","type":"text"},{"key":"transactionid","value":"{{TransactionId}}","description":"Original payment gateway transaction id
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be settled. This amount must be equal to or less than the original authorized amount.\nFormat: x.xx
\n","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php","description":"The transaction type Capture is used upon a successful completion of an Auth transaction. The Capture transaction is used to specify to request that the authorized funds be sent over from the cardholder's issuing bank.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"9d2a3e75-8244-4f80-b07f-3fc372e41b3f","name":"Transaction Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"capture","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'","type":"text"},{"key":"transactionid","value":"{{TransactionId}}","description":"Original payment gateway transaction id","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be settled. This amount must be equal to or less than the original authorized amount.\nFormat: x.xx","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 12 Jun 2023 13:39:04 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit12036"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"response=3&responsetext=Transaction not found REFID:1095356365&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=capture&response_code=300"}],"_postman_id":"398eccd9-e839-47d0-ba04-8c43275c5940"},{"name":"Credit","id":"97462e76-ee95-41fd-aaf3-dbf4034bb555","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"credit","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","type":"text"},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be credited.\nFormat: x.xx
\n","type":"text"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address
\n","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card billing city
\n","type":"text","disabled":true},{"key":"state","value":"NY","description":"Card billing state.\nFormat: CC
\n","type":"text","disabled":true},{"key":"zip","value":"00000","description":"Card billing zip code
\n","type":"text","disabled":true},{"key":"country","value":"United States","description":"Card billing country.\nCountry codes are as shown in ISO 3166. Format: CC
\n","type":"text","disabled":true},{"key":"phone","value":"1111111111","description":"Billing phone number
\n","type":"text","disabled":true},{"key":"email","value":"test@example.com","description":"Billing email address
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"The Credit transaction type is used for sending funds to a specified cardholder. A Credit transaction will send funds from the Merchants issuing bank. Credits use cases vary, but are commonly used as a method of funding/ refunding when there is no previous transaction committed or Merchants are unable to locate a previous transaction id.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"97462e76-ee95-41fd-aaf3-dbf4034bb555"}],"id":"975ef8a0-96dd-4662-8ce8-6c799d1393f0","description":"The Payment API allows integrators to utilize various different Payment Types in order to perform different transaction processes. These processes differ and are utilized for different scenarios and purposes. The following section will share further examples of how to utilize the sale, auth, capture, refund and credit payment types within the Payment API.
\n","_postman_id":"975ef8a0-96dd-4662-8ce8-6c799d1393f0"},{"name":"Payment Source Examples","item":[{"name":"Raw Card Data","id":"0248a22f-f976-41e5-ace3-6986f4e0d345","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', or 'validate'
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","type":"text"},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number.
\n","type":"text"},{"key":"cvv","value":"1025","description":"The card security code. While this is not required, it is strongly recommended.
\n","type":"text"},{"key":"ccexp","value":"999","description":"Credit card expiration date.\nFormat: MMYY
\n","type":"text"},{"key":"checkname","value":"","description":"The name on the customer's ACH account.
\n","type":"text","disabled":true},{"key":"checkaba","value":"","description":"The customer's bank routing number.
\n","type":"text","disabled":true},{"key":"checkaccount","value":"","description":"The customer's bank account number.
\n","type":"text","disabled":true},{"key":"account_holder_type","value":"","description":"The type of ACH account the customer has.\nValues: 'business' or 'personal'
\n","type":"text","disabled":true},{"key":"account_type","value":"","description":"The ACH account entity of the customer.\nValues: 'checking' or 'savings'
\n","type":"text","disabled":true},{"key":"first_name","value":"","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.
\n","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state.
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing zip code.
\n","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country. Country codes are as shown in ISO 3166. Format: CC
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.
\n","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order description.
\n","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order Id.
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"You can pass custom information in up to 20 fields. Format: merchant_defined_field_1=Value
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"The Payment API allows integrators to utilize various different payment parameters in order to perform different transaction processes. The below request utilizes the most simplistic use of the Payment API in order to complete a sales transaction with the use of raw payment data rather than the use of a tokenized method.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0248a22f-f976-41e5-ace3-6986f4e0d345"},{"name":"Customer Vault","id":"6086f06d-d667-429b-8bf0-5c56eaf6b422","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","type":"text"},{"key":"customer_vault_id","value":"Customer12345","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.
\n","type":"text"},{"key":"billing_id","value":"","description":"Billing id assigned to specific billing record. Billing id should be used when calling a Vault record with multiple billings added.
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"The Gateway's Customer Vault allows merchants to call onto stored customer records to perform additional transactions. The section below will provide additional details on how integrations may use certain parameters to perform Customer Vault initiated transactions.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6086f06d-d667-429b-8bf0-5c56eaf6b422"},{"name":"Collect.js","id":"dd0455e8-8b99-4c1e-afd5-c4e3b5d0fc49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', or 'validate'
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","type":"text"},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.
\n","type":"text"},{"key":"first_name","value":"","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.
\n","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state.
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing zip code.
\n","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country. Country codes are as shown in ISO 3166. Format: CC
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.
\n","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order description.
\n","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order Id.
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"You can pass custom information in up to 20 fields. Format: merchant_defined_field_1=Value
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Collect.js is a JavaScript framework that allows merchants to collect sensitive payment information from their customers without exposing their website to the sensitive information. The example below will demonstrate how to pass the Payment Token returned via Collect.js into a Payment API request.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd0455e8-8b99-4c1e-afd5-c4e3b5d0fc49"},{"name":"Customer-Present Cloud","event":[{"listen":"test","script":{"exec":["const regExp = new RegExp('async_status_guid=(.*?)&');\r","var match = responseBody.match(regExp);\r","if (match != null) {\r"," pm.environment.set(\"AsyncStatusGuid\", match[1])\r","}"],"type":"text/javascript","id":"604615ee-0d0e-405c-afb5-2b04024325a7"}}],"id":"94a1ad99-37d6-445d-866b-147c2fed8ff4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"poi_device_id","value":"{{PoiDeviceId}}","description":"The registered terminal ID. Provide on transaction types of sale, auth, credit and validate.
\n","type":"text"},{"key":"response_method","value":"","description":"The type of response you wish to see returned. Set to 'synchronous' to wait for a final transaction ID. Set to 'asynchronous' to receive an async_status_guid value to poll against.\nDefault: 'synchronous'\nValues: 'synchronous' or 'asynchronous'\nNote: You must use the AsyncStatus API if you use 'asynchronous' processing. Please see 'Response Style Selection' above for more information. You can see an example of the response you'll get in the examples below.
\n","type":"text"},{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', or 'validate'
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","type":"text"},{"key":"first_name","value":"","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.
\n","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state.
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing zip code.
\n","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country. Country codes are as shown in ISO 3166. Format: CC
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.
\n","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order description.
\n","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order Id.
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"You can pass custom information in up to 20 fields. Format: merchant_defined_field_1=Value
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Customer-Present Cloud is a method of processing retail payments using an internet connected terminal without the use of an installed SDK. Integrators will utilize Customer-Present Cloud in conjunction with the Payment API in order to perform transactional operations.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"94a1ad99-37d6-445d-866b-147c2fed8ff4"}],"id":"2176b5ed-47a7-4798-a512-beaad1bd6f73","description":"This section will provide information on performing real use examples of specified transactional operations.
\n","_postman_id":"2176b5ed-47a7-4798-a512-beaad1bd6f73"},{"name":"Gateway.js Examples","item":[{"name":"Gateway.js 3DS Example","id":"ffcf1221-ea20-4a68-9bfb-ca0535cf5db1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","type":"text"},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","type":"text"},{"key":"cavv","value":"Y2FyZGopYWjtg21tZXJjZfF1dJg=","description":"Cardholder authentication verification value.\nFormat: base64 encoded
\n","type":"text"},{"key":"xid","value":"","description":"Cardholder authentication transaction id.
\n","type":"text"},{"key":"directory_server_id","value":"00000000-0000-0000-0000-000000000000","description":"Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication.\nFormat: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
\n","type":"text"},{"key":"eci","value":"02","description":"A number that indicates the result of the attempt to authenticate the cardholder. Values are dependent on the card brand.
\n","type":"text"},{"key":"cardholder_auth","value":"verified","description":"Set 3D Secure condition. Value used to determine E-commerce indicator (ECI).\nValues: 'verified' or 'attempted'
\n","type":"text"},{"key":"three_ds_version","value":"2.1.0","description":"3DSecure version.\nExamples: \"2.0.0\" or \"2.2.0\"
\n","type":"text"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address
\n","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card billing city
\n","type":"text","disabled":true},{"key":"state","value":"NY","description":"Card billing state.\nFormat: CC
\n","type":"text","disabled":true},{"key":"zip","value":"00000","description":"Card billing zip code
\n","type":"text","disabled":true},{"key":"country","value":"United States","description":"Card billing country.\nCountry codes are as shown in ISO 3166. Format: CC
\n","type":"text","disabled":true},{"key":"phone","value":"1111111111","description":"Billing phone number
\n","type":"text","disabled":true},{"key":"email","value":"test@example.com","description":"Billing email address
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Gateway.js is a JavaScript library that allows merchants to customize their integration and add additional gateway services such as 3D Secure. This example below will demonstrate how to pass all the 3DS parameters returned via Gateway.js into a Payment API request.
\nFor a full payment stack, integrators will first need to integrate Gateway.js in order to obtain and retrieve the 3DS data, which would be passed within the Payment API request.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ffcf1221-ea20-4a68-9bfb-ca0535cf5db1"},{"name":"Gateway.js Kount Example","id":"168cc95e-713b-43de-9d24-0a213559f732","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"sale","description":"The type of transaction to be processed.\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n","type":"text"},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.
\n","type":"text"},{"key":"amount","value":"10.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.\nFormat: x.xx
\n","type":"text"},{"key":"transaction_session_id","value":"00000000000000000000000000000000","description":"A single use session ID used by Kount to link the transaction and Data Collector information together. This ID should be generated every time a payment form is loaded by the cardholder, and be random/unpredictable (do not use sequential IDs). This ID should not be reused within a 30 day period. This can be used with Collect.js or the Payment API when using the Kount DDC with Gateway.js.\nFormat: alphanumeric, 32 characters required
\n","type":"text"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address
\n","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card billing city
\n","type":"text","disabled":true},{"key":"state","value":"NY","description":"Card billing state.\nFormat: CC
\n","type":"text","disabled":true},{"key":"zip","value":"00000","description":"Card billing zip code
\n","type":"text","disabled":true},{"key":"country","value":"United States","description":"Card billing country.\nCountry codes are as shown in ISO 3166. Format: CC
\n","type":"text","disabled":true},{"key":"phone","value":"1111111111","description":"Billing phone number
\n","type":"text","disabled":true},{"key":"email","value":"test@example.com","description":"Billing email address
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Gateway.js is a JavaScript library that allows merchants to customize their integration and add additional gateway services such as Kount. This example below will demonstrate how to pass the Kount session id parameter returned via Gateway.js into a Payment API request.
\nWithin a real world use case integrators will first need to integrate Gateway.js in order to retrieve the Kount session id in order to be passed within the Payment API request.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"168cc95e-713b-43de-9d24-0a213559f732"}],"id":"0c5f0909-079c-4dc6-b83b-f497e32572b7","description":"Gateway.js is a JavaScript library that allows merchants to customize their integration and add additional gateway services such as 3D Secure and Kount. Gateway.js works in conjunction with the Payment API in order to process transactions. With the use of Gateway.js, integrators may further secure their transactions by providing additional data from 3DS or the Kount Fraud Protector.
\n","_postman_id":"0c5f0909-079c-4dc6-b83b-f497e32572b7"},{"name":"Customer Vault","item":[{"name":"Credential on File","item":[{"name":"Credential on File - CIT","event":[{"listen":"test","script":{"exec":["var match = responseBody.match(/transactionid=(\\d+)/);\r","if (match != null) {\r"," pm.environment.set(\"firstStoreTransactionId\", match[1])\r","}"],"type":"text/javascript","id":"aeee19de-cf85-4370-acf9-d53ea7ff032e"}}],"id":"2484c030-1d2f-4145-9aee-1af5ee0e79bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"add_customer","description":"Add/Update a secure Customer Vault record.
\nValues: 'add_customer' or 'update_customer'
\n"},{"key":"customer_vault_id","value":"","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.
\n","disabled":true},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.
\n","type":"text"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n"},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n"},{"key":"company","value":"Company Inc.","description":"Cardholder's company.
\n"},{"key":"address1","value":"Apartment 2","description":"Card billing address.
\n"},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2.
\n"},{"key":"city","value":"Chicago","description":"Card billing city.
\n"},{"key":"state","value":"IL","description":"Card billing state.
\n"},{"key":"zip","value":"60193","description":"Card billing postal code.
\n"},{"key":"country","value":"US","description":"Card billing country code.
\n"},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number.
\n"},{"key":"email","value":"test@example.com","description":"Billing email address.
\n"},{"key":"type","value":"validate","description":"The type of transaction to be processed.
\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n"},{"key":"amount","value":"1.00","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.
\nFormat: x.xx
\n","type":"text","disabled":true},{"key":"initiated_by","value":"customer","description":"Who initiated the transaction.
\nValues: 'customer' or 'merchant'
\n"},{"key":"billing_method","value":"recurring","description":"Should be set to 'recurring' to mark payment as a recurring transaction or 'installment' to mark payment as an installment transaction.\nValues: 'recurring', 'installment'
\n","type":"text"},{"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"},{"key":"cavv","value":"Y2FyZGopYWjtg21tZXJjZfF1dJg=","description":"Cardholder authentication verification value.\nFormat: base64 encoded
\n","type":"text"},{"key":"xid","value":"","description":"Cardholder authentication transaction id.\nFormat: base64 encoded
\n","type":"text"},{"key":"eci","value":"05","description":"A number that indicates the result of the attempt to authenticate the cardholder. Values are dependent on the card brand.
\n","type":"text"},{"key":"cardholder_auth","value":"verified","description":"Set 3D Secure condition. Value used to determine E-commerce indicator (ECI).\nValues: 'verified' or 'attempted'
\n","type":"text"},{"key":"three_ds_version","value":"2.1.0","description":"3DSecure version.\nExamples: \"2.0.0\" or \"2.2.0\"
\n","type":"text"},{"key":"directory_server_id","value":"00000000-0000-0000-0000-000000000000","description":"Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication.\nFormat: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
\n","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php","description":"Customer initiated transactions, also known as CIT, are Credential on File transactions in which customers are actively engaged in the checkout process. Typically this means customers will be physically present in a store, or checking out online in their browser.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"60d5c0b1-9a6e-4683-8e88-1e8d54e00356","name":"First Store","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"add_customer","description":"Add/Update a secure Customer Vault record.\n\nValues: 'add_customer' or 'update_customer'"},{"key":"customer_vault_id","value":"","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.","disabled":true},{"key":"payment_token","value":"00000000-000000-000000-000000000000","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.","type":"text"},{"key":"first_name","value":"John","description":"Cardholder's first name."},{"key":"last_name","value":"Smith","description":"Cardholder's last name."},{"key":"company","value":"Company Inc.","description":"Cardholder's company."},{"key":"address1","value":"Apartment 2","description":"Card billing address."},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2."},{"key":"city","value":"Chicago","description":"Card billing city."},{"key":"state","value":"IL","description":"Card billing state."},{"key":"zip","value":"60193","description":"Card billing postal code."},{"key":"country","value":"US","description":"Card billing country code."},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number."},{"key":"email","value":"test@example.com","description":"Billing email address."},{"key":"cavv","value":"Y2FyZGopYWjtg21tZXJjZfF1dJg=","description":"Cardholder authentication verification value.\nFormat: base64 encoded","type":"text"},{"key":"xid","value":"","description":"Cardholder authentication transaction id.\nFormat: base64 encoded","type":"text"},{"key":"cardHolderAuth","value":"verified","description":"Set 3D Secure condition. Value used to determine E-commerce indicator (ECI).\nValues: 'verified' or 'attempted'","type":"text"},{"key":"eci","value":"01","description":"A number that indicates the result of the attempt to authenticate the cardholder. Values are dependent on the card brand.","type":"text"},{"key":"threeDsVersion","value":"2.1.0","description":"3DSecure version.\nExamples: \"2.0.0\" or \"2.2.0\"","type":"text"},{"key":"directoryServerId","value":"00000000-0000-0000-0000-000000000000","description":"Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication.\nFormat: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"text"},{"key":"type","value":"validate","description":"The type of transaction to be processed.\n\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'"},{"key":"billing_method","value":"recurring","description":"Should be set to 'recurring' to mark payment as a recurring transaction or 'installment' to mark payment as an installment transaction.\nValues: 'recurring', 'installment'","type":"text"},{"key":"initiated_by","value":"customer","description":"Who initiated the transaction.\n\nValues: 'customer' or 'merchant'"},{"key":"stored_credential_indicator","value":"stored","description":"The indicator of the stored credential.\n\nValues: 'stored' or 'used'\n\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.\n\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."}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"response=1&responsetext=SUCCESS&authcode=&transactionid=8464223277&avsresponse=N&cvvresponse=&orderid=&type=validate&response_code=100&cc_exp=1025&cc_number=4xxxxxxxxxxx1111&cc_type=visa&address_1=Appartment 2&city=Chicago&first_name=John&last_name=Smith&postal_code=60193&customer_vault_id=TestCustomer1&three_ds_version=2.1.0&eci=05&directory_server_id=00000000-0000-0000-0000-000000000000"},{"id":"1cd31a9c-a31a-44be-98ca-dfce73df1298","name":"Customer Vault","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault_id","value":"TestCustomer1","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id."},{"key":"first_name","value":"John","description":"Cardholder's first name.","disabled":true},{"key":"last_name","value":"Smith","description":"Cardholder's last name.","disabled":true},{"key":"company","value":"Company Inc.","description":"Cardholder's company.","disabled":true},{"key":"address1","value":"Apartment 2","description":"Card billing address.","disabled":true},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2.","disabled":true},{"key":"city","value":"Chicago","description":"Card billing city.","disabled":true},{"key":"state","value":"IL","description":"Card billing state.","disabled":true},{"key":"zip","value":"60193","description":"Card billing postal code.","disabled":true},{"key":"country","value":"US","description":"Card billing country code.","disabled":true},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number.","disabled":true},{"key":"email","value":"test@example.com","description":"Billing email address.","disabled":true},{"key":"cavv","value":"Y2FyZGopYWjtg21tZXJjZfF1dJg=","description":"Cardholder authentication verification value.\nFormat: base64 encoded","type":"text"},{"key":"xid","value":"","description":"Cardholder authentication transaction id.\nFormat: base64 encoded","type":"text"},{"key":"eci","value":"05","description":"A number that indicates the result of the attempt to authenticate the cardholder. Values are dependent on the card brand.","type":"text"},{"key":"cardHolderAuth","value":"verified","description":"Set 3D Secure condition. Value used to determine E-commerce indicator (ECI).\nValues: 'verified' or 'attempted'","type":"text"},{"key":"threeDsVersion","value":"2.1.0","description":"3DSecure version.\nExamples: \"2.0.0\" or \"2.2.0\"","type":"text"},{"key":"directoryServerId","value":"00000000-0000-0000-0000-000000000000","description":"Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication.\nFormat: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"text"},{"key":"type","value":"sale","description":"The type of transaction to be processed.\n\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'"},{"key":"amount","value":"1.00","description":"The transaction amount.\nFormat:XX.XX","type":"text"},{"key":"billing_method","value":"recurring","description":"Should be set to 'recurring' to mark payment as a recurring transaction or 'installment' to mark payment as an installment transaction.\nValues: 'recurring', 'installment'","type":"text"},{"key":"initiated_by","value":"customer","description":"Who initiated the transaction.\n\nValues: 'customer' or 'merchant'"},{"key":"stored_credential_indicator","value":"used","description":"The indicator of the stored credential.\n\nValues: 'stored' or 'used'\n\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.\n\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."},{"key":"initial_transaction_id","value":"{{firstStoreTransactionId}}","description":"Original payment gateway transaction id.","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"response=1&responsetext=SUCCESS&authcode=123456&transactionid=8448369667&avsresponse=N&cvvresponse=&orderid=&type=sale&response_code=100&cc_exp=1234&cc_number=4xxxxxxxxxxx1111&cc_type=visa&address_1=Appartment 2&city=Chicago&first_name=John&last_name=Smith&postal_code=60193&three_ds_version=2.1.0&eci=05&directory_server_id=00000000-0000-0000-0000-000000000000"}],"_postman_id":"2484c030-1d2f-4145-9aee-1af5ee0e79bf"},{"name":"Credential on File - MIT","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"51a53a9f-2e66-4756-8602-afb002acbddf"}}],"id":"9bb1cf68-6f09-4665-99d6-7509332129de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault_id","value":"customer_vault_id","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.
\n"},{"key":"initiated_by","value":"merchant","description":"Who initiated the transaction.
\nValues: 'customer' or 'merchant'
\n"},{"key":"initial_transaction_id","value":"{{firstStoreTransactionId}}","description":"Original payment gateway transaction id.
\n"},{"key":"stored_credential_indicator","value":"used","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"},{"key":"type","value":"sale","description":"The type of transaction to be processed.
\nValues: 'sale', 'auth', 'credit', 'validate', or 'offline'
\n"},{"key":"amount","value":"12.34","description":"Total amount to be charged. For validate, the amount must be omitted or set to 0.00.
\nFormat: x.xx
\n"}]},"url":"https://secure.nmi.com/api/transact.php","description":"Merchant initiated transactions, also known as MIT, are Credential on File transactions in which the customer isn’t actively engaged, but has given permission for their card to be charged. In order for a merchant to submit a Merchant Initiated Transaction, a Customer Initiated transaction is required first.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9bb1cf68-6f09-4665-99d6-7509332129de"}],"id":"b69ff228-be0f-49b7-96b9-5e1041969668","description":"Credential on File transactions should be used when storing any cardholder data to make payments at a later date. Credential on File is required to be used in locations which fall on the PSD2 Mandate and should be utilized any time a merchant hopes to store customer payment information.
\nCredential on File utilizes two different methods Customer Initiated Transactions or CIT and Merchant Initiated Transactions or MIT. Below will provide examples of what is needed in order to perform both a CIT and MIT transaction.
\n","_postman_id":"b69ff228-be0f-49b7-96b9-5e1041969668"},{"name":"Add Customer Record","event":[{"listen":"test","script":{"exec":["var match = responseBody.match(/customer_vault_id=(\\d+)/);\r","if (match != null) {\r"," pm.environment.set(\"CustomerVaultId\", match[1])\r","}"],"type":"text/javascript","id":"f25b2f38-cccc-49b1-ae9a-a337ec59893e"}}],"id":"e7901af0-5883-43e3-b57c-c9ef2fef879d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"add_customer","description":"Add/Update a secure Customer Vault record.
\nValues: 'add_customer' or 'update_customer'
\n"},{"key":"customer_vault_id","value":"","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.
\n","disabled":true},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number.
\n"},{"key":"ccexp","value":"1234","description":"Credit card expiration.
\nFormat: MMYY
\n"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n"},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n"},{"key":"company","value":"Company Inc.","description":"Cardholder's company.
\n"},{"key":"address1","value":"Apartment 2","description":"Card billing address.
\n"},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2.
\n"},{"key":"city","value":"Chicago","description":"Card billing city.
\n"},{"key":"state","value":"IL","description":"Card billing state.
\n"},{"key":"zip","value":"60193","description":"Card billing postal code.
\n"},{"key":"country","value":"US","description":"Card billing country code.
\n"},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number.
\n"},{"key":"email","value":"test@example.com","description":"Billing email address.
\n"},{"key":"fax","value":"","description":"Billing fax number.
\n","disabled":true},{"key":"shipping_id","value":"","description":"Shipping entry id. If none is provided, one will be created or the billing id with priority '1' will be updated.
\n","type":"text","disabled":true},{"key":"shipping_firstname","value":"","description":"Shipping first name.
\n","type":"text","disabled":true},{"key":"shipping_lastname","value":"","description":"Shipping last name.
\n","type":"text","disabled":true},{"key":"shipping_company","value":"","description":"Shipping company.
\n","type":"text","disabled":true},{"key":"shipping_address1","value":"","description":"Shipping address.
\n","type":"text","disabled":true},{"key":"shipping_address2","value":"","description":"Shipping address, line 2.
\n","type":"text","disabled":true},{"key":"shipping_city","value":"","description":"Shipping city.
\n","type":"text","disabled":true},{"key":"shipping_state","value":"","description":"Shipping state.
\n","type":"text","disabled":true},{"key":"shipping_zip","value":"","description":"Shipping postal code.
\n","type":"text","disabled":true},{"key":"shipping_country","value":"","description":"Shipping country code.
\n","type":"text","disabled":true},{"key":"shipping_phone","value":"","description":"Shipping phone number.
\n","type":"text","disabled":true},{"key":"shipping_email","value":"","description":"Shipping email address.
\n","type":"text","disabled":true},{"key":"shipping_fax","value":"","description":"Shipping fax number.
\n","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Customer Vault record.
\n","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.
\nValues: 'true' or 'false'
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"When utilizing the Customer Vault, integrators will have the ability to securely store their customer's payment data for future use. In order to do so, integrators will need to build out an add customer request and submit the request via the Payment API. Upon successful submission a new Customer Vault Id will be returned to signify that the Customer Vault Record has been created.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"59775ade-3aa8-4839-a509-d9b805ae21cb","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"add_customer","description":"Add/Update a secure Customer Vault record.\n\nValues: 'add_customer' or 'update_customer'"},{"key":"customer_vault_id","value":"","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.","disabled":true},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number."},{"key":"ccexp","value":"1234","description":"Credit card expiration.\n\nFormat: MMYY"},{"key":"first_name","value":"John","description":"Cardholder's first name."},{"key":"last_name","value":"Smith","description":"Cardholder's last name."},{"key":"company","value":"Company Inc.","description":"Cardholder's company."},{"key":"address1","value":"Apartment 2","description":"Card billing address."},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2."},{"key":"city","value":"Chicago","description":"Card billing city."},{"key":"state","value":"IL","description":"Card billing state."},{"key":"zip","value":"60193","description":"Card billing postal code."},{"key":"country","value":"US","description":"Card billing country code."},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number."},{"key":"email","value":"test@example.com","description":"Billing email address."},{"key":"fax","value":"","description":"Billing fax number.","disabled":true},{"key":"shipping_id","value":"","description":"Shipping entry id. If none is provided, one will be created or the billing id with priority '1' will be updated.","type":"text","disabled":true},{"key":"shipping_firstname","value":"","description":"Shipping first name.","type":"text","disabled":true},{"key":"shipping_lastname","value":"","description":"Shipping last name.","type":"text","disabled":true},{"key":"shipping_company","value":"","description":"Shipping company.","type":"text","disabled":true},{"key":"shipping_address1","value":"","description":"Shipping address.","type":"text","disabled":true},{"key":"shipping_address2","value":"","description":"Shipping address, line 2.","type":"text","disabled":true},{"key":"shipping_city","value":"","description":"Shipping city.","type":"text","disabled":true},{"key":"shipping_state","value":"","description":"Shipping state.","type":"text","disabled":true},{"key":"shipping_zip","value":"","description":"Shipping postal code.","type":"text","disabled":true},{"key":"shipping_country","value":"","description":"Shipping country code.","type":"text","disabled":true},{"key":"shipping_phone","value":"","description":"Shipping phone number.","type":"text","disabled":true},{"key":"shipping_email","value":"","description":"Shipping email address.","type":"text","disabled":true},{"key":"shipping_fax","value":"","description":"Shipping fax number.","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Customer Vault record.","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\n\nValues: 'true' or 'false'","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 12 Jun 2023 13:41:10 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit16014"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"response=1&responsetext=Customer Added&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=&response_code=100&customer_vault_id=971493957"}],"_postman_id":"e7901af0-5883-43e3-b57c-c9ef2fef879d"},{"name":"Add Customer Record via PaymentToken","event":[{"listen":"test","script":{"exec":["var match = responseBody.match(/customer_vault_id=(\\d+)/);\r","if (match != null) {\r"," pm.environment.set(\"CustomerVaultId\", match[1])\r","}"],"type":"text/javascript","id":"284cea30-a9ff-4269-85ee-b9499eca88ce"}}],"id":"0cf79f74-c599-410a-922b-e1e2ee6afae7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"add_customer","description":"Add/Update a secure Customer Vault record.
\nValues: 'add_customer' or 'update_customer'
\n"},{"key":"customer_vault_id","value":"","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.
\n","disabled":true},{"key":"type","value":"","description":"If set, will perform a hybrid transaction while adding to the vault.
\n","type":"text","disabled":true},{"key":"amount","value":"","description":"Needed if type is set to 'sale' or 'auth'
\n","type":"text","disabled":true},{"key":"payment_token","value":"{{payment_token}}","description":"Payment Token generated from Collect.js
\n"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n"},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n"},{"key":"company","value":"Company Inc.","description":"Cardholder's company.
\n"},{"key":"address1","value":"Apartment 2","description":"Card billing address.
\n"},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2.
\n"},{"key":"city","value":"Chicago","description":"Card billing city.
\n"},{"key":"state","value":"IL","description":"Card billing state.
\n"},{"key":"zip","value":"60193","description":"Card billing postal code.
\n"},{"key":"country","value":"US","description":"Card billing country code.
\n"},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number.
\n"},{"key":"email","value":"test@example.com","description":"Billing email address.
\n"},{"key":"fax","value":"","description":"Billing fax number.
\n","disabled":true},{"key":"shipping_id","value":"","description":"Shipping entry id. If none is provided, one will be created or the billing id with priority '1' will be updated.
\n","type":"text","disabled":true},{"key":"shipping_firstname","value":"","description":"Shipping first name.
\n","type":"text","disabled":true},{"key":"shipping_lastname","value":"","description":"Shipping last name.
\n","type":"text","disabled":true},{"key":"shipping_company","value":"","description":"Shipping company.
\n","type":"text","disabled":true},{"key":"shipping_address1","value":"","description":"Shipping address.
\n","type":"text","disabled":true},{"key":"shipping_address2","value":"","description":"Shipping address, line 2.
\n","type":"text","disabled":true},{"key":"shipping_city","value":"","description":"Shipping city.
\n","type":"text","disabled":true},{"key":"shipping_state","value":"","description":"Shipping state.
\n","type":"text","disabled":true},{"key":"shipping_zip","value":"","description":"Shipping postal code.
\n","type":"text","disabled":true},{"key":"shipping_country","value":"","description":"Shipping country code.
\n","type":"text","disabled":true},{"key":"shipping_phone","value":"","description":"Shipping phone number.
\n","type":"text","disabled":true},{"key":"shipping_email","value":"","description":"Shipping email address.
\n","type":"text","disabled":true},{"key":"shipping_fax","value":"","description":"Shipping fax number.
\n","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Customer Vault record.
\n","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.
\nValues: 'true' or 'false'
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"When utilizing the Customer Vault, integrators will have the ability to securely store their customer's payment data for future use. In order to do so, integrators will need to build out an add customer request and submit the request via the Payment API. Upon successful submission a new Customer Vault Id will be returned to signify that the Customer Vault Record has been created.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"90d5c736-f876-420d-8633-bc59fb842db2","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"add_customer","description":"Add/Update a secure Customer Vault record.\n\nValues: 'add_customer' or 'update_customer'"},{"key":"customer_vault_id","value":"","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.","disabled":true},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number."},{"key":"ccexp","value":"1234","description":"Credit card expiration.\n\nFormat: MMYY"},{"key":"first_name","value":"John","description":"Cardholder's first name."},{"key":"last_name","value":"Smith","description":"Cardholder's last name."},{"key":"company","value":"Company Inc.","description":"Cardholder's company."},{"key":"address1","value":"Apartment 2","description":"Card billing address."},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2."},{"key":"city","value":"Chicago","description":"Card billing city."},{"key":"state","value":"IL","description":"Card billing state."},{"key":"zip","value":"60193","description":"Card billing postal code."},{"key":"country","value":"US","description":"Card billing country code."},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number."},{"key":"email","value":"test@example.com","description":"Billing email address."},{"key":"fax","value":"","description":"Billing fax number.","disabled":true},{"key":"shipping_id","value":"","description":"Shipping entry id. If none is provided, one will be created or the billing id with priority '1' will be updated.","type":"text","disabled":true},{"key":"shipping_firstname","value":"","description":"Shipping first name.","type":"text","disabled":true},{"key":"shipping_lastname","value":"","description":"Shipping last name.","type":"text","disabled":true},{"key":"shipping_company","value":"","description":"Shipping company.","type":"text","disabled":true},{"key":"shipping_address1","value":"","description":"Shipping address.","type":"text","disabled":true},{"key":"shipping_address2","value":"","description":"Shipping address, line 2.","type":"text","disabled":true},{"key":"shipping_city","value":"","description":"Shipping city.","type":"text","disabled":true},{"key":"shipping_state","value":"","description":"Shipping state.","type":"text","disabled":true},{"key":"shipping_zip","value":"","description":"Shipping postal code.","type":"text","disabled":true},{"key":"shipping_country","value":"","description":"Shipping country code.","type":"text","disabled":true},{"key":"shipping_phone","value":"","description":"Shipping phone number.","type":"text","disabled":true},{"key":"shipping_email","value":"","description":"Shipping email address.","type":"text","disabled":true},{"key":"shipping_fax","value":"","description":"Shipping fax number.","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Customer Vault record.","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\n\nValues: 'true' or 'false'","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 12 Jun 2023 13:41:10 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit16014"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"response=1&responsetext=Customer Added&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=&response_code=100&customer_vault_id=971493957"}],"_postman_id":"0cf79f74-c599-410a-922b-e1e2ee6afae7"},{"name":"Update Customer Record","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"77678b05-b94d-4951-9868-06ce569cb6f2"}}],"id":"15082ef0-c950-4fd4-97e0-607141f7d49f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"update_customer","description":"Add/Update a secure Customer Vault record.
\nValues: 'add_customer' or 'update_customer'
\n"},{"key":"customer_vault_id","value":"{{CustomerVaultId}}","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.
\n"},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number.
\n"},{"key":"ccexp","value":"1234","description":"Credit card expiration.
\nFormat: MMYY
\n"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n"},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n"},{"key":"company","value":"Company Inc.","description":"Cardholder's company.
\n"},{"key":"address1","value":"Apartment 2","description":"Card billing address.
\n"},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2.
\n"},{"key":"city","value":"Chicago","description":"Card billing city.
\n"},{"key":"state","value":"IL","description":"Card billing state.
\n"},{"key":"zip","value":"60193","description":"Card billing postal code.
\n"},{"key":"country","value":"US","description":"Card billing country code.
\n"},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number.
\n"},{"key":"email","value":"test@example.com","description":"Billing email address.
\n"},{"key":"fax","value":"","description":"Billing fax number.
\n","disabled":true},{"key":"shipping_id","value":"","description":"Shipping entry id. If none is provided, one will be created or the billing id with priority '1' will be updated.
\n","type":"text","disabled":true},{"key":"shipping_firstname","value":"","description":"Shipping first name.
\n","type":"text","disabled":true},{"key":"shipping_lastname","value":"","description":"Shipping last name.
\n","type":"text","disabled":true},{"key":"shipping_company","value":"","description":"Shipping company.
\n","type":"text","disabled":true},{"key":"shipping_address1","value":"","description":"Shipping address.
\n","type":"text","disabled":true},{"key":"shipping_address2","value":"","description":"Shipping address, line 2.
\n","type":"text","disabled":true},{"key":"shipping_city","value":"","description":"Shipping city.
\n","type":"text","disabled":true},{"key":"shipping_state","value":"","description":"Shipping state.
\n","type":"text","disabled":true},{"key":"shipping_zip","value":"","description":"Shipping postal code.
\n","type":"text","disabled":true},{"key":"shipping_country","value":"","description":"Shipping country code.
\n","type":"text","disabled":true},{"key":"shipping_phone","value":"","description":"Shipping phone number.
\n","type":"text","disabled":true},{"key":"shipping_email","value":"","description":"Shipping email address.
\n","type":"text","disabled":true},{"key":"shipping_fax","value":"","description":"Shipping fax number.
\n","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Customer Vault record.
\n","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.
\nValues: 'true' or 'false'
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Should any payment information/details change for a customer an Update request may be performed via the Payment API. This request will allow integrators to call a specified Customer Vault Record in order to change any details of the specific Vault Record. (ie Credit Card expiry, Name, Address, Credit Card Number...)
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"e2d49140-54eb-4d7a-9f3f-e7a24e6285cb","name":"Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"update_customer","description":"Add/Update a secure Customer Vault record.\n\nValues: 'add_customer' or 'update_customer'"},{"key":"customer_vault_id","value":"TestCustomer1","description":"Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id."},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number."},{"key":"ccexp","value":"1234","description":"Credit card expiration.\n\nFormat: MMYY"},{"key":"first_name","value":"John","description":"Cardholder's first name."},{"key":"last_name","value":"Smith","description":"Cardholder's last name."},{"key":"company","value":"Company Inc.","description":"Cardholder's company."},{"key":"address1","value":"Apartment 2","description":"Card billing address."},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2."},{"key":"city","value":"Chicago","description":"Card billing city."},{"key":"state","value":"IL","description":"Card billing state."},{"key":"zip","value":"60193","description":"Card billing postal code."},{"key":"country","value":"US","description":"Card billing country code."},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number."},{"key":"email","value":"test@example.com","description":"Billing email address."},{"key":"fax","value":"","description":"Billing fax number.","disabled":true},{"key":"shipping_id","value":"","description":"Shipping entry id. If none is provided, one will be created or the billing id with priority '1' will be updated.","type":"text","disabled":true},{"key":"shipping_firstname","value":"","description":"Shipping first name.","type":"text","disabled":true},{"key":"shipping_lastname","value":"","description":"Shipping last name.","type":"text","disabled":true},{"key":"shipping_company","value":"","description":"Shipping company.","type":"text","disabled":true},{"key":"shipping_address1","value":"","description":"Shipping address.","type":"text","disabled":true},{"key":"shipping_address2","value":"","description":"Shipping address, line 2.","type":"text","disabled":true},{"key":"shipping_city","value":"","description":"Shipping city.","type":"text","disabled":true},{"key":"shipping_state","value":"","description":"Shipping state.","type":"text","disabled":true},{"key":"shipping_zip","value":"","description":"Shipping postal code.","type":"text","disabled":true},{"key":"shipping_country","value":"","description":"Shipping country code.","type":"text","disabled":true},{"key":"shipping_phone","value":"","description":"Shipping phone number.","type":"text","disabled":true},{"key":"shipping_email","value":"","description":"Shipping email address.","type":"text","disabled":true},{"key":"shipping_fax","value":"","description":"Shipping fax number.","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Customer Vault record.","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\n\nValues: 'true' or 'false'","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Mon, 12 Jun 2023 13:57:29 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":"","type":"text"},{"key":"Via","value":"1.1 dca1-bit16014"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"response=3&responsetext=Invalid Customer Vault Id REFID:1095356952&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=&response_code=300&customer_vault_id=TestCustomer1"}],"_postman_id":"15082ef0-c950-4fd4-97e0-607141f7d49f"},{"name":"Delete Customer Record","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"b841c5d2-a81e-413f-a48f-67449f76f1cc"}}],"id":"1cba6449-1607-4cd2-b35d-fe8e0e472f63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"delete_customer","description":"Deletes a secure Customer Vault record.\nValues: 'delete_customer'
\n"},{"key":"customer_vault_id","value":"{{CustomerVaultId}}","description":"Specifies a Customer Vault id.
\n"}]},"url":"https://secure.nmi.com/api/transact.php","description":"When utilizing the Customer Vault, integrators have the ability to delete a Customer Vault Record. Using the Payment API integrators may submit a delete customer request to remove a specified Customer Vault Record from the Customer Vault.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1cba6449-1607-4cd2-b35d-fe8e0e472f63"},{"name":"Add Billing Record","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"a37ea61f-f70e-4768-a7af-31b13d227240"}}],"id":"a86bded0-c8ed-400c-973f-75002978ad3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"add_billing","description":"Add/update a secure Customer Vault billing record.\nValues: 'add_billing' or 'update_billing'
\n"},{"key":"customer_vault_id","value":"{{CustomerVaultId}}","description":"Specifies a Customer Vault id.
\n"},{"key":"billing_id","value":"BillingId1","description":"Specifies a billing id.
\n","type":"text"},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number.
\n"},{"key":"ccexp","value":"1234","description":"Credit card expiration.
\nFormat: MMYY
\n"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n"},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n"},{"key":"company","value":"Company Inc.","description":"Cardholder's company.
\n"},{"key":"address1","value":"Apartment 2","description":"Card billing address.
\n"},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2.
\n"},{"key":"city","value":"Chicago","description":"Card billing city.
\n"},{"key":"state","value":"IL","description":"Card billing state.
\n"},{"key":"zip","value":"60193","description":"Card billing postal code.
\n"},{"key":"country","value":"US","description":"Card billing country code.
\n"},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number.
\n"},{"key":"email","value":"test@example.com","description":"Billing email address.
\n","type":"text"},{"key":"fax","value":"","description":"Billing fax number.
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Each Customer Vault Record allows for multiple Billing Records to be stored within the Vault. These additional Billing Records may be added and stored within an already created Customer Vault Id. These additional Billing Records once created may then be used to perform payments should a billing_idbe specified within the API request.
Add/update a secure Customer Vault billing record.\nValues: 'add_billing' or 'update_billing'
\n"},{"key":"customer_vault_id","value":"{{CustomerVaultId}}","description":"Specifies a Customer Vault id.
\n"},{"key":"billing_id","value":"BillingId1","description":"Specifies a billing id.
\n","type":"text"},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number.
\n"},{"key":"ccexp","value":"1234","description":"Credit card expiration.
\nFormat: MMYY
\n"},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n"},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n"},{"key":"company","value":"Company Inc.","description":"Cardholder's company.
\n"},{"key":"address1","value":"Apartment 2","description":"Card billing address.
\n"},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2.
\n"},{"key":"city","value":"Chicago","description":"Card billing city.
\n"},{"key":"state","value":"IL","description":"Card billing state.
\n"},{"key":"zip","value":"60193","description":"Card billing postal code.
\n"},{"key":"country","value":"US","description":"Card billing country code.
\n"},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number.
\n"},{"key":"email","value":"test@example.com","description":"Billing email address.
\n","type":"text"},{"key":"fax","value":"","description":"Billing fax number.
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Should any payment information/details change for a customer an Update request may be performed via the Payment API. This request will allow integrators to call a specified Customer Vault Billing Record in order to change any details to the specified Vault Billing Record. (ie Credit Card expiry, Name, Address, Credit Card Number...)
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"e4cff2e0-e0cd-4371-94b6-dbd3e11987ed","name":"Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"update_billing","description":"Add/update a secure Customer Vault billing record.\nValues: 'add_billing' or 'update_billing'"},{"key":"customer_vault_id","value":"{{CustomerVaultId}}","description":"Specifies a Customer Vault id."},{"key":"billing_id","value":"BillingId1","description":"Specifies a billing id.","type":"text"},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number."},{"key":"ccexp","value":"1234","description":"Credit card expiration.\n\nFormat: MMYY"},{"key":"first_name","value":"John","description":"Cardholder's first name."},{"key":"last_name","value":"Smith","description":"Cardholder's last name."},{"key":"company","value":"Company Inc.","description":"Cardholder's company."},{"key":"address1","value":"Apartment 2","description":"Card billing address."},{"key":"address2","value":"1234 Main St.","description":"Card billing address, line 2."},{"key":"city","value":"Chicago","description":"Card billing city."},{"key":"state","value":"IL","description":"Card billing state."},{"key":"zip","value":"60193","description":"Card billing postal code."},{"key":"country","value":"US","description":"Card billing country code."},{"key":"phone","value":"+1 (847) 352 4850","description":"Billing phone number."},{"key":"email","value":"test@example.com","description":"Billing email address.","type":"text"},{"key":"fax","value":"","description":"Billing fax number.","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"response=3&responsetext=Invalid Customer Vault Id REFID:1095356952&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=&response_code=300&customer_vault_id=TestCustomer1"}],"_postman_id":"5ea2e4c3-1cd3-40ac-9781-0e097f793767"},{"name":"Delete Billing Record","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"4a0d671b-6f64-4f5b-80ca-5296928949b6"}}],"id":"63ecd404-4534-4307-92ec-90813563408b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer_vault","value":"delete_billing","description":"Deletes a secure Customer Vault billing record.
\nValues: 'delete_billing'
\n"},{"key":"customer_vault_id","value":"{{CustomerVaultId}}","description":"Specifies a Customer Vault id.
\n"},{"key":"billing_id","value":"BillingId1","description":"Specifies a billing id.
\n","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php","description":"When utilizing the Customer Vault, integrators have the ability to delete a Billing Record from the Vault. Using the Payment API integrators may submit a delete billing request to remove a specified Billing Record.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"63ecd404-4534-4307-92ec-90813563408b"}],"id":"814c281d-7346-4851-b909-b5a2c56693eb","description":"The Customer Vault was designed specifically for businesses of any size to address concerns about handling customer payment information. The Customer Vault allows Merchants to securely store their customer's payment data within the Gateway's secure servers to be used for future transactional operations.
\n","_postman_id":"814c281d-7346-4851-b909-b5a2c56693eb"},{"name":"Recurring","item":[{"name":"Add a Plan","id":"598fbe20-2787-4c76-8668-2366cd08803c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"add_plan","description":"Add a recurring plan that subscriptions can be added to in the future.
\n","type":"text"},{"key":"plan_payments","value":"0","description":"The number of payments before the recurring plan is complete.\nNotes: '0' for until canceled
\n","type":"text"},{"key":"plan_amount","value":"10.00","description":"The plan amount to be charged each billing cycle.\nFormat: x.xx
\n","type":"text"},{"key":"plan_name","value":"Test Plan","description":"The display name of the plan.
\n","type":"text"},{"key":"plan_id","value":"TestPlanId1","description":"The unique plan ID that references only this recurring plan.
\n","type":"text"},{"key":"day_frequency","value":"","description":"How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.
\n","type":"text","disabled":true},{"key":"month_frequency","value":"1","description":"How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'.\nValues: 1 through 24
\n","type":"text"},{"key":"day_of_month","value":"15","description":"The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'.\nValues: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day
\n","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php","description":"Utilizing the add plan value for the recurring module allows integrations to create different plans. With these plans you may predefine the price and payment schedule for subscriptions tied to the plan.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"ef36a477-8fb4-4b02-9779-366870e2ef34","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"add_plan","description":"Add a recurring plan that subscriptions can be added to in the future.","type":"text"},{"key":"plan_payments","value":"0","description":"The number of payments before the recurring plan is complete.\nNotes: '0' for until canceled","type":"text"},{"key":"plan_amount","value":"10.00","description":"The plan amount to be charged each billing cycle.\nFormat: x.xx","type":"text"},{"key":"plan_name","value":"Test Plan","description":"The display name of the plan.","type":"text"},{"key":"plan_id","value":"TestPlanId1","description":"The unique plan ID that references only this recurring plan.","type":"text"},{"key":"day_frequency","value":"","description":"How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.","type":"text","disabled":true},{"key":"month_frequency","value":"1","description":"How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'.\nValues: 1 through 24","type":"text"},{"key":"day_of_month","value":"15","description":"The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'.\nValues: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 12 Jun 2023 14:02:05 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit12044"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"response=1&responsetext=Plan Added&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=&response_code=100"}],"_postman_id":"598fbe20-2787-4c76-8668-2366cd08803c"},{"name":"Edit a Plan","id":"8d995500-adc5-47b6-a95f-12204025c696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"edit_plan","description":"Edit an existing recurring plan.\nValue: 'edit_plan' - Be careful when editing an existing plan, as all customers signed up for this plan will have their billing changed based on your edits.
\n","type":"text"},{"key":"current_plan_id","value":"123456","description":"Only relevant for editing an existing plan, the value will be the 'plan_id' that will be edited in this request.
\n","type":"text"},{"key":"plan_payments","value":"0","description":"The number of payments before the recurring plan is complete.\nNotes: '0' for until canceled
\n","type":"text","disabled":true},{"key":"plan_amount","value":"10.00","description":"The plan amount to be charged each billing cycle.\nFormat: x.xx
\n","type":"text","disabled":true},{"key":"plan_name","value":"Test Plan","description":"The display name of the plan.
\n","type":"text","disabled":true},{"key":"plan_id","value":"123456","description":"The unique plan ID that references only this recurring plan.
\n","type":"text","disabled":true},{"key":"day_frequency","value":"","description":"How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.
\n","type":"text","disabled":true},{"key":"month_frequency","value":"","description":"How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'.\nValues: 1 through 24
\n","type":"text","disabled":true},{"key":"day_of_month","value":"","description":"The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'.\nValues: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"With the recurring module, integrations may edit plans utilizing the Payment API. The edit function allows integrations to call a plan directly using the plan's id and make various changes to the plan. These changes may revolve around the pricing of the plan or changes to how often the plan will charge customers.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"78977a2f-46dc-42d4-802e-dfba103f7985","name":"Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"edit_plan","description":"Edit an existing recurring plan.\nValue: 'edit_plan' - Be careful when editing an existing plan, as all customers signed up for this plan will have their billing changed based on your edits.","type":"text"},{"key":"current_plan_id","value":"123456","description":"Only relevant for editing an existing plan, the value will be the 'plan_id' that will be edited in this request.","type":"text"},{"key":"plan_payments","value":"0","description":"The number of payments before the recurring plan is complete.\nNotes: '0' for until canceled","type":"text"},{"key":"plan_amount","value":"10.00","description":"The plan amount to be charged each billing cycle.\nFormat: x.xx","type":"text"},{"key":"plan_name","value":"Test Plan","description":"The display name of the plan.","type":"text"},{"key":"plan_id","value":"12345","description":"The unique plan ID that references only this recurring plan.","type":"text"},{"key":"day_frequency","value":"","description":"How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.","type":"text","disabled":true},{"key":"month_frequency","value":"","description":"How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'.\nValues: 1 through 24","type":"text","disabled":true},{"key":"day_of_month","value":"","description":"The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'.\nValues: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"response=3&responsetext=Plan ID 123456 not found REFID:1198132793&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=&response_code=300&cc_exp=&cc_number=&cc_type=&address_1=&city=&first_name=&last_name=&postal_code="}],"_postman_id":"8d995500-adc5-47b6-a95f-12204025c696"},{"name":"Add a Subscription to an Existing Plan","id":"240575c4-1dcf-4364-8a1e-cc84997a1cc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"add_subscription","description":"Associate payment information with a recurring plan.
\n","type":"text"},{"key":"plan_id","value":"TestPlanId1","description":"The plan ID of the plan that the subscription will be associated with.
\n","type":"text"},{"key":"ccnumber","value":"4111111111111111","description":"Credit Card Number.
\n","type":"text"},{"key":"ccexp","value":"1025","description":"Credit Card Expiration.\nFormat: MMYY
\n","type":"text"},{"key":"start_date","value":"20230605","description":"The first day that the customer will be charged.\nFormat: YYYYMMDD
\n","type":"text","disabled":true},{"key":"payment_token","value":"","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.
\n","type":"text","disabled":true},{"key":"payment","value":"","description":"The type of payment.\nDefault: 'creditcard'\nValues: 'creditcard' or 'check'
\n","type":"text","disabled":true},{"key":"checkname","value":"","description":"The name on the customer's ACH account.
\n","type":"text","disabled":true},{"key":"checkaccount","value":"","description":"The customer's bank account number.
\n","type":"text","disabled":true},{"key":"checkaba","value":"","description":"The customer's bank routing number.
\n","type":"text","disabled":true},{"key":"account_type","value":"checking","description":"The customer's ACH account type.\nValues: 'checking' or 'savings'
\n","type":"text","disabled":true},{"key":"currency","value":"USD","description":"Set transaction currency.
\n","type":"text","disabled":true},{"key":"account_holder_type","value":"personal","description":"The customer's ACH account entity.\nValues: 'personal' or 'business'
\n","type":"text","disabled":true},{"key":"sec_code","value":"WEB","description":"ACH standard entry class codes.\nValues: 'PPD', 'WEB', 'TEL', or 'CCD'
\n","type":"text","disabled":true},{"key":"first_name","value":"John","description":"Cardholder's first name.
\n","type":"text"},{"key":"last_name","value":"Smith","description":"Cardholder's last name.
\n","type":"text"},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address.
\n","type":"text"},{"key":"address2","value":"","description":"Card billing address, line 2.
\n","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card bliing city
\n","type":"text"},{"key":"state","value":"NY","description":"Card billing state.
\n","type":"text"},{"key":"zip","value":"11111","description":"Card billing postal code.
\n","type":"text"},{"key":"country","value":"US","description":"Card billing country code.
\n","type":"text"},{"key":"phone","value":"","description":"Billing phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.
\n","type":"text","disabled":true},{"key":"company","value":"","description":"Cardholder's company.
\n","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order ID.
\n","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order Description.
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Can be set up in merchant control panel under 'Settings'->'Merchant Defined Fields'.
\n","type":"text","disabled":true},{"key":"processor_id","value":"","description":"If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).
\n","type":"text","disabled":true},{"key":"customer_receipt","value":"","description":"If set to true, when the customer is charged, they will be sent a transaction receipt.\nValues: 'true' or 'false'
\n","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.
\n","type":"text","disabled":true},{"key":"acu_enabled","value":"","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\nDefault: 'true'\nValues: 'true' or 'false'
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Once a merchant has created any plans they would like to offer to customers, merchants may now create subscriptions utilizing the predefined plans. Utilizing the Payment API integrations may utilize the plan id to link the plans payment details directly to a newly created subscription.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"fcd0f6f3-edf8-4d08-85d4-936ca474620f","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"add_subscription","description":"Associate payment information with a recurring plan.","type":"text"},{"key":"plan_id","value":"TestPlanId1","description":"The plan ID of the plan that the subscription will be associated with.","type":"text"},{"key":"ccnumber","value":"4111111111111111","description":"Credit Card Number.","type":"text"},{"key":"ccexp","value":"1025","description":"Credit Card Expiration.\nFormat: MMYY","type":"text"},{"key":"start_date","value":"20230605","description":"The first day that the customer will be charged.\nFormat: YYYYMMDD","type":"text","disabled":true},{"key":"payment_token","value":"","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.","type":"text","disabled":true},{"key":"payment","value":"","description":"The type of payment.\nDefault: 'creditcard'\nValues: 'creditcard' or 'check'","type":"text","disabled":true},{"key":"checkname","value":"","description":"The name on the customer's ACH account.","type":"text","disabled":true},{"key":"checkaccount","value":"","description":"The customer's bank account number.","type":"text","disabled":true},{"key":"checkaba","value":"","description":"The customer's bank routing number.","type":"text","disabled":true},{"key":"account_type","value":"checking","description":"The customer's ACH account type.\nValues: 'checking' or 'savings'","type":"text","disabled":true},{"key":"currency","value":"USD","description":"Set transaction currency.","type":"text","disabled":true},{"key":"account_holder_type","value":"personal","description":"The customer's ACH account entity.\nValues: 'personal' or 'business'","type":"text","disabled":true},{"key":"sec_code","value":"WEB","description":"ACH standard entry class codes.\nValues: 'PPD', 'WEB', 'TEL', or 'CCD'","type":"text","disabled":true},{"key":"first_name","value":"John","description":"Cardholder's first name.","type":"text"},{"key":"last_name","value":"Smith","description":"Cardholder's last name.","type":"text"},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address.","type":"text"},{"key":"address2","value":"","description":"Card billing address, line 2.","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card bliing city","type":"text"},{"key":"state","value":"NY","description":"Card billing state.","type":"text"},{"key":"zip","value":"11111","description":"Card billing postal code.","type":"text"},{"key":"country","value":"US","description":"Card billing country code.","type":"text"},{"key":"phone","value":"","description":"Billing phone number.","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.","type":"text","disabled":true},{"key":"company","value":"","description":"Cardholder's company.","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order ID.","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order Description.","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Can be set up in merchant control panel under 'Settings'->'Merchant Defined Fields'.","type":"text","disabled":true},{"key":"processor_id","value":"","description":"If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).","type":"text","disabled":true},{"key":"customer_receipt","value":"","description":"If set to true, when the customer is charged, they will be sent a transaction receipt.\nValues: 'true' or 'false'","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.","type":"text","disabled":true},{"key":"acu_enabled","value":"","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\nDefault: 'true'\nValues: 'true' or 'false'","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 12 Jun 2023 14:04:20 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit12044"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"response=1&responsetext=Subscription added&authcode=&transactionid=8433727245&avsresponse=&cvvresponse=&orderid=&type=&response_code=100&subscription_id=8433727245"},{"id":"35b5b0ba-8920-4411-a9ed-6c5fe9ca7f0d","name":"Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"add_subscription","description":"Associate payment information with a recurring plan.","type":"text"},{"key":"plan_id","value":"TestPlanId","description":"The plan ID of the plan that the subscription will be associated with.","type":"text"},{"key":"ccnumber","value":"4111111111111111","description":"Credit Card Number.","type":"text"},{"key":"ccexp","value":"1025","description":"Credit Card Expiration.\nFormat: MMYY","type":"text"},{"key":"start_date","value":"20230605","description":"The first day that the customer will be charged.\nFormat: YYYYMMDD","type":"text","disabled":true},{"key":"payment_token","value":"","description":"The tokenized version of the customer's card or check information. This will be generated by Collect.js and is usable only once.","type":"text","disabled":true},{"key":"payment","value":"","description":"The type of payment.\nDefault: 'creditcard'\nValues: 'creditcard' or 'check'","type":"text","disabled":true},{"key":"checkname","value":"","description":"The name on the customer's ACH account.","type":"text","disabled":true},{"key":"checkaccount","value":"","description":"The customer's bank account number.","type":"text","disabled":true},{"key":"checkaba","value":"","description":"The customer's bank routing number.","type":"text","disabled":true},{"key":"account_type","value":"checking","description":"The customer's ACH account type.\nValues: 'checking' or 'savings'","type":"text","disabled":true},{"key":"currency","value":"USD","description":"Set transaction currency.","type":"text","disabled":true},{"key":"account_holder_type","value":"personal","description":"The customer's ACH account entity.\nValues: 'personal' or 'business'","type":"text","disabled":true},{"key":"sec_code","value":"WEB","description":"ACH standard entry class codes.\nValues: 'PPD', 'WEB', 'TEL', or 'CCD'","type":"text","disabled":true},{"key":"first_name","value":"John","description":"Cardholder's first name.","type":"text"},{"key":"last_name","value":"Smith","description":"Cardholder's last name.","type":"text"},{"key":"address1","value":"123 Lovely Lane","description":"Card billing address.","type":"text"},{"key":"address2","value":"","description":"Card billing address, line 2.","type":"text","disabled":true},{"key":"city","value":"New York City","description":"Card bliing city","type":"text"},{"key":"state","value":"NY","description":"Card billing state.","type":"text"},{"key":"zip","value":"11111","description":"Card billing postal code.","type":"text"},{"key":"country","value":"US","description":"Card billing country code.","type":"text"},{"key":"phone","value":"","description":"Billing phone number.","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.","type":"text","disabled":true},{"key":"company","value":"","description":"Cardholder's company.","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order ID.","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order Description.","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Can be set up in merchant control panel under 'Settings'->'Merchant Defined Fields'.","type":"text","disabled":true},{"key":"processor_id","value":"","description":"If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).","type":"text","disabled":true},{"key":"customer_receipt","value":"","description":"If set to true, when the customer is charged, they will be sent a transaction receipt.\nValues: 'true' or 'false'","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.","type":"text","disabled":true},{"key":"acu_enabled","value":"","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\nDefault: 'true'\nValues: 'true' or 'false'","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 12 Jun 2023 14:04:57 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit12044"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"response=3&responsetext=Plan ID not found REFID:1218939032&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=&response_code=300"}],"_postman_id":"240575c4-1dcf-4364-8a1e-cc84997a1cc7"},{"name":"Adding a Custom Subscription","id":"95ae85da-38d0-46cc-9bc7-4e8effd2ff27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"add_subscription","description":"Add a custom recurring subscription that is NOT associated with an existing plan
\n","type":"text"},{"key":"plan_payments","value":"0","description":"The number of payments before the recurring plan is complete.\nNotes: '0' for until canceled
\n","type":"text"},{"key":"plan_amount","value":"10.00","description":"The plan amount to be charged each billing cycle.\nFormat: x.xx
\n","type":"text"},{"key":"day_frequency","value":"15","description":"How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.
\n","type":"text","disabled":true},{"key":"month_frequency","value":"1","description":"How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'.\nValues: 1 through 24
\n","type":"text"},{"key":"day_of_month","value":"15","description":"The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'.\nValues: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day
\n","type":"text"},{"key":"start_date","value":"20230615","description":"The first day that the customer will be charged.\nFormat: YYYYMMDD
\n","type":"text"},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number.
\n","type":"text"},{"key":"ccexp","value":"1025","description":"Credit card expiration.\nFormat: MMYY
\n","type":"text"},{"key":"payment","value":"creditcard","description":"The type of payment.\nDefault: 'creditcard'\nValues: 'creditcard' or 'check'
\n","type":"text","disabled":true},{"key":"checkname","value":"","description":"The name on the customer's ACH account.
\n","type":"text","disabled":true},{"key":"checkaccount","value":"","description":"The customer's bank account number.
\n","type":"text","disabled":true},{"key":"checkaba","value":"","description":"The customer's bank routing number.
\n","type":"text","disabled":true},{"key":"account_type","value":"","description":"The customer's ACH account type.\nValues: 'checking' or 'savings'
\n","type":"text","disabled":true},{"key":"account_holder_type","value":"","description":"The customer's ACH account entity.\nValues: 'personal' or 'business'
\n","type":"text","disabled":true},{"key":"sec_code","value":"WEB","description":"ACH standard entry class codes.\nValues: 'PPD', 'WEB', 'TEL', or 'CCD'
\n","type":"text","disabled":true},{"key":"first_name","value":"","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.
\n","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state.
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing postal code.
\n","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country.
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.
\n","type":"text","disabled":true},{"key":"company","value":"","description":"Cardholder's company.
\n","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order ID.
\n","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order Description
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Can be set up in merchant control panel under 'Settings'->'Merchant Defined Fields'.
\n","type":"text","disabled":true},{"key":"processor_id","value":"","description":"If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).
\n","type":"text","disabled":true},{"key":"customer_receipt","value":"true","description":"If set to true, when the customer is charged, they will be sent a transaction receipt.\nValues: 'true' or 'false'
\n","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.
\n","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\nDefault: 'true'\nValues: 'true' or 'false'
\n","type":"text","disabled":true},{"key":"paused_subscription","value":"true","description":"If set to true, the subscription will be paused.\nValues: 'true' or 'false'
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"With the Gateway's recurring module, integrators may utilize the add subscription value for the recurring module in order to create custom subscriptions. These subscriptions are created per individual customer, unlike the plans. These custom subscriptions allow integrations to pass any payment schedules and price without having to link the subscription to any predefined plans.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"57125814-518b-4ce8-97a4-e2e770ca12e4","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"add_subscription","description":"Add a custom recurring subscription that is NOT associated with an existing plan","type":"text"},{"key":"plan_payments","value":"0","description":"The number of payments before the recurring plan is complete.\nNotes: '0' for until canceled","type":"text"},{"key":"plan_amount","value":"10.00","description":"The plan amount to be charged each billing cycle.\nFormat: x.xx","type":"text"},{"key":"day_frequency","value":"15","description":"How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.","type":"text","disabled":true},{"key":"month_frequency","value":"1","description":"How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'.\nValues: 1 through 24","type":"text"},{"key":"day_of_month","value":"15","description":"The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'.\nValues: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day","type":"text"},{"key":"start_date","value":"20230615","description":"The first day that the customer will be charged.\nFormat: YYYYMMDD","type":"text"},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number.","type":"text"},{"key":"ccexp","value":"1025","description":"Credit card expiration.\nFormat: MMYY","type":"text"},{"key":"payment","value":"creditcard","description":"The type of payment.\nDefault: 'creditcard'\nValues: 'creditcard' or 'check'","type":"text","disabled":true},{"key":"checkname","value":"","description":"The name on the customer's ACH account.","type":"text","disabled":true},{"key":"checkaccount","value":"","description":"The customer's bank account number.","type":"text","disabled":true},{"key":"checkaba","value":"","description":"The customer's bank routing number.","type":"text","disabled":true},{"key":"account_type","value":"","description":"The customer's ACH account type.\nValues: 'checking' or 'savings'","type":"text","disabled":true},{"key":"account_holder_type","value":"","description":"The customer's ACH account entity.\nValues: 'personal' or 'business'","type":"text","disabled":true},{"key":"sec_code","value":"WEB","description":"ACH standard entry class codes.\nValues: 'PPD', 'WEB', 'TEL', or 'CCD'","type":"text","disabled":true},{"key":"first_name","value":"","description":"Cardholder's first name.","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state.","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing postal code.","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country.","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.","type":"text","disabled":true},{"key":"company","value":"","description":"Cardholder's company.","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order ID.","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order Description","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Can be set up in merchant control panel under 'Settings'->'Merchant Defined Fields'.","type":"text","disabled":true},{"key":"processor_id","value":"","description":"If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).","type":"text","disabled":true},{"key":"customer_receipt","value":"true","description":"If set to true, when the customer is charged, they will be sent a transaction receipt.\nValues: 'true' or 'false'","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\nDefault: 'true'\nValues: 'true' or 'false'","type":"text","disabled":true},{"key":"paused_subscription","value":"true","description":"If set to true, the subscription will be paused.\nValues: 'true' or 'false'","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 12 Jun 2023 14:06:38 GMT"},{"key":"Vary","value":"X-Unique-Id"},{"key":"Keep-Alive","value":"timeout=2, max=30"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Via","value":"1.1 dca1-bit12044"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"response=1&responsetext=Subscription added&authcode=&transactionid=8433793050&avsresponse=&cvvresponse=&orderid=&type=&response_code=100&subscription_id=8433793050"}],"_postman_id":"95ae85da-38d0-46cc-9bc7-4e8effd2ff27"},{"name":"Update Subscription","id":"771fc0d3-8b59-40d8-a9e8-6e750baf2c00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"update_subscription","description":"Add a custom recurring subscription that is NOT associated with an existing plan
\n","type":"text"},{"key":"subscription_id","value":"1234567","description":"The subscription ID that will be updated.
\n","type":"text"},{"key":"plan_payments","value":"0","description":"The number of payments before the recurring plan is complete.\nNotes: '0' for until canceled
\n","type":"text","disabled":true},{"key":"plan_amount","value":"10.00","description":"The plan amount to be charged each billing cycle.\nFormat: x.xx
\n","type":"text","disabled":true},{"key":"day_frequency","value":"15","description":"How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.
\n","type":"text","disabled":true},{"key":"month_frequency","value":"1","description":"How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'.\nValues: 1 through 24
\n","type":"text","disabled":true},{"key":"day_of_month","value":"15","description":"The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'.\nValues: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day
\n","type":"text","disabled":true},{"key":"start_date","value":"20230605","description":"The first day that the customer will be charged.\nFormat: YYYYMMDD
\n","type":"text","disabled":true},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number.
\n","type":"text","disabled":true},{"key":"ccexp","value":"1025","description":"Credit card expiration.\nFormat: MMYY
\n","type":"text","disabled":true},{"key":"payment","value":"creditcard","description":"The type of payment.\nDefault: 'creditcard'\nValues: 'creditcard' or 'check'
\n","type":"text","disabled":true},{"key":"checkname","value":"","description":"The name on the customer's ACH account.
\n","type":"text","disabled":true},{"key":"checkaccount","value":"","description":"The customer's bank account number.
\n","type":"text","disabled":true},{"key":"checkaba","value":"","description":"The customer's bank routing number.
\n","type":"text","disabled":true},{"key":"account_type","value":"","description":"The customer's ACH account type.\nValues: 'checking' or 'savings'
\n","type":"text","disabled":true},{"key":"account_holder_type","value":"","description":"The customer's ACH account entity.\nValues: 'personal' or 'business'
\n","type":"text","disabled":true},{"key":"sec_code","value":"WEB","description":"ACH standard entry class codes.\nValues: 'PPD', 'WEB', 'TEL', or 'CCD'
\n","type":"text","disabled":true},{"key":"first_name","value":"","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.
\n","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state.
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing postal code.
\n","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country.
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.
\n","type":"text","disabled":true},{"key":"company","value":"","description":"Cardholder's company.
\n","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order ID.
\n","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order Description
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Can be set up in merchant control panel under 'Settings'->'Merchant Defined Fields'.
\n","type":"text","disabled":true},{"key":"processor_id","value":"","description":"If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).
\n","type":"text","disabled":true},{"key":"customer_receipt","value":"true","description":"If set to true, when the customer is charged, they will be sent a transaction receipt.\nValues: 'true' or 'false'
\n","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.
\n","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\nDefault: 'true'\nValues: 'true' or 'false'
\n","type":"text","disabled":true},{"key":"paused_subscription","value":"true","description":"If set to true, the subscription will be paused.\nValues: 'true' or 'false'
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"When utilizing the recurring module's subscriptions, integrations may perform update requests via the Payment API in order to make changes to any already created subscriptions. Utilizing the subscription id returned at the time of subscription creation, integrations are able to call to a specified subscription and make changes to the recurring payments or customer's payment information.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"68390695-26c6-4e0c-8fc4-ca2e9a7626b9","name":"Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"update_subscription","description":"Add a custom recurring subscription that is NOT associated with an existing plan","type":"text"},{"key":"subscription_id","value":"1234567","description":"The subscription ID that will be updated.","type":"text"},{"key":"plan_payments","value":"0","description":"The number of payments before the recurring plan is complete.\nNotes: '0' for until canceled","type":"text"},{"key":"plan_amount","value":"10.00","description":"The plan amount to be charged each billing cycle.\nFormat: x.xx","type":"text"},{"key":"day_frequency","value":"15","description":"How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.","type":"text"},{"key":"month_frequency","value":"1","description":"How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'.\nValues: 1 through 24","type":"text","disabled":true},{"key":"day_of_month","value":"15","description":"The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'.\nValues: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day","type":"text","disabled":true},{"key":"start_date","value":"20230605","description":"The first day that the customer will be charged.\nFormat: YYYYMMDD","type":"text","disabled":true},{"key":"ccnumber","value":"4111111111111111","description":"Credit card number.","type":"text","disabled":true},{"key":"ccexp","value":"1025","description":"Credit card expiration.\nFormat: MMYY","type":"text","disabled":true},{"key":"payment","value":"creditcard","description":"The type of payment.\nDefault: 'creditcard'\nValues: 'creditcard' or 'check'","type":"text","disabled":true},{"key":"checkname","value":"","description":"The name on the customer's ACH account.","type":"text","disabled":true},{"key":"checkaccount","value":"","description":"The customer's bank account number.","type":"text","disabled":true},{"key":"checkaba","value":"","description":"The customer's bank routing number.","type":"text","disabled":true},{"key":"account_type","value":"","description":"The customer's ACH account type.\nValues: 'checking' or 'savings'","type":"text","disabled":true},{"key":"account_holder_type","value":"","description":"The customer's ACH account entity.\nValues: 'personal' or 'business'","type":"text","disabled":true},{"key":"sec_code","value":"WEB","description":"ACH standard entry class codes.\nValues: 'PPD', 'WEB', 'TEL', or 'CCD'","type":"text","disabled":true},{"key":"first_name","value":"","description":"Cardholder's first name.","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state.","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing postal code.","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country.","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.","type":"text","disabled":true},{"key":"email","value":"","description":"Billing email address.","type":"text","disabled":true},{"key":"company","value":"","description":"Cardholder's company.","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order ID.","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order Description","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Can be set up in merchant control panel under 'Settings'->'Merchant Defined Fields'.","type":"text","disabled":true},{"key":"processor_id","value":"","description":"If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).","type":"text","disabled":true},{"key":"customer_receipt","value":"true","description":"If set to true, when the customer is charged, they will be sent a transaction receipt.\nValues: 'true' or 'false'","type":"text","disabled":true},{"key":"source_transaction_id","value":"","description":"Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.","type":"text","disabled":true},{"key":"acu_enabled","value":"true","description":"If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs.\nDefault: 'true'\nValues: 'true' or 'false'","type":"text","disabled":true},{"key":"paused_subscription","value":"true","description":"If set to true, the subscription will be paused.\nValues: 'true' or 'false'","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"response=3&responsetext=Transaction not found REFID:1155642905&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=&response_code=300&cc_exp=&cc_number=&cc_type=&address_1=&city=&first_name=&last_name=&postal_code="}],"_postman_id":"771fc0d3-8b59-40d8-a9e8-6e750baf2c00"},{"name":"Pause Subscription","id":"13d15883-8119-40ef-8bb1-f018a2b547a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"update_subscription","description":"Add a custom recurring subscription that is NOT associated with an existing plan
\n","type":"text"},{"key":"subscription_id","value":"1234567","description":"The subscription ID that will be updated.
\n","type":"text"},{"key":"paused_subscription","value":"true","description":"If set to true, the subscription will be paused.\nValues: 'true' or 'false'
\n","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php","description":"With the recurring module, integrations have the ability to pause subscriptions. This means that the subscriptions will no longer run until unpaused. Utilizing the subscription's subscription id integrations may perform an API request which will pause any specified subscription indefinitely or until unpaused.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"13d15883-8119-40ef-8bb1-f018a2b547a0"},{"name":"Delete a Subscription","id":"d06d2e35-2cfd-4d29-8965-13c87bb62d0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"recurring","value":"delete_subscription","description":"Delete the subscription. Customer will no longer be charged.
\n","type":"text"},{"key":"subscription_id","value":"1234567","description":"The subscription ID that will be deleted.
\n","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php","description":"Subscriptions may be deleted via a Payment API request if requested within a Payment API request. Utilizing the Payment API delete requests may be performed. This is completed by providing the subscription's id along with the recurring parameter. Once the request is submitted any specified subscriptions will be removed from the Gateway and will no longer perform any recurring transactions.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d06d2e35-2cfd-4d29-8965-13c87bb62d0e"}],"id":"957f782c-7219-4595-b87c-325783d62707","description":"The Payment API may be used to utilize NMI's recurring module. With the Payment API you may create different recurring plans. These plans may then be used to create predefined subscriptions for the merchant's customers. Additionally, the recurring module also allows integrations to create custom subscriptions. These subscriptions are not linked to any plans and are created once the Payment API request has been completed successfully.
\n","_postman_id":"957f782c-7219-4595-b87c-325783d62707"},{"name":"Product Manager","item":[{"name":"Add Product","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"d940e71d-da29-4d91-b795-587ea22bfe22"}}],"id":"c180303b-a083-4e9f-b4b9-1e92d653eff8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"products","value":"add_product","description":"Add a product to the Product Manager.
\nValue: add_product, update_product, delete_product
\n"},{"key":"product_sku","value":"SKU_1","description":"The unique SKU for this product. An error will be returned if the SKU is already in use by another product. Must be alphanumeric.
\nExamples: 000001, SKU1
\n"},{"key":"product_description","value":"Product SKU 1","description":"The user-facing name of the product.
\nExamples: \"1 Gallon Milk\" or \"Phone Case\"
\n"},{"key":"product_cost","value":"1.23","description":"The cost of the product before any tax or discounts. Must be greater than 0.00.
\n"},{"key":"product_currency","value":"GBP","description":"The currency for the product’s price.
\nExamples: \"USD, GBP, EUR
\n"},{"key":"product_commodity_code","value":"","description":"The commodity code for the product.
\n","type":"text","disabled":true},{"key":"product_unit_of_measure","value":"","description":"The unit of measure for the product. Defaults to \"NAR\" (number of articles).
\nExamples: TDK or MTQ
\n","type":"text","disabled":true},{"key":"product_tax_amount","value":"","description":"The tax that should be added to the product cost. This is a fixed amount, not a percentage.
\nExample: 1.54
\n","type":"text","disabled":true},{"key":"product_discount_amount","value":"","description":"The discount that will subtracted from the cost of the product.
\n","type":"text","disabled":true},{"key":"product_image_data","value":"","description":"Required if adding an image. The Base64-encoded version of the image for the product. The format must be JPG, PNG, or GIF, and be 2MB or smaller.
\n","type":"text","disabled":true},{"key":"product_image_name","value":"","description":"Required if adding an image. The file name of the image being added with product_image_data.
\nExamples: product.png, sku-1234.jpg
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"When utilizing the Product Manager, integrators will have the ability to add multiple products to their Merchant Gateway Merchant Account. In order to do so, integrators will need to individually add the products by creating an add product request. Performing this request means integrators will only need to set up their product's information once in order to add the product to the Product Manager.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"e6b415f1-ae55-49ee-b4cc-25a2ee526a38","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"products","value":"add_product","description":"Add a product to the Product Manager.\n\nValue: add_product, update_product, delete_product"},{"key":"product_sku","value":"777","description":"The unique SKU for this product. An error will be returned if the SKU is already in use by another product. Must be alphanumeric.\n\nExamples: 000001, SKU1"},{"key":"product_description","value":"Product SKU 1","description":"The user-facing name of the product.\n\nExamples: \"1 Gallon Milk\" or \"Phone Case\""},{"key":"product_cost","value":"1.23","description":"The cost of the product before any tax or discounts. Must be greater than 0.00."},{"key":"product_currency","value":"GBP","description":"The currency for the product’s price.\n\nExamples: \"USD, GBP, EUR"},{"key":"product_commodity_code","value":"","description":"The commodity code for the product.","type":"text","disabled":true},{"key":"product_unit_of_measure","value":"","description":"The unit of measure for the product. Defaults to \"NAR\" (number of articles).\n\nExamples: TDK or MTQ","type":"text","disabled":true},{"key":"product_tax_amount","value":"","description":"The tax that should be added to the product cost. This is a fixed amount, not a percentage.\n\nExample: 1.54","type":"text","disabled":true},{"key":"product_discount_amount","value":"","description":"The discount that will subtracted from the cost of the product.","type":"text","disabled":true},{"key":"product_image_data","value":"","description":"Required if adding an image. The Base64-encoded version of the image for the product. The format must be JPG, PNG, or GIF, and be 2MB or smaller.","type":"text","disabled":true},{"key":"product_image_name","value":"","description":"Required if adding an image. The file name of the image being added with product_image_data.\n\nExamples: product.png, sku-1234.jpg","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"response=1&responsetext=Product Added&product_id=8448341490&product_sku=777&product_description=Product SKU 1&product_cost=1.23&product_currency=GBP&product_commodity_code=&product_unit_of_measure=NAR&product_tax_amount=&product_discount_amount=&product_image_name=&product_category="}],"_postman_id":"c180303b-a083-4e9f-b4b9-1e92d653eff8"},{"name":"Update Product","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"b243eceb-a8e0-47d9-b827-1d2d9fed0586"}}],"id":"feb1cce0-44ee-4951-b806-59ed41964ad9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"products","value":"update_product","description":"Add a product to the Product Manager.
\nValue: add_product, update_product, delete_product
\n"},{"key":"product_id","value":"123456789","description":"The automatically generated ID for the product. This was returned in the add_product API response, or can be found in the UI under the Product Details page in the Product Manager.
\nExample: 5538585252
\n"},{"key":"product_sku","value":"","description":"The unique SKU for this product. An error will be returned if the SKU is already in use by another product. Must be alphanumeric.
\nExamples: 000001, SKU1
\n","disabled":true},{"key":"product_description","value":"","description":"The user-facing name of the product.
\nExamples: \"1 Gallon Milk\" or \"Phone Case\"
\n","disabled":true},{"key":"product_cost","value":"","description":"The cost of the product before any tax or discounts. Must be greater than 0.00.
\n","disabled":true},{"key":"product_currency","value":"","description":"The currency for the product’s price.
\nExamples: \"USD, GBP, EUR
\n","disabled":true},{"key":"product_commodity_code","value":"","description":"The commodity code for the product.
\n","type":"text","disabled":true},{"key":"product_unit_of_measure","value":"","description":"The unit of measure for the product. Defaults to \"NAR\" (number of articles).
\nExamples: TDK or MTQ
\n","type":"text","disabled":true},{"key":"product_tax_amount","value":"","description":"The tax that should be added to the product cost. This is a fixed amount, not a percentage.
\nExample: 1.54
\n","type":"text","disabled":true},{"key":"product_discount_amount","value":"","description":"The discount that will subtracted from the cost of the product.
\n","type":"text","disabled":true},{"key":"product_image_data","value":"","description":"Required if adding an image. The Base64-encoded version of the image for the product. The format must be JPG, PNG, or GIF, and be 2MB or smaller.
\n","type":"text","disabled":true},{"key":"product_image_name","value":"","description":"Required if adding an image. The file name of the image being added with product_image_data.
\nExamples: product.png, sku-1234.jpg
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Should any product information/details change for an already created product, integrations may utilize an Update request. This request will allow integrators to call a specified product within the Product Manager in order to change details of the specified product. (ie SKU, Name, Amount, Commodity Code...)
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"e985a484-bdbd-49e7-868d-23a97395b2f3","name":"Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"products","value":"update_product","description":"Add a product to the Product Manager.\n\nValue: add_product, update_product, delete_product"},{"key":"product_id","value":"123456789","description":"The automatically generated ID for the product. This was returned in the add_product API response, or can be found in the UI under the Product Details page in the Product Manager.\n\nExample: 5538585252"},{"key":"product_sku","value":"1234","description":"The unique SKU for this product. An error will be returned if the SKU is already in use by another product. Must be alphanumeric.\n\nExamples: 000001, SKU1"},{"key":"product_description","value":"Test Product","description":"The user-facing name of the product.\n\nExamples: \"1 Gallon Milk\" or \"Phone Case\""},{"key":"product_cost","value":"2.23","description":"The cost of the product before any tax or discounts. Must be greater than 0.00."},{"key":"product_currency","value":"","description":"The currency for the product’s price.\n\nExamples: \"USD, GBP, EUR","disabled":true},{"key":"product_commodity_code","value":"","description":"The commodity code for the product.","type":"text","disabled":true},{"key":"product_unit_of_measure","value":"","description":"The unit of measure for the product. Defaults to \"NAR\" (number of articles).\n\nExamples: TDK or MTQ","type":"text","disabled":true},{"key":"product_tax_amount","value":"","description":"The tax that should be added to the product cost. This is a fixed amount, not a percentage.\n\nExample: 1.54","type":"text","disabled":true},{"key":"product_discount_amount","value":"","description":"The discount that will subtracted from the cost of the product.","type":"text","disabled":true},{"key":"product_image_data","value":"","description":"Required if adding an image. The Base64-encoded version of the image for the product. The format must be JPG, PNG, or GIF, and be 2MB or smaller.","type":"text","disabled":true},{"key":"product_image_name","value":"","description":"Required if adding an image. The file name of the image being added with product_image_data.\n\nExamples: product.png, sku-1234.jpg","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"response=3&responsetext=Object not found REFID:1219581876&authcode=&transactionid=&avsresponse=&cvvresponse=&orderid=&type=&response_code=300&cc_exp=&cc_number=&cc_type=&address_1=&city=&first_name=&last_name=&postal_code="}],"_postman_id":"feb1cce0-44ee-4951-b806-59ed41964ad9"},{"name":"Delete Product","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"27315894-55b8-4b59-925b-bba09fc9df0e"}}],"id":"dfee038b-abf0-433b-befe-ab55630b7cc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"products","value":"delete_product","description":"Add a product to the Product Manager.
\nValue: add_product, update_product, delete_product
\n"},{"key":"product_id","value":"123456789","description":"The automatically generated ID for the product. This was returned in the add_product API response, or can be found in the UI under the Product Details page in the Product Manager.
\nExample: 5538585252
\n"}]},"url":"https://secure.nmi.com/api/transact.php","description":"When utilizing the Product Manager, integrators have the ability to delete any product via a Payment API request. When utilizing the API, integrators may submit a delete product request to remove a specified product directly from the Product Manager.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dfee038b-abf0-433b-befe-ab55630b7cc4"}],"id":"3e8b9380-26ce-442e-9029-30b4724b072e","description":"The Gateway's Product Manager is a service within the Gateway which allows users to create, update and delete preset products within the Merchant Gateway Account. This service allows merchant's to to define these products by allowing merchants to set the products SKU, descriptions and pricings.
\n","_postman_id":"3e8b9380-26ce-442e-9029-30b4724b072e"},{"name":"Invoicing","item":[{"name":"Create Invoice","id":"76e20a47-df34-4501-9ea2-17f2f5b51980","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"invoicing","value":"add_invoice","description":"Create a new invoice and email it to the customer.
\n","type":"text"},{"key":"amount","value":"1.00","description":"Total amount to be invoiced. Must be greater than 0.00.
\n","type":"text"},{"key":"email","value":"test@example.com","description":"Billing email address, an invoice will be sent to this address when it is created.
\n","type":"text"},{"key":"payment_terms","value":"","description":"When the invoice should be paid. Values: 'upon_receipt', or integers from 0-999.
\n","type":"text","disabled":true},{"key":"payment_methods_allowed","value":"","description":"What payment methods a customer may use when paying invoice. \nValues: 'cc', 'ck', and 'cs'.
\n","type":"text","disabled":true},{"key":"processor_id","value":"","description":"If using Multiple MIDs, route to this processor (processor_id is obtained under Settings → Transaction Routing in the Control Panel).
\n","type":"text","disabled":true},{"key":"currency","value":"","description":"The transaction currency. \nFormat: ISO 4217
\n","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order description.
\n","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order ID.
\n","type":"text","disabled":true},{"key":"customer_id","value":"","description":"Customer ID.
\n","type":"text","disabled":true},{"key":"customer_tax_id","value":"","description":"Customer Tax ID.
\n","type":"text","disabled":true},{"key":"tax","value":"","description":"Total sales tax amount.
\n","type":"text","disabled":true},{"key":"shipping","value":"","description":"Total shipping amount.
\n","type":"text","disabled":true},{"key":"ponumber","value":"","description":"Original purchase order.
\n","type":"text","disabled":true},{"key":"first_name","value":"","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"company","value":"","description":"Cardholder's company.
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.
\n","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state. \nFormat: CC
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing zip code.
\n","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country. Country codes are as shown in ISO 3166. \nFormat: CC
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.
\n","type":"text","disabled":true},{"key":"fax","value":"","description":"Billing fax number.
\n","type":"text","disabled":true},{"key":"website","value":"","description":"Custom website.
\n","type":"text","disabled":true},{"key":"shipping_firstname","value":"","description":"Shipping first name.
\n","type":"text","disabled":true},{"key":"shipping_lastname","value":"","description":"Shipping last name.
\n","type":"text","disabled":true},{"key":"shipping_company","value":"","description":"Shipping company.
\n","type":"text","disabled":true},{"key":"shipping_address1","value":"","description":"Shipping address.
\n","type":"text","disabled":true},{"key":"shipping_address2","value":"","description":"Shipping address, line 2.
\n","type":"text","disabled":true},{"key":"shipping_city","value":"","description":"Shipping city.
\n","type":"text","disabled":true},{"key":"shipping_state","value":"","description":"Shipping state. \nFormat: CC
\n","type":"text","disabled":true},{"key":"shipping_zip","value":"","description":"Shipping zip code.
\n","type":"text","disabled":true},{"key":"shipping_country","value":"","description":"Shipping country.
\n","type":"text","disabled":true},{"key":"shipping_email","value":"","description":"Shipping email address.
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"You can pass custom information in up to 20 fields. \nFormat: merchant_defined_field_1=Value
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Utilizing the Payment API, integrators may build requests to create and set up invoices. Within these requests integrators will also need to provide the customer's email as upon the creation of the invoice, an email invoice will be sent directly to the email provided within the request.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"76e20a47-df34-4501-9ea2-17f2f5b51980"},{"name":"Update Invoice","id":"d072bf6c-9447-4c3b-a46c-473ef22c9c2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"invoicing","value":"update_invoice","description":"Create a new invoice and email it to the customer.
\n","type":"text"},{"key":"invoice_id","value":"12345","description":"The invoice ID to be updated.
\n","type":"text"},{"key":"amount","value":"1.00","description":"Total amount to be invoiced. Must be greater than 0.00.
\n","type":"text","disabled":true},{"key":"email","value":"test@example.com","description":"Billing email address, an invoice will be sent to this address when it is created.
\n","type":"text","disabled":true},{"key":"payment_terms","value":"","description":"When the invoice should be paid. Values: 'upon_receipt', or integers from 0-999.
\n","type":"text","disabled":true},{"key":"payment_methods_allowed","value":"","description":"What payment methods a customer may use when paying invoice. \nValues: 'cc', 'ck', and 'cs'.
\n","type":"text","disabled":true},{"key":"processor_id","value":"","description":"If using Multiple MIDs, route to this processor (processor_id is obtained under Settings → Transaction Routing in the Control Panel).
\n","type":"text","disabled":true},{"key":"currency","value":"","description":"The transaction currency. \nFormat: ISO 4217
\n","type":"text","disabled":true},{"key":"order_description","value":"","description":"Order description.
\n","type":"text","disabled":true},{"key":"orderid","value":"","description":"Order ID.
\n","type":"text","disabled":true},{"key":"customer_id","value":"","description":"Customer ID.
\n","type":"text","disabled":true},{"key":"customer_tax_id","value":"","description":"Customer Tax ID.
\n","type":"text","disabled":true},{"key":"tax","value":"","description":"Total sales tax amount.
\n","type":"text","disabled":true},{"key":"shipping","value":"","description":"Total shipping amount.
\n","type":"text","disabled":true},{"key":"ponumber","value":"","description":"Original purchase order.
\n","type":"text","disabled":true},{"key":"first_name","value":"","description":"Cardholder's first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Cardholder's last name.
\n","type":"text","disabled":true},{"key":"company","value":"","description":"Cardholder's company.
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Card billing address.
\n","type":"text","disabled":true},{"key":"address2","value":"","description":"Card billing address, line 2.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Card billing city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Card billing state. \nFormat: CC
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Card billing zip code.
\n","type":"text","disabled":true},{"key":"country","value":"","description":"Card billing country. Country codes are as shown in ISO 3166. \nFormat: CC
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Billing phone number.
\n","type":"text","disabled":true},{"key":"fax","value":"","description":"Billing fax number.
\n","type":"text","disabled":true},{"key":"website","value":"","description":"Custom website.
\n","type":"text","disabled":true},{"key":"shipping_firstname","value":"","description":"Shipping first name.
\n","type":"text","disabled":true},{"key":"shipping_lastname","value":"","description":"Shipping last name.
\n","type":"text","disabled":true},{"key":"shipping_company","value":"","description":"Shipping company.
\n","type":"text","disabled":true},{"key":"shipping_address1","value":"","description":"Shipping address.
\n","type":"text","disabled":true},{"key":"shipping_address2","value":"","description":"Shipping address, line 2.
\n","type":"text","disabled":true},{"key":"shipping_city","value":"","description":"Shipping city.
\n","type":"text","disabled":true},{"key":"shipping_state","value":"","description":"Shipping state. \nFormat: CC
\n","type":"text","disabled":true},{"key":"shipping_zip","value":"","description":"Shipping zip code.
\n","type":"text","disabled":true},{"key":"shipping_country","value":"","description":"Shipping country.
\n","type":"text","disabled":true},{"key":"shipping_email","value":"","description":"Shipping email address.
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"You can pass custom information in up to 20 fields. \nFormat: merchant_defined_field_1=Value
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/transact.php","description":"Should any information/details need to be changed for an invoice, integrators may perform an update request via the Payment API. This request will allow integrators to call a specific invoice utilizing the invoice's id in order to change any details of the specified Invoice. (ie Amount, Name, Address, Payment Date...)
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d072bf6c-9447-4c3b-a46c-473ef22c9c2e"},{"name":"Send Invoice","id":"806dd4e2-c317-41b9-98e9-2e36432c7a40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"invoicing","value":"send_invoice","description":"Send an existing invoice to a customer.
\n","type":"text"},{"key":"invoice_id","value":"12345","description":"The invoice ID to be emailed.
\n","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php","description":"When utilizing the Gateway's invoice system integrations will have the ability to resend any invoices. In many cases customer's or merchants may need/want an invoice to be emailed again, utilizing the Payment API integrations may do this by providing an email and an invoice id within the API request.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"806dd4e2-c317-41b9-98e9-2e36432c7a40"},{"name":"Close Invoice","id":"992c3f41-143f-4446-9d46-05915fd88f5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"invoicing","value":"close_invoice","description":"The invoice to be closed.
\n","type":"text"},{"key":"invoice_id","value":"12345","description":"The invoice ID to be closed.
\n","type":"text"}]},"url":"https://secure.nmi.com/api/transact.php","description":"When utilizing Invoicing, integrators have the ability to close any open invoices. Using the Payment API integrators may submit a close invoice request to mark a specified invoice as closed.
\n","urlObject":{"protocol":"https","path":["api","transact.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"992c3f41-143f-4446-9d46-05915fd88f5b"}],"id":"ed9a61e0-1ec0-44c7-b966-2c2598184358","description":"The Gateway's Invoice system is a service within the Gateway which allows users to create, update, send and delete invoices within the Merchant Gateway Account. This service allows merchant's to prepare invoices through the Payment API directly, along with this, the service allows merchants to email invoices directly to customers.
\n","_postman_id":"ed9a61e0-1ec0-44c7-b966-2c2598184358"}],"id":"21a307fe-cea9-4da4-a2ea-429730f263f8","_postman_id":"21a307fe-cea9-4da4-a2ea-429730f263f8","description":""},{"name":"Query API","item":[{"name":"Query Transaction Data","id":"9c17a8c7-9f59-4f94-8c57-733ffd77fc04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"condition","value":"","description":"A combination of values listed below can be passed and should be separated by commas. For example, to retrieve all transactions pending settlement or complete, the following could be used:
\nExample: condition=pendingsettlement,complete\npending: 'Auth Only' transactions that are awaiting capture.\npendingsettlement: This transaction is awaiting settlement.\nin_progress: This Three-Step Redirect API transaction has not yet been completed. The transaction condition will change to 'abandoned' if 24 hours pass with no further action.\nabandoned: This Three-Step Redirect API transaction has not been completed, and has timed out.\nfailed: This transaction has failed.\ncanceled: This transaction has been voided.\ncomplete: This transaction has settled.\nunknown: An unknown error was encountered while processing this transaction.
\n","type":"text","disabled":true},{"key":"transaction_type","value":"","description":"Retrieves only transactions with the specified transaction type. Use one of the following to specify payment type:\ncc: A credit card transaction.\nck: A check transaction.
\n","type":"text","disabled":true},{"key":"action_type","value":"sale","description":"Retrieves only transactions with the specified action types. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with credit or refund actions, use the following:
\nExample: action_type=refund,credit\nsale: Sale transactions.\nrefund: Refund transactions.\ncredit: Credit transactions.\nauth: 'Auth Only' transactions.\ncapture: Captured transactions.\nvoid: Voided transactions.\nreturn: Electronic Check (ACH) transactions that have returned, as well as credit card chargebacks.
\n","type":"text"},{"key":"source","value":"api","description":"Retrieves only transactions with a particular 'transaction source'. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with api or recurring actions, use the following:
\nExample: source=api,recurring\napi: API transactions.\nbatch_upload: Batch Upload transactions.\nmobile: Mobile (iProcess) transactions.\nquickclick: QuickClick transactions.\nquickbooks: QuickBooks SyncPay transactions.\nrecurring: Recurring transactions when using Recurring module.\nswipe: Swipe transactions.\nvirtual_terminal: Virtual Terminal transactions.\ninternal: Internal transactions. Typically indicates settlement
\n","type":"text"},{"key":"start_date","value":"20230608","description":"Only transactions that have been modified on or after this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.
\nFormat: YYYYMMDDhhmmss
\n","type":"text"},{"key":"end_date","value":"20230615","description":"Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.
\nFormat: YYYYMMDDhhmmss
\n","type":"text"},{"key":"transaction_id","value":"1234567890","description":"Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on. Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions associated with it.
\n","type":"text"},{"key":"subscription_id","value":"","description":"Set a specific subscription record or comma separated list of records. Using this with a transaction search will return all transactions associated with this subscription. This will return this subscription's payment/plan information when used with report_type=recurring.
\n","type":"text","disabled":true},{"key":"invoice_id","value":"","description":"Set a specific Invoice ID. Should only be used when report_type=invoicing.
\n","type":"text","disabled":true},{"key":"order_id","value":"","description":"Retrieves only transactions with the specified Order ID.
\n","type":"text","disabled":true},{"key":"first_name","value":"","description":"Retrieves only transactions with the specified first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Retrieves only transactions with the specified last name.
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Retrieves only transactions with the specified specified address.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Retrieves only transactions with the specified city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Retrieves only transactions with the specified state.
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Retrieves only transactions with the specified zip/postal code.
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Retrieves only transactions with the specified phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Retrieves only transactions with the specified billing email address.
\n","type":"text","disabled":true},{"key":"cc_number","value":"","description":"Retrieves only transactions with the specified credit card number. You can use either the full number or the last 4 digits of the credit card number.
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Retrieves only transactions with the specified merchant defined field value.\nReplace the '#' with a field number (1-20) (Example: merchant_defined_field_12=value)
\n","type":"text","disabled":true},{"key":"report_type","value":"","description":"Allows Customer Vault information or a html receipt to be returned. If you would like to query the Customer Vault to view what customer information is stored in the Customer Vault, you must set the customer_vault variable.\nIf you omit the customer_vault_id, the system will return all customers that are stored in the vault. If you include a customer_vault_id, it will return the customer record associated with that ID.\nExample: report_type=customer_vault&customer_vault _id=123456789\nreceipt: Will return an html receipt for a specified transaction id.\ncustomer_vault: Set the Query API to return Customer Vault data.\nrecurring: Set the Query API to return subscription data.\nrecurring_plans: Set the Query API to return plan data.\ninvoicing: Set the Query API to return invoicing data.\ngateway_processors: Will return Processor details a user has permissions for. Specify a \"user\" by querying with that security key.\naccount_updater: Will return Customer Vault data that has been updated using the Account Updater service.\ntest_mode_status: Will return whether the account has test mode active or inactive.
\n","type":"text","disabled":true},{"key":"customer_vault_id","value":"","description":"Set a specific Customer Vault record. Should only be used when report_type=customer_vault.
\n","type":"text","disabled":true},{"key":"date_search","value":"","description":"Allows Customer Vault information to be returned based on the 'created' or 'updated' date. If you would like to query the Customer Vault to view when customer information was created or updated, you must set the report_type variable with the customer_vault value.
\nIf you omit the report_type variable, the system will ignore the date_search variable.
\nExample:\nreport_type=customer_vault&date_search=created,updated&start_date=20170101000000&end_date=20201231232359\ncreated: Will return Customer Vault data created during a specified date range.\nupdated: Will return Customer Vault data updated during a specified date range.
\n","type":"text","disabled":true},{"key":"result_limit","value":"","description":"Determines the maximum number of results that may return for the current query.
\n","type":"text","disabled":true},{"key":"page_number","value":"","description":"Determines which \"page\" of results are returned. For example, \"result_limit=100&page_number=0\" will return the first 100 results. Using \"page_number=1\" will return the next 100 results. Default is \"0\".
\n","type":"text","disabled":true},{"key":"result_order","value":"","description":"Determines order of in which results are returned. Default value is \"standard\".\nstandard: Returns the results from oldest to newest.\nreverse: Returns the results from newest to oldest.
\n","type":"text","disabled":true},{"key":"invoice_status","value":"","description":"Specify a comma separated list of what invoice statuses will return when using an \"invoicing\" report type.
\nExample: invoice_status=open,closed,paid\nopen: Open Invoices\npaid: Paid Invoices\nclosed: Closed Invoices\npast_due: Past Due Invoices
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/query.php","description":"When utilizing the Query API integrators have the ability to pull transactional data for any transactions which they have completed within their Merchant Gateway account. Integrations may pull this data by specifying a transaction id or by setting search date parameters to pull a list of transactions which could have occurred within the specified date range.
\n","urlObject":{"protocol":"https","path":["api","query.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"55dc66ff-0167-4377-8a50-d0a24565c755","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"condition","value":"","description":"A combination of values listed below can be passed and should be separated by commas. For example, to retrieve all transactions pending settlement or complete, the following could be used:\n\nExample: condition=pendingsettlement,complete\npending: 'Auth Only' transactions that are awaiting capture.\npendingsettlement: This transaction is awaiting settlement.\nin_progress: This Three-Step Redirect API transaction has not yet been completed. The transaction condition will change to 'abandoned' if 24 hours pass with no further action.\nabandoned: This Three-Step Redirect API transaction has not been completed, and has timed out.\nfailed: This transaction has failed.\ncanceled: This transaction has been voided.\ncomplete: This transaction has settled.\nunknown: An unknown error was encountered while processing this transaction.","type":"text","disabled":true},{"key":"transaction_type","value":"","description":"Retrieves only transactions with the specified transaction type. Use one of the following to specify payment type:\ncc: A credit card transaction.\nck: A check transaction.","type":"text","disabled":true},{"key":"action_type","value":"sale","description":"Retrieves only transactions with the specified action types. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with credit or refund actions, use the following:\n\nExample: action_type=refund,credit\nsale: Sale transactions.\nrefund: Refund transactions.\ncredit: Credit transactions.\nauth: 'Auth Only' transactions.\ncapture: Captured transactions.\nvoid: Voided transactions.\nreturn: Electronic Check (ACH) transactions that have returned, as well as credit card chargebacks.","type":"text"},{"key":"source","value":"api","description":"Retrieves only transactions with a particular 'transaction source'. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with api or recurring actions, use the following:\n\nExample: source=api,recurring\napi: API transactions.\nbatch_upload: Batch Upload transactions.\nmobile: Mobile (iProcess) transactions.\nquickclick: QuickClick transactions.\nquickbooks: QuickBooks SyncPay transactions.\nrecurring: Recurring transactions when using Recurring module.\nswipe: Swipe transactions.\nvirtual_terminal: Virtual Terminal transactions.\ninternal: Internal transactions. Typically indicates settlement","type":"text"},{"key":"start_date","value":"20230608","description":"Only transactions that have been modified on or after this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.\n\nFormat: YYYYMMDDhhmmss","type":"text"},{"key":"end_date","value":"20230615","description":"Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.\n\nFormat: YYYYMMDDhhmmss","type":"text"},{"key":"transaction_id","value":"1234567890","description":"Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on. Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions associated with it.","type":"text"},{"key":"subscription_id","value":"","description":"Set a specific subscription record or comma separated list of records. Using this with a transaction search will return all transactions associated with this subscription. This will return this subscription's payment/plan information when used with report_type=recurring.","type":"text","disabled":true},{"key":"invoice_id","value":"","description":"Set a specific Invoice ID. Should only be used when report_type=invoicing.","type":"text","disabled":true},{"key":"order_id","value":"","description":"Retrieves only transactions with the specified Order ID.","type":"text","disabled":true},{"key":"first_name","value":"","description":"Retrieves only transactions with the specified first name.","type":"text","disabled":true},{"key":"last_name","value":"","description":"Retrieves only transactions with the specified last name.","type":"text","disabled":true},{"key":"address1","value":"","description":"Retrieves only transactions with the specified specified address.","type":"text","disabled":true},{"key":"city","value":"","description":"Retrieves only transactions with the specified city.","type":"text","disabled":true},{"key":"state","value":"","description":"Retrieves only transactions with the specified state.","type":"text","disabled":true},{"key":"zip","value":"","description":"Retrieves only transactions with the specified zip/postal code.","type":"text","disabled":true},{"key":"phone","value":"","description":"Retrieves only transactions with the specified phone number.","type":"text","disabled":true},{"key":"email","value":"","description":"Retrieves only transactions with the specified billing email address.","type":"text","disabled":true},{"key":"cc_number","value":"","description":"Retrieves only transactions with the specified credit card number. You can use either the full number or the last 4 digits of the credit card number.","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Retrieves only transactions with the specified merchant defined field value.\nReplace the '#' with a field number (1-20) (Example: merchant_defined_field_12=value)","type":"text","disabled":true},{"key":"report_type","value":"","description":"Allows Customer Vault information or a html receipt to be returned. If you would like to query the Customer Vault to view what customer information is stored in the Customer Vault, you must set the customer_vault variable.\nIf you omit the customer_vault_id, the system will return all customers that are stored in the vault. If you include a customer_vault_id, it will return the customer record associated with that ID.\nExample: report_type=customer_vault&customer_vault _id=123456789\nreceipt: Will return an html receipt for a specified transaction id.\ncustomer_vault: Set the Query API to return Customer Vault data.\nrecurring: Set the Query API to return subscription data.\nrecurring_plans: Set the Query API to return plan data.\ninvoicing: Set the Query API to return invoicing data.\ngateway_processors: Will return Processor details a user has permissions for. Specify a \"user\" by querying with that security key.\naccount_updater: Will return Customer Vault data that has been updated using the Account Updater service.\ntest_mode_status: Will return whether the account has test mode active or inactive.","type":"text","disabled":true},{"key":"customer_vault_id","value":"","description":"Set a specific Customer Vault record. Should only be used when report_type=customer_vault.","type":"text","disabled":true},{"key":"date_search","value":"","description":"Allows Customer Vault information to be returned based on the 'created' or 'updated' date. If you would like to query the Customer Vault to view when customer information was created or updated, you must set the report_type variable with the customer_vault value.\n\nIf you omit the report_type variable, the system will ignore the date_search variable.\n\nExample:\nreport_type=customer_vault&date_search=created,updated&start_date=20170101000000&end_date=20201231232359\ncreated: Will return Customer Vault data created during a specified date range.\nupdated: Will return Customer Vault data updated during a specified date range.","type":"text","disabled":true},{"key":"result_limit","value":"","description":"Determines the maximum number of results that may return for the current query.","type":"text","disabled":true},{"key":"page_number","value":"","description":"Determines which \"page\" of results are returned. For example, \"result_limit=100&page_number=0\" will return the first 100 results. Using \"page_number=1\" will return the next 100 results. Default is \"0\".","type":"text","disabled":true},{"key":"result_order","value":"","description":"Determines order of in which results are returned. Default value is \"standard\".\nstandard: Returns the results from oldest to newest.\nreverse: Returns the results from newest to oldest.","type":"text","disabled":true},{"key":"invoice_status","value":"","description":"Specify a comma separated list of what invoice statuses will return when using an \"invoicing\" report type.\n\nExample: invoice_status=open,closed,paid\nopen: Open Invoices\npaid: Paid Invoices\nclosed: Closed Invoices\npast_due: Past Due Invoices","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/query.php"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nRetrieves only transactions with a particular 'transaction source'. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with api or recurring actions, use the following:
\nExample: source=api,recurring\napi: API transactions.\nbatch_upload: Batch Upload transactions.\nmobile: Mobile (iProcess) transactions.\nquickclick: QuickClick transactions.\nquickbooks: QuickBooks SyncPay transactions.\nrecurring: Recurring transactions when using Recurring module.\nswipe: Swipe transactions.\nvirtual_terminal: Virtual Terminal transactions.\ninternal: Internal transactions. Typically indicates settlement
\n","type":"text","disabled":true},{"key":"report_type","value":"recurring","description":"Allows Customer Vault information or a html receipt to be returned. If you would like to query the Customer Vault to view what customer information is stored in the Customer Vault, you must set the customer_vault variable.\nIf you omit the customer_vault_id, the system will return all customers that are stored in the vault. If you include a customer_vault_id, it will return the customer record associated with that ID.\nExample: report_type=customer_vault&customer_vault _id=123456789\nreceipt: Will return an html receipt for a specified transaction id.\ncustomer_vault: Set the Query API to return Customer Vault data.\nrecurring: Set the Query API to return subscription data.\nrecurring_plans: Set the Query API to return plan data.\ninvoicing: Set the Query API to return invoicing data.\ngateway_processors: Will return Processor details a user has permissions for. Specify a \"user\" by querying with that security key.\naccount_updater: Will return Customer Vault data that has been updated using the Account Updater service.\ntest_mode_status: Will return whether the account has test mode active or inactive.
\n","type":"text"},{"key":"subscription_id","value":"1234567890","description":"Set a specific subscription record or comma separated list of records. Using this with a transaction search will return all transactions associated with this subscription. This will return this subscription's payment/plan information when used with report_type=recurring.
\n","type":"text"},{"key":"condition","value":"","description":"A combination of values listed below can be passed and should be separated by commas. For example, to retrieve all transactions pending settlement or complete, the following could be used:
\nExample: condition=pendingsettlement,complete\npending: 'Auth Only' transactions that are awaiting capture.\npendingsettlement: This transaction is awaiting settlement.\nin_progress: This Three-Step Redirect API transaction has not yet been completed. The transaction condition will change to 'abandoned' if 24 hours pass with no further action.\nabandoned: This Three-Step Redirect API transaction has not been completed, and has timed out.\nfailed: This transaction has failed.\ncanceled: This transaction has been voided.\ncomplete: This transaction has settled.\nunknown: An unknown error was encountered while processing this transaction.
\n","type":"text","disabled":true},{"key":"transaction_type","value":"","description":"Retrieves only transactions with the specified transaction type. Use one of the following to specify payment type:\ncc: A credit card transaction.\nck: A check transaction.
\n","type":"text","disabled":true},{"key":"action_type","value":"","description":"Retrieves only transactions with the specified action types. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with credit or refund actions, use the following:
\nExample: action_type=refund,credit\nsale: Sale transactions.\nrefund: Refund transactions.\ncredit: Credit transactions.\nauth: 'Auth Only' transactions.\ncapture: Captured transactions.\nvoid: Voided transactions.\nreturn: Electronic Check (ACH) transactions that have returned, as well as credit card chargebacks.
\n","type":"text","disabled":true},{"key":"start_date","value":"","description":"Only transactions that have been modified on or after this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.
\nFormat: YYYYMMDDhhmmss
\n","type":"text","disabled":true},{"key":"end_date","value":"","description":"Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.
\nFormat: YYYYMMDDhhmmss
\n","type":"text","disabled":true},{"key":"transaction_id","value":"","description":"Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on. Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions associated with it.
\n","type":"text","disabled":true},{"key":"invoice_id","value":"","description":"Set a specific Invoice ID. Should only be used when report_type=invoicing.
\n","type":"text","disabled":true},{"key":"order_id","value":"","description":"Retrieves only transactions with the specified Order ID.
\n","type":"text","disabled":true},{"key":"first_name","value":"","description":"Retrieves only transactions with the specified first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Retrieves only transactions with the specified last name.
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Retrieves only transactions with the specified specified address.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Retrieves only transactions with the specified city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Retrieves only transactions with the specified state.
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Retrieves only transactions with the specified zip/postal code.
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Retrieves only transactions with the specified phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Retrieves only transactions with the specified billing email address.
\n","type":"text","disabled":true},{"key":"cc_number","value":"","description":"Retrieves only transactions with the specified credit card number. You can use either the full number or the last 4 digits of the credit card number.
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Retrieves only transactions with the specified merchant defined field value.\nReplace the '#' with a field number (1-20) (Example: merchant_defined_field_12=value)
\n","type":"text","disabled":true},{"key":"customer_vault_id","value":"","description":"Set a specific Customer Vault record. Should only be used when report_type=customer_vault.
\n","type":"text","disabled":true},{"key":"date_search","value":"","description":"Allows Customer Vault information to be returned based on the 'created' or 'updated' date. If you would like to query the Customer Vault to view when customer information was created or updated, you must set the report_type variable with the customer_vault value.
\nIf you omit the report_type variable, the system will ignore the date_search variable.
\nExample:\nreport_type=customer_vault&date_search=created,updated&start_date=20170101000000&end_date=20201231232359\ncreated: Will return Customer Vault data created during a specified date range.\nupdated: Will return Customer Vault data updated during a specified date range.
\n","type":"text","disabled":true},{"key":"result_limit","value":"","description":"Determines the maximum number of results that may return for the current query.
\n","type":"text","disabled":true},{"key":"page_number","value":"","description":"Determines which \"page\" of results are returned. For example, \"result_limit=100&page_number=0\" will return the first 100 results. Using \"page_number=1\" will return the next 100 results. Default is \"0\".
\n","type":"text","disabled":true},{"key":"result_order","value":"","description":"Determines order of in which results are returned. Default value is \"standard\".\nstandard: Returns the results from oldest to newest.\nreverse: Returns the results from newest to oldest.
\n","type":"text","disabled":true},{"key":"invoice_status","value":"","description":"Specify a comma separated list of what invoice statuses will return when using an \"invoicing\" report type.
\nExample: invoice_status=open,closed,paid\nopen: Open Invoices\npaid: Paid Invoices\nclosed: Closed Invoices\npast_due: Past Due Invoices
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/query.php","description":"When utilizing the Query API, integrators have the ability to pull subscription data for any active/paused subscriptions that have been created within their Merchant Gateway Account. Integrations may pull this data by specifying a subscription id or by providing additional data parameters to specify which subscriptions' data the Query API should return.
\n","urlObject":{"protocol":"https","path":["api","query.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"fdfdb9f5-3714-4472-b0cc-9bf3dcf2a3aa","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"report_type","value":"recurring","description":"Allows Customer Vault information or a html receipt to be returned. If you would like to query the Customer Vault to view what customer information is stored in the Customer Vault, you must set the customer_vault variable.\nIf you omit the customer_vault_id, the system will return all customers that are stored in the vault. If you include a customer_vault_id, it will return the customer record associated with that ID.\nExample: report_type=customer_vault&customer_vault _id=123456789\nreceipt: Will return an html receipt for a specified transaction id.\ncustomer_vault: Set the Query API to return Customer Vault data.\nrecurring: Set the Query API to return subscription data.\nrecurring_plans: Set the Query API to return plan data.\ninvoicing: Set the Query API to return invoicing data.\ngateway_processors: Will return Processor details a user has permissions for. Specify a \"user\" by querying with that security key.\naccount_updater: Will return Customer Vault data that has been updated using the Account Updater service.\ntest_mode_status: Will return whether the account has test mode active or inactive.","type":"text"},{"key":"source","value":"","description":"Retrieves only transactions with a particular 'transaction source'. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with api or recurring actions, use the following:\n\nExample: source=api,recurring\napi: API transactions.\nbatch_upload: Batch Upload transactions.\nmobile: Mobile (iProcess) transactions.\nquickclick: QuickClick transactions.\nquickbooks: QuickBooks SyncPay transactions.\nrecurring: Recurring transactions when using Recurring module.\nswipe: Swipe transactions.\nvirtual_terminal: Virtual Terminal transactions.\ninternal: Internal transactions. Typically indicates settlement","type":"text","disabled":true},{"key":"subscription_id","value":"1234567890","description":"Set a specific subscription record or comma separated list of records. Using this with a transaction search will return all transactions associated with this subscription. This will return this subscription's payment/plan information when used with report_type=recurring.","type":"text"},{"key":"condition","value":"","description":"A combination of values listed below can be passed and should be separated by commas. For example, to retrieve all transactions pending settlement or complete, the following could be used:\n\nExample: condition=pendingsettlement,complete\npending: 'Auth Only' transactions that are awaiting capture.\npendingsettlement: This transaction is awaiting settlement.\nin_progress: This Three-Step Redirect API transaction has not yet been completed. The transaction condition will change to 'abandoned' if 24 hours pass with no further action.\nabandoned: This Three-Step Redirect API transaction has not been completed, and has timed out.\nfailed: This transaction has failed.\ncanceled: This transaction has been voided.\ncomplete: This transaction has settled.\nunknown: An unknown error was encountered while processing this transaction.","type":"text","disabled":true},{"key":"transaction_type","value":"","description":"Retrieves only transactions with the specified transaction type. Use one of the following to specify payment type:\ncc: A credit card transaction.\nck: A check transaction.","type":"text","disabled":true},{"key":"action_type","value":"","description":"Retrieves only transactions with the specified action types. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with credit or refund actions, use the following:\n\nExample: action_type=refund,credit\nsale: Sale transactions.\nrefund: Refund transactions.\ncredit: Credit transactions.\nauth: 'Auth Only' transactions.\ncapture: Captured transactions.\nvoid: Voided transactions.\nreturn: Electronic Check (ACH) transactions that have returned, as well as credit card chargebacks.","type":"text","disabled":true},{"key":"start_date","value":"","description":"Only transactions that have been modified on or after this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.\n\nFormat: YYYYMMDDhhmmss","type":"text","disabled":true},{"key":"end_date","value":"","description":"Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.\n\nFormat: YYYYMMDDhhmmss","type":"text","disabled":true},{"key":"transaction_id","value":"","description":"Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on. Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions associated with it.","type":"text","disabled":true},{"key":"invoice_id","value":"","description":"Set a specific Invoice ID. Should only be used when report_type=invoicing.","type":"text","disabled":true},{"key":"order_id","value":"","description":"Retrieves only transactions with the specified Order ID.","type":"text","disabled":true},{"key":"first_name","value":"","description":"Retrieves only transactions with the specified first name.","type":"text","disabled":true},{"key":"last_name","value":"","description":"Retrieves only transactions with the specified last name.","type":"text","disabled":true},{"key":"address1","value":"","description":"Retrieves only transactions with the specified specified address.","type":"text","disabled":true},{"key":"city","value":"","description":"Retrieves only transactions with the specified city.","type":"text","disabled":true},{"key":"state","value":"","description":"Retrieves only transactions with the specified state.","type":"text","disabled":true},{"key":"zip","value":"","description":"Retrieves only transactions with the specified zip/postal code.","type":"text","disabled":true},{"key":"phone","value":"","description":"Retrieves only transactions with the specified phone number.","type":"text","disabled":true},{"key":"email","value":"","description":"Retrieves only transactions with the specified billing email address.","type":"text","disabled":true},{"key":"cc_number","value":"","description":"Retrieves only transactions with the specified credit card number. You can use either the full number or the last 4 digits of the credit card number.","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Retrieves only transactions with the specified merchant defined field value.\nReplace the '#' with a field number (1-20) (Example: merchant_defined_field_12=value)","type":"text","disabled":true},{"key":"customer_vault_id","value":"","description":"Set a specific Customer Vault record. Should only be used when report_type=customer_vault.","type":"text","disabled":true},{"key":"date_search","value":"","description":"Allows Customer Vault information to be returned based on the 'created' or 'updated' date. If you would like to query the Customer Vault to view when customer information was created or updated, you must set the report_type variable with the customer_vault value.\n\nIf you omit the report_type variable, the system will ignore the date_search variable.\n\nExample:\nreport_type=customer_vault&date_search=created,updated&start_date=20170101000000&end_date=20201231232359\ncreated: Will return Customer Vault data created during a specified date range.\nupdated: Will return Customer Vault data updated during a specified date range.","type":"text","disabled":true},{"key":"result_limit","value":"","description":"Determines the maximum number of results that may return for the current query.","type":"text","disabled":true},{"key":"page_number","value":"","description":"Determines which \"page\" of results are returned. For example, \"result_limit=100&page_number=0\" will return the first 100 results. Using \"page_number=1\" will return the next 100 results. Default is \"0\".","type":"text","disabled":true},{"key":"result_order","value":"","description":"Determines order of in which results are returned. Default value is \"standard\".\nstandard: Returns the results from oldest to newest.\nreverse: Returns the results from newest to oldest.","type":"text","disabled":true},{"key":"invoice_status","value":"","description":"Specify a comma separated list of what invoice statuses will return when using an \"invoicing\" report type.\n\nExample: invoice_status=open,closed,paid\nopen: Open Invoices\npaid: Paid Invoices\nclosed: Closed Invoices\npast_due: Past Due Invoices","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/query.php"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nSet a specific Customer Vault record. Should only be used when report_type=customer_vault.
\n","type":"text"},{"key":"ver","value":"2","description":"Undocumented parameter used to request all billing records within a specified Customer Vault Record.
\n","type":"text"},{"key":"source","value":"","description":"Retrieves only transactions with a particular 'transaction source'. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with api or recurring actions, use the following:
\nExample: source=api,recurring\napi: API transactions.\nbatch_upload: Batch Upload transactions.\nmobile: Mobile (iProcess) transactions.\nquickclick: QuickClick transactions.\nquickbooks: QuickBooks SyncPay transactions.\nrecurring: Recurring transactions when using Recurring module.\nswipe: Swipe transactions.\nvirtual_terminal: Virtual Terminal transactions.\ninternal: Internal transactions. Typically indicates settlement
\n","type":"text","disabled":true},{"key":"subscription_id","value":"","description":"Set a specific subscription record or comma separated list of records. Using this with a transaction search will return all transactions associated with this subscription. This will return this subscription's payment/plan information when used with report_type=recurring.
\n","type":"text","disabled":true},{"key":"condition","value":"","description":"A combination of values listed below can be passed and should be separated by commas. For example, to retrieve all transactions pending settlement or complete, the following could be used:
\nExample: condition=pendingsettlement,complete\npending: 'Auth Only' transactions that are awaiting capture.\npendingsettlement: This transaction is awaiting settlement.\nin_progress: This Three-Step Redirect API transaction has not yet been completed. The transaction condition will change to 'abandoned' if 24 hours pass with no further action.\nabandoned: This Three-Step Redirect API transaction has not been completed, and has timed out.\nfailed: This transaction has failed.\ncanceled: This transaction has been voided.\ncomplete: This transaction has settled.\nunknown: An unknown error was encountered while processing this transaction.
\n","type":"text","disabled":true},{"key":"transaction_type","value":"","description":"Retrieves only transactions with the specified transaction type. Use one of the following to specify payment type:\ncc: A credit card transaction.\nck: A check transaction.
\n","type":"text","disabled":true},{"key":"action_type","value":"","description":"Retrieves only transactions with the specified action types. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with credit or refund actions, use the following:
\nExample: action_type=refund,credit\nsale: Sale transactions.\nrefund: Refund transactions.\ncredit: Credit transactions.\nauth: 'Auth Only' transactions.\ncapture: Captured transactions.\nvoid: Voided transactions.\nreturn: Electronic Check (ACH) transactions that have returned, as well as credit card chargebacks.
\n","type":"text","disabled":true},{"key":"start_date","value":"","description":"Only transactions that have been modified on or after this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.
\nFormat: YYYYMMDDhhmmss
\n","type":"text","disabled":true},{"key":"end_date","value":"","description":"Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.
\nFormat: YYYYMMDDhhmmss
\n","type":"text","disabled":true},{"key":"transaction_id","value":"","description":"Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on. Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions associated with it.
\n","type":"text","disabled":true},{"key":"invoice_id","value":"","description":"Set a specific Invoice ID. Should only be used when report_type=invoicing.
\n","type":"text","disabled":true},{"key":"order_id","value":"","description":"Retrieves only transactions with the specified Order ID.
\n","type":"text","disabled":true},{"key":"first_name","value":"","description":"Retrieves only transactions with the specified first name.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"Retrieves only transactions with the specified last name.
\n","type":"text","disabled":true},{"key":"address1","value":"","description":"Retrieves only transactions with the specified specified address.
\n","type":"text","disabled":true},{"key":"city","value":"","description":"Retrieves only transactions with the specified city.
\n","type":"text","disabled":true},{"key":"state","value":"","description":"Retrieves only transactions with the specified state.
\n","type":"text","disabled":true},{"key":"zip","value":"","description":"Retrieves only transactions with the specified zip/postal code.
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"Retrieves only transactions with the specified phone number.
\n","type":"text","disabled":true},{"key":"email","value":"","description":"Retrieves only transactions with the specified billing email address.
\n","type":"text","disabled":true},{"key":"cc_number","value":"","description":"Retrieves only transactions with the specified credit card number. You can use either the full number or the last 4 digits of the credit card number.
\n","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Retrieves only transactions with the specified merchant defined field value.\nReplace the '#' with a field number (1-20) (Example: merchant_defined_field_12=value)
\n","type":"text","disabled":true},{"key":"report_type","value":"","description":"Allows Customer Vault information or a html receipt to be returned. If you would like to query the Customer Vault to view what customer information is stored in the Customer Vault, you must set the customer_vault variable.\nIf you omit the customer_vault_id, the system will return all customers that are stored in the vault. If you include a customer_vault_id, it will return the customer record associated with that ID.\nExample: report_type=customer_vault&customer_vault _id=123456789\nreceipt: Will return an html receipt for a specified transaction id.\ncustomer_vault: Set the Query API to return Customer Vault data.\nrecurring: Set the Query API to return subscription data.\nrecurring_plans: Set the Query API to return plan data.\ninvoicing: Set the Query API to return invoicing data.\ngateway_processors: Will return Processor details a user has permissions for. Specify a \"user\" by querying with that security key.\naccount_updater: Will return Customer Vault data that has been updated using the Account Updater service.\ntest_mode_status: Will return whether the account has test mode active or inactive.
\n","type":"text","disabled":true},{"key":"date_search","value":"","description":"Allows Customer Vault information to be returned based on the 'created' or 'updated' date. If you would like to query the Customer Vault to view when customer information was created or updated, you must set the report_type variable with the customer_vault value.
\nIf you omit the report_type variable, the system will ignore the date_search variable.
\nExample:\nreport_type=customer_vault&date_search=created,updated&start_date=20170101000000&end_date=20201231232359\ncreated: Will return Customer Vault data created during a specified date range.\nupdated: Will return Customer Vault data updated during a specified date range.
\n","type":"text","disabled":true},{"key":"result_limit","value":"","description":"Determines the maximum number of results that may return for the current query.
\n","type":"text","disabled":true},{"key":"page_number","value":"","description":"Determines which \"page\" of results are returned. For example, \"result_limit=100&page_number=0\" will return the first 100 results. Using \"page_number=1\" will return the next 100 results. Default is \"0\".
\n","type":"text","disabled":true},{"key":"result_order","value":"","description":"Determines order of in which results are returned. Default value is \"standard\".\nstandard: Returns the results from oldest to newest.\nreverse: Returns the results from newest to oldest.
\n","type":"text","disabled":true},{"key":"invoice_status","value":"","description":"Specify a comma separated list of what invoice statuses will return when using an \"invoicing\" report type.
\nExample: invoice_status=open,closed,paid\nopen: Open Invoices\npaid: Paid Invoices\nclosed: Closed Invoices\npast_due: Past Due Invoices
\n","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/query.php","description":"When utilizing the Query API, integrators have the ability to request data on any Customer Vault Record stored within their Merchant Gateway Account. The Query APi may pull a specified Customer Vault record or return a list of all Vault Records stored within the merchant's Gateway Account.
\n","urlObject":{"protocol":"https","path":["api","query.php"],"host":["secure","nmi","com"],"query":[],"variable":[]}},"response":[{"id":"3b60e1b3-f077-45a2-9c77-2a9869bd01eb","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"report_type","value":"customer_vault","description":"Allows Customer Vault information or a html receipt to be returned. If you would like to query the Customer Vault to view what customer information is stored in the Customer Vault, you must set the customer_vault variable.\nIf you omit the customer_vault_id, the system will return all customers that are stored in the vault. If you include a customer_vault_id, it will return the customer record associated with that ID.\nExample: report_type=customer_vault&customer_vault _id=123456789\nreceipt: Will return an html receipt for a specified transaction id.\ncustomer_vault: Set the Query API to return Customer Vault data.\nrecurring: Set the Query API to return subscription data.\nrecurring_plans: Set the Query API to return plan data.\ninvoicing: Set the Query API to return invoicing data.\ngateway_processors: Will return Processor details a user has permissions for. Specify a \"user\" by querying with that security key.\naccount_updater: Will return Customer Vault data that has been updated using the Account Updater service.\ntest_mode_status: Will return whether the account has test mode active or inactive.","type":"text"},{"key":"customer_vault_id","value":"TestCustomer12345","description":"Set a specific Customer Vault record. Should only be used when report_type=customer_vault.","type":"text"},{"key":"ver","value":"2","description":"Undocumented parameter used to request all billing records within a specified Customer Vault Record.","type":"text","disabled":true},{"key":"source","value":"","description":"Retrieves only transactions with a particular 'transaction source'. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with api or recurring actions, use the following:\n\nExample: source=api,recurring\napi: API transactions.\nbatch_upload: Batch Upload transactions.\nmobile: Mobile (iProcess) transactions.\nquickclick: QuickClick transactions.\nquickbooks: QuickBooks SyncPay transactions.\nrecurring: Recurring transactions when using Recurring module.\nswipe: Swipe transactions.\nvirtual_terminal: Virtual Terminal transactions.\ninternal: Internal transactions. Typically indicates settlement","type":"text","disabled":true},{"key":"subscription_id","value":"","description":"Set a specific subscription record or comma separated list of records. Using this with a transaction search will return all transactions associated with this subscription. This will return this subscription's payment/plan information when used with report_type=recurring.","type":"text","disabled":true},{"key":"condition","value":"","description":"A combination of values listed below can be passed and should be separated by commas. For example, to retrieve all transactions pending settlement or complete, the following could be used:\n\nExample: condition=pendingsettlement,complete\npending: 'Auth Only' transactions that are awaiting capture.\npendingsettlement: This transaction is awaiting settlement.\nin_progress: This Three-Step Redirect API transaction has not yet been completed. The transaction condition will change to 'abandoned' if 24 hours pass with no further action.\nabandoned: This Three-Step Redirect API transaction has not been completed, and has timed out.\nfailed: This transaction has failed.\ncanceled: This transaction has been voided.\ncomplete: This transaction has settled.\nunknown: An unknown error was encountered while processing this transaction.","type":"text","disabled":true},{"key":"transaction_type","value":"","description":"Retrieves only transactions with the specified transaction type. Use one of the following to specify payment type:\ncc: A credit card transaction.\nck: A check transaction.","type":"text","disabled":true},{"key":"action_type","value":"","description":"Retrieves only transactions with the specified action types. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with credit or refund actions, use the following:\n\nExample: action_type=refund,credit\nsale: Sale transactions.\nrefund: Refund transactions.\ncredit: Credit transactions.\nauth: 'Auth Only' transactions.\ncapture: Captured transactions.\nvoid: Voided transactions.\nreturn: Electronic Check (ACH) transactions that have returned, as well as credit card chargebacks.","type":"text","disabled":true},{"key":"start_date","value":"","description":"Only transactions that have been modified on or after this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.\n\nFormat: YYYYMMDDhhmmss","type":"text","disabled":true},{"key":"end_date","value":"","description":"Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated.\n\nFormat: YYYYMMDDhhmmss","type":"text","disabled":true},{"key":"transaction_id","value":"","description":"Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on. Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions associated with it.","type":"text","disabled":true},{"key":"invoice_id","value":"","description":"Set a specific Invoice ID. Should only be used when report_type=invoicing.","type":"text","disabled":true},{"key":"order_id","value":"","description":"Retrieves only transactions with the specified Order ID.","type":"text","disabled":true},{"key":"first_name","value":"","description":"Retrieves only transactions with the specified first name.","type":"text","disabled":true},{"key":"last_name","value":"","description":"Retrieves only transactions with the specified last name.","type":"text","disabled":true},{"key":"address1","value":"","description":"Retrieves only transactions with the specified specified address.","type":"text","disabled":true},{"key":"city","value":"","description":"Retrieves only transactions with the specified city.","type":"text","disabled":true},{"key":"state","value":"","description":"Retrieves only transactions with the specified state.","type":"text","disabled":true},{"key":"zip","value":"","description":"Retrieves only transactions with the specified zip/postal code.","type":"text","disabled":true},{"key":"phone","value":"","description":"Retrieves only transactions with the specified phone number.","type":"text","disabled":true},{"key":"email","value":"","description":"Retrieves only transactions with the specified billing email address.","type":"text","disabled":true},{"key":"cc_number","value":"","description":"Retrieves only transactions with the specified credit card number. You can use either the full number or the last 4 digits of the credit card number.","type":"text","disabled":true},{"key":"merchant_defined_field_#","value":"","description":"Retrieves only transactions with the specified merchant defined field value.\nReplace the '#' with a field number (1-20) (Example: merchant_defined_field_12=value)","type":"text","disabled":true},{"key":"date_search","value":"","description":"Allows Customer Vault information to be returned based on the 'created' or 'updated' date. If you would like to query the Customer Vault to view when customer information was created or updated, you must set the report_type variable with the customer_vault value.\n\nIf you omit the report_type variable, the system will ignore the date_search variable.\n\nExample:\nreport_type=customer_vault&date_search=created,updated&start_date=20170101000000&end_date=20201231232359\ncreated: Will return Customer Vault data created during a specified date range.\nupdated: Will return Customer Vault data updated during a specified date range.","type":"text","disabled":true},{"key":"result_limit","value":"","description":"Determines the maximum number of results that may return for the current query.","type":"text","disabled":true},{"key":"page_number","value":"","description":"Determines which \"page\" of results are returned. For example, \"result_limit=100&page_number=0\" will return the first 100 results. Using \"page_number=1\" will return the next 100 results. Default is \"0\".","type":"text","disabled":true},{"key":"result_order","value":"","description":"Determines order of in which results are returned. Default value is \"standard\".\nstandard: Returns the results from oldest to newest.\nreverse: Returns the results from newest to oldest.","type":"text","disabled":true},{"key":"invoice_status","value":"","description":"Specify a comma separated list of what invoice statuses will return when using an \"invoicing\" report type.\n\nExample: invoice_status=open,closed,paid\nopen: Open Invoices\npaid: Paid Invoices\nclosed: Closed Invoices\npast_due: Past Due Invoices","type":"text","disabled":true}]},"url":"https://secure.nmi.com/api/query.php"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\n