The developer's documentation for the BackOffice application.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4021551","collectionId":"a1fdf796-6e92-4c39-95f0-4d870e8a5bd1","publishedId":"SVYjSgwP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-07-25T17:39:45.000Z"},"item":[{"name":"Getting Started","item":[{"name":"API Endpoints","item":[],"id":"a0e533d3-ef9f-43ca-ade1-c2e730acfa55","description":"There are two distinct environments you can use for these APIs, either Staging or Production. When testing, use the Staging environment as the {{BASEURL}}; once the workflow has been tested, use the production environment with live data.
API Endpoint: http://reportingapi.payfacconnect.com/
For an AuthenticationKey, contact your implementation consultant.
\n","_postman_id":"7305aa52-4880-4190-9e8d-81bcb298d502"}],"id":"e89bd809-3ec1-4c3b-9c10-e124f61eaad2","event":[{"listen":"prerequest","script":{"id":"456d62ff-60cb-40e3-9e8c-208b876f14b3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"494d241c-031c-49f1-92ab-558c77328ffe","type":"text/javascript","exec":[""]}}],"_postman_id":"e89bd809-3ec1-4c3b-9c10-e124f61eaad2","description":""},{"name":"Guides","item":[{"name":"Submerchant Workflow","item":[{"name":"Board a Submerchant","item":[{"name":"Board a Submerchant","id":"5cbfd825-3060-494c-bd31-4703709bec7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"{\r\n \"legalEntityName\": \"Bill's Bike Shop\",\r\n \"dbaName\": \"Bill's Bike Shop\",\r\n \"businessType\": \"4\",\r\n \"contactPhone\": \"7201234567\",\r\n \"feeProfile\": {\r\n \"id\": 84,\r\n \"type\": 0,\r\n \"discountRate\": 0,\r\n \"transactionFee\": 0,\r\n \"monthlyFee\": 0,\r\n \"visaMastercardRate\": 2.75,\r\n \"visaMastercardFee\": 0.25,\r\n \"discoverFee\": 0.25,\r\n \"discoverRate\": 2.75,\r\n \"amexRate\": 3.4,\r\n \"amexFee\": 0.25,\r\n \"chargebackFee\": 25,\r\n \"gatewayFee\": 5,\r\n \"batchFee\": 5\r\n },\r\n \"createdBy\": \"systemadmin@example.com\",\r\n \"taxIdNumber\": \"585892000\",\r\n \"businessAddress\": {\r\n \"line1\": \"700 Water St\",\r\n \"line2\": \"\",\r\n \"city\": \"Denver\",\r\n \"countryRegion\": \"CO\",\r\n \"stateProvince\": \"\",\r\n \"postalCode\": \"80211\"\r\n },\r\n \"useDifferentMailingAddress\": true,\r\n \"mailingAddress\": {\r\n \"line1\": \"2001 Colorado Blvd\",\r\n \"line2\": \"\",\r\n \"city\": \"Denver\",\r\n \"countryRegion\": \"CO\",\r\n \"stateProvince\": \"\",\r\n \"postalCode\": \"80205\"\r\n },\r\n \"timeZone\": \"\",\r\n \"maxTransactionAmount\": 2500,\r\n \"websiteAddress\": \"http://www.billsbikeshop.com\",\r\n \"principalFirstName\": \"Bill\",\r\n \"principalMiddleName\": \"B\",\r\n \"principalLastName\": \"Bikes\",\r\n \"principalAddress\": {\r\n \"line1\": \"2001 Colorado Blvd\",\r\n \"line2\": \"\",\r\n \"city\": \"Denver\",\r\n \"countryRegion\": \"CO\",\r\n \"stateProvince\": \"\",\r\n \"postalCode\": \"80205\"\r\n },\r\n \"merchantCategoryCode\": \"\",\r\n \"principalPhone\": \"7204316909\",\r\n \"annualCreditCardSalesVolume\": 0,\r\n \"bankAccountEncrypted\": \"\",\r\n \"bankRoutingEncrypted\": \"\",\r\n \"principalEmail\": \"billsbikeshop@example.com\",\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"\",\r\n \"value\": \"\"\r\n }\r\n ]\r\n}"},"url":"{{BaseURL}}/api/:tenantId/merchant/board","description":"Before a submerchant moves into the Backoffice application, it needs to be approved and boarded. Use this to board the submerchant account into the Backoffice application.
\nResponse Schema
\nIf the merchant uses multiple mailing addresses, it displays here.
\nString, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"e9122450-ec5c-4f9f-8d37-b9b6ec643e2f","name":"Board a Submerchant","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/merchant/board","host":["{{BaseURL}}"],"path":["api",":tenantId","merchant","board"],"variable":[{"key":"tenantId","value":"Tenant1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"5cbfd825-3060-494c-bd31-4703709bec7a"}],"id":"8e3aff9c-d5ce-453e-a017-a241e5138f82","_postman_id":"8e3aff9c-d5ce-453e-a017-a241e5138f82","description":""},{"name":"Hold and Release Submerchants","item":[{"name":"Hold a Submerchant","id":"206f858c-1c26-4d11-9c86-7660244ca120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId/hold","description":"If a submerchant exceeds this amount, use this to put a hold on a submerchant so it can no longer process payments.
\n","urlObject":{"path":["api",":tenantId","merchant",":submerchantId","hold"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"96fe8cd4-1df1-4850-86ef-707187e66cb4","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"7836d8a2-7f0c-4ecc-8fd4-5639443c93b6","description":{"content":"Integer, required. The unique id of the submerchant
\n","type":"text/plain"},"type":"string","value":"","key":"submerchantId"}]}},"response":[{"id":"5cb2ea27-b480-486c-a55b-1c3e4199ded2","name":"Hold a Submerchant","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId/hold","host":["{{BaseURL}}"],"path":["api",":tenantId","merchant",":submerchantId","hold"],"variable":[{"key":"tenantId","value":"Tenant1","description":"The unique id of the tenant"},{"key":"submerchantId","value":"305","description":"The unique id of the submerchant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"206f858c-1c26-4d11-9c86-7660244ca120"},{"name":"Release a Held Submerchant","id":"4d3bb293-3b2a-40ee-addd-63e7bb313d35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId/release","description":"Use this to release the hold on a submerchant so that it can begin processing payments again.
\n","urlObject":{"path":["api",":tenantId","merchant",":submerchantId","release"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"5bfcf7e7-78ba-4f70-ab05-8b5ffd9d4956","description":{"content":"The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"String, required","key":"tenantId"},{"id":"23451842-ecd3-4f00-be44-fa9fc5e95bb2","description":{"content":"The unique id of the submerchant
\n","type":"text/plain"},"type":"string","value":"Integer, required","key":"submerchantId"}]}},"response":[{"id":"f8b5ca01-b7bd-4fd9-a84a-77434a88c6b8","name":"Release a Held Submerchant","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId/release","host":["{{BaseURL}}"],"path":["api",":tenantId","merchant",":submerchantId","release"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"submerchantId","value":"305"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"4d3bb293-3b2a-40ee-addd-63e7bb313d35"}],"id":"d5b08ba4-ae83-41a7-9339-0b16368d5217","_postman_id":"d5b08ba4-ae83-41a7-9339-0b16368d5217","description":""},{"name":"View Submerchant Information","item":[{"name":"View All Submerchants","event":[{"listen":"test","script":{"id":"29188114-a08b-4353-aaeb-c673e6de2949","exec":[""],"type":"text/javascript"}}],"id":"9f691f53-2432-4243-bb15-ee48aa12ddb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/merchant","description":"Use this to view all submerchants in your tenant.
\nThe merchant identifiers lists out additionalProp fields, which are the merchant's boardindg ids.
\nIf the merchant uses multiple mailing addresses, it displays here.
\nString, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"b5b5b8fa-edd0-4a00-b980-467e3bea0f52","name":"View All Submerchants","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/merchant","host":["{{BaseURL}}"],"path":["api",":tenantId","merchant"],"variable":[{"key":"tenantId","value":"Tenant1","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 19,\r\n \"legalEntityName\": \"Bill's Bike Shop\",\r\n \"dbaName\": \"Bill's Bike Shop\",\r\n \"businessType\": \"4\",\r\n \"contactPhone\": \"7201234567\",\r\n \"feeProfile\": {\r\n \"id\": 84,\r\n \"type\": 0,\r\n \"discountRate\": 0,\r\n \"transactionFee\": 0,\r\n \"monthlyFee\": 0,\r\n \"visaMastercardRate\": 2.75,\r\n \"visaMastercardFee\": 0.25,\r\n \"discoverFee\": 0.25,\r\n \"discoverRate\": 2.75,\r\n \"amexRate\": 3.4,\r\n \"amexFee\": 0.25,\r\n \"chargebackFee\": 25,\r\n \"gatewayFee\": 5,\r\n \"batchFee\": 5\r\n },\r\n \"locations\": [],\r\n \"parent\": null,\r\n \"merchantIdentifiers\": {\r\n \"ClientExternal\": \"8af45dc3-7240-4411-b328-6f0c02d1aafd\"\r\n },\r\n \"accountStatus\": 0,\r\n \"createdDate\": \"2018-04-23T22:05:16.2196303+00:00\",\r\n \"createdBy\": \"systemadmin@example.com\",\r\n \"modifiedDate\": \"0001-01-01T00:00:00+00:00\",\r\n \"modifiedBy\": \"systemadmin@example.com\",\r\n \"taxIdNumber\": \"585892000\",\r\n \"businessAddressId\": 250,\r\n \"businessAddress\": {\r\n \"line1\": \"700 Water St\",\r\n \"line2\": \"\",\r\n \"city\": \"Denver\",\r\n \"countryRegion\": null,\r\n \"stateProvince\": \"CO\",\r\n \"postalCode\": \"80211\"\r\n },\r\n \"useDifferentMailingAddress\": true,\r\n \"mailingAddressId\": 251,\r\n \"mailingAddress\": {\r\n \"line1\": \"2001 Colorado Blvd\",\r\n \"line2\": \"\",\r\n \"city\": \"Denver\",\r\n \"countryRegion\": null,\r\n \"stateProvince\": \"CO\",\r\n \"postalCode\": \"80205\"\r\n },\r\n \"timeZone\": null,\r\n \"websiteAddress\": \"http://www.billysbikeshop.com\",\r\n \"principalFirstName\": \"Billy\",\r\n \"principalMiddleName\": \"B\",\r\n \"principalLastName\": \"Bikes\",\r\n \"principalAddressId\": 252,\r\n \"principalAddress\": {\r\n \"line1\": \"2001 Colorado Blvd\",\r\n \"line2\": \"\",\r\n \"city\": \"Dever\",\r\n \"countryRegion\": null,\r\n \"stateProvince\": \"CO\",\r\n \"postalCode\": \"80205\"\r\n },\r\n \"bankAddressId\": null,\r\n \"bankAddress\": null,\r\n \"principalPhone\": \"7204316909\",\r\n \"annualCreditCardSalesVolume\": 0,\r\n \"hasAcceptedCreditCards\": false,\r\n \"bankAccount\": null,\r\n \"bankRouting\": null,\r\n \"merchantCategoryCode\": null,\r\n \"principalEmail\": \"billsbikeshop@example.com\",\r\n \"terminals\": [],\r\n \"users\": []\r\n{\r\n \"id\": 20,\r\n \"legalEntityName\": \"Eye Carumba\",\r\n \"dbaName\": \"Eye Carumba\",\r\n \"businessType\": \"4\",\r\n \"contactPhone\": \"7201234568\",\r\n \"backgroundCheckResults\": null,\r\n \"feeProfile\": {\r\n \"id\": 84,\r\n \"type\": 0,\r\n \"discountRate\": 0,\r\n \"transactionFee\": 0,\r\n \"monthlyFee\": 0,\r\n \"visaMastercardRate\": 1.75,\r\n \"visaMastercardFee\": 0.5,\r\n \"discoverFee\": 0.5,\r\n \"discoverRate\": 1.75,\r\n \"amexRate\": 3.0,\r\n \"amexFee\": 0.3,\r\n \"chargebackFee\": 25,\r\n \"gatewayFee\": 5,\r\n \"batchFee\": 5\r\n },\r\n \"locations\": [],\r\n \"parent\": null,\r\n \"merchantIdentifiers\": {\r\n \"ClientExternal\": \"9bg56ed4-8351-5522-c439-7g1d13embbgc\"\r\n },\r\n \"accountStatus\": 0,\r\n \"createdDate\": \"2018-04-23T22:05:16.2196303+00:00\",\r\n \"createdBy\": \"systemadmin@example.com\",\r\n \"modifiedDate\": \"0001-01-01T00:00:00+00:00\",\r\n \"modifiedBy\": \"systemadmin@example.com\",\r\n \"taxIdNumber\": \"585892111\",\r\n \"businessAddressId\": 250,\r\n \"businessAddress\": {\r\n \"line1\": \"18300 W Alameda Pkwy\",\r\n \"line2\": \"\",\r\n \"city\": \"Morrison\",\r\n \"countryRegion\": null,\r\n \"stateProvince\": \"CO\",\r\n \"postalCode\": \"80465\"\r\n },\r\n \"useDifferentMailingAddress\": true,\r\n \"mailingAddressId\": 251,\r\n \"mailingAddress\": {\r\n \"line1\": \"2001 Blake St\",\r\n \"line2\": \"\",\r\n \"city\": \"Denver\",\r\n \"countryRegion\": null,\r\n \"stateProvince\": \"CO\",\r\n \"postalCode\": \"80205\"\r\n },\r\n \"timeZone\": null,\r\n \"websiteAddress\": \"http://www.eyecarumbaeyeglassesemporium.com\",\r\n \"principalFirstName\": \"Ce\",\r\n \"principalMiddleName\": \"\",\r\n \"principalLastName\": \"\",\r\n \"principalAddressId\": 252,\r\n \"principalAddress\": {\r\n \"line1\": \"\",\r\n \"line2\": \"\",\r\n \"city\": \"\",\r\n \"countryRegion\": null,\r\n \"stateProvince\": \"AL\",\r\n \"postalCode\": \"\"\r\n },\r\n \"bankAddressId\": null,\r\n \"bankAddress\": null,\r\n \"principalPhone\": \"7209876541\",\r\n \"annualCreditCardSalesVolume\": 0,\r\n \"hasAcceptedCreditCards\": false,\r\n \"bankAccount\": null,\r\n \"bankRouting\": null,\r\n \"merchantCategoryCode\": null,\r\n \"principalEmail\": \"eyecarumba@example.com\",\r\n \"terminals\": [],\r\n \"users\": []\r\n}"}],"_postman_id":"9f691f53-2432-4243-bb15-ee48aa12ddb5"},{"name":"Review Submerchant Information","id":"fcf1f0b0-504c-4331-a73f-8ea17e6b7aaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId","description":"Use this to view information about a submerchant.
\nThe merchant identifiers lists out additionalProp fields, which are the merchant's boardindg ids.
\nIf the merchant uses multiple mailing addresses, it displays here.
\nString, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"description":{"content":"Integer, required. The uniqueid of the submerchant
\n","type":"text/plain"},"type":"string","value":"","key":"submerchantId"}]}},"response":[{"id":"6a23509e-7c0c-4a8f-8dd1-b5f2b5151073","name":"Review Merchant Information","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId/identifiers","host":["{{BaseURL}}"],"path":["api",":tenantId","merchant",":submerchantId","identifiers"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"submerchantId","value":"305"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 19,\r\n \"legalEntityName\": \"Bill's Bike Shop\",\r\n \"dbaName\": \"Bill's Bike Shop\",\r\n \"businessType\": \"4\",\r\n \"contactPhone\": \"7201234567\",\r\n \"feeProfile\": {\r\n \"id\": 84,\r\n \"type\": 0,\r\n \"discountRate\": 0,\r\n \"transactionFee\": 0,\r\n \"monthlyFee\": 0,\r\n \"visaMastercardRate\": 2.75,\r\n \"visaMastercardFee\": 0.25,\r\n \"discoverFee\": 0.25,\r\n \"discoverRate\": 2.75,\r\n \"amexRate\": 3.4,\r\n \"amexFee\": 0.25,\r\n \"chargebackFee\": 25,\r\n \"gatewayFee\": 5,\r\n \"batchFee\": 5\r\n },\r\n \"locations\": [],\r\n \"parent\": null,\r\n \"merchantIdentifiers\": {\r\n \"ClientExternal\": \"8af45dc3-7240-4411-b328-6f0c02d1aafd\"\r\n },\r\n \"accountStatus\": 0,\r\n \"createdDate\": \"2018-04-23T22:05:16.2196303+00:00\",\r\n \"createdBy\": \"systemadmin@example.com\",\r\n \"modifiedDate\": \"0001-01-01T00:00:00+00:00\",\r\n \"modifiedBy\": \"systemadmin@example.com\",\r\n \"taxIdNumber\": \"585892000\",\r\n \"businessAddressId\": 250,\r\n \"businessAddress\": {\r\n \"line1\": \"700 Water St\",\r\n \"line2\": \"\",\r\n \"city\": \"Denver\",\r\n \"countryRegion\": null,\r\n \"stateProvince\": \"CO\",\r\n \"postalCode\": \"80211\"\r\n },\r\n \"useDifferentMailingAddress\": true,\r\n \"mailingAddressId\": 251,\r\n \"mailingAddress\": {\r\n \"line1\": \"2001 Colorado Blvd\",\r\n \"line2\": \"\",\r\n \"city\": \"Denver\",\r\n \"countryRegion\": null,\r\n \"stateProvince\": \"CO\",\r\n \"postalCode\": \"80205\"\r\n },\r\n \"timeZone\": null,\r\n \"websiteAddress\": \"http://www.billysbikeshop.com\",\r\n \"principalFirstName\": \"Billy\",\r\n \"principalMiddleName\": \"B\",\r\n \"principalLastName\": \"Bikes\",\r\n \"principalAddressId\": 252,\r\n \"principalAddress\": {\r\n \"line1\": \"2001 Colorado Blvd\",\r\n \"line2\": \"\",\r\n \"city\": \"Dever\",\r\n \"countryRegion\": null,\r\n \"stateProvince\": \"CO\",\r\n \"postalCode\": \"80205\"\r\n },\r\n \"bankAddressId\": null,\r\n \"bankAddress\": null,\r\n \"principalPhone\": \"7204316909\",\r\n \"annualCreditCardSalesVolume\": 0,\r\n \"hasAcceptedCreditCards\": false,\r\n \"bankAccount\": null,\r\n \"bankRouting\": null,\r\n \"merchantCategoryCode\": null,\r\n \"principalEmail\": \"billsbikeshop@example.com\",\r\n \"terminals\": [],\r\n \"users\": []\r\n}"}],"_postman_id":"fcf1f0b0-504c-4331-a73f-8ea17e6b7aaf"},{"name":"Review Submerchant Information by Identifier","id":"da05d1b6-ef5b-41fe-99cb-6a7c2a858f31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/merchant/identifier/:submerchantIdentifier","description":"Use this method to review submerchant information.
\nThe merchant identifiers lists out additionalProp fields, which are the merchant's boardindg ids.
\nIf the merchant uses multiple mailing addresses, it displays here.
\nString, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"57d2b692-69b2-46af-9aea-e528366dbf03","description":{"content":"String, required. The unique id of the submerchant
\n","type":"text/plain"},"type":"string","value":"","key":"submerchantIdentifier"}]}},"response":[{"id":"b3ce2065-ff8f-48ca-a3fd-fb00298d3df3","name":"Review Submerchant Information","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/merchant/identifier/:submerchantIdentifier","host":["{{BaseURL}}"],"path":["api",":tenantId","merchant","identifier",":submerchantIdentifier"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"submerchantIdentifier","value":"String, required","description":"The unique id of the submerchant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 19,\n \"legalEntityName\": \"Bill's Bike Shop\",\n \"dbaName\": \"Bill's Bike Shop\",\n \"businessType\": \"4\",\n \"contactPhone\": \"7201234567\",\n \"feeProfile\": {\n \"id\": 84,\n \"type\": 0,\n \"discountRate\": 0,\n \"transactionFee\": 0,\n \"monthlyFee\": 0,\n \"visaMastercardRate\": 2.75,\n \"visaMastercardFee\": 0.25,\n \"discoverFee\": 0.25,\n \"discoverRate\": 2.75,\n \"amexRate\": 3.4,\n \"amexFee\": 0.25,\n \"chargebackFee\": 25,\n \"gatewayFee\": 5,\n \"batchFee\": 5\n },\n \"locations\": [],\n \"parent\": null,\n \"merchantIdentifiers\": {\n \"ClientExternal\": \"8af45dc3-7240-4411-b328-6f0c02d1aafd\"\n },\n \"accountStatus\": 0,\n \"createdDate\": \"2018-04-23T22:05:16.2196303+00:00\",\n \"createdBy\": \"systemadmin@example.com\",\n \"modifiedDate\": \"0001-01-01T00:00:00+00:00\",\n \"modifiedBy\": \"systemadmin@example.com\",\n \"taxIdNumber\": \"585892000\",\n \"businessAddressId\": 250,\n \"businessAddress\": {\n \"line1\": \"700 Water St\",\n \"line2\": \"\",\n \"city\": \"Denver\",\n \"countryRegion\": null,\n \"stateProvince\": \"CO\",\n \"postalCode\": \"80211\"\n },\n \"useDifferentMailingAddress\": true,\n \"mailingAddressId\": 251,\n \"mailingAddress\": {\n \"line1\": \"2001 Colorado Blvd\",\n \"line2\": \"\",\n \"city\": \"Denver\",\n \"countryRegion\": null,\n \"stateProvince\": \"CO\",\n \"postalCode\": \"80205\"\n },\n \"timeZone\": null,\n \"websiteAddress\": \"http://www.billysbikeshop.com\",\n \"principalFirstName\": \"Billy\",\n \"principalMiddleName\": \"B\",\n \"principalLastName\": \"Bikes\",\n \"principalAddressId\": 252,\n \"principalAddress\": {\n \"line1\": \"2001 Colorado Blvd\",\n \"line2\": \"\",\n \"city\": \"Dever\",\n \"countryRegion\": null,\n \"stateProvince\": \"CO\",\n \"postalCode\": \"80205\"\n },\n \"bankAddressId\": null,\n \"bankAddress\": null,\n \"principalPhone\": \"7204316909\",\n \"annualCreditCardSalesVolume\": 0,\n \"hasAcceptedCreditCards\": false,\n \"bankAccount\": null,\n \"bankRouting\": null,\n \"merchantCategoryCode\": null,\n \"principalEmail\": \"billsbikeshop@example.com\",\n \"terminals\": [],\n \"users\": []\n}"}],"_postman_id":"da05d1b6-ef5b-41fe-99cb-6a7c2a858f31"},{"name":"Add Submerchant Boarding Ids","id":"989c916e-a949-4bd1-bbfc-bc8a5b451e81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key value
\n"}],"body":{"mode":"raw","raw":"{\r\n \"mid\": \"string\",\r\n \"tiDs\": [\r\n \"string\"\r\n ],\r\n \"additionalIdentifiers\": {\r\n \"additionalProp1\": \"string\",\r\n \"additionalProp2\": \"string\",\r\n \"additionalProp3\": \"string\"\r\n }\r\n}"},"url":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId/identifiers","description":"After a submerchant has been boarded, use this to update the boarding ids it received. Use this in conjunction with 'Review Submerchant Information' to find the field names to use as the additionalIdentifiers.
\n","urlObject":{"path":["api",":tenantId","merchant",":submerchantId","identifiers"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"d395215d-968d-494d-b750-5a13bad19469","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"7236dd06-dab3-4c58-ac98-3a14bf09449d","description":{"content":"Integer, required. The unique id of the submerchant
\n","type":"text/plain"},"type":"string","value":"","key":"submerchantId"}]}},"response":[{"id":"32051a30-740f-43f7-bde5-b661b1f1dff4","name":"View Submerchant Boarding Ids","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":"{\r\n \"mid\": \"string\",\r\n \"tiDs\": [\r\n \"string\"\r\n ],\r\n \"additionalIdentifiers\": {\r\n \"additionalProp1\": \"string\",\r\n \"additionalProp2\": \"string\",\r\n \"additionalProp3\": \"string\"\r\n }\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId/identifiers","host":["{{BaseURL}}"],"path":["api",":tenantId","merchant",":submerchantId","identifiers"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"submerchantId","value":"Integer, required","description":"The unique id of the submerchant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"989c916e-a949-4bd1-bbfc-bc8a5b451e81"},{"name":"Update Merchant to First Auth","id":"772a198c-1c0c-4acd-a415-a47c7af0303d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/merchant/firstauth","urlObject":{"path":["api",":tenantId","merchant","firstauth"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"7e887fb8-10c0-4084-8403-cfbc70617f87","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[],"_postman_id":"772a198c-1c0c-4acd-a415-a47c7af0303d"}],"id":"5c07fb56-2d4e-4b00-8c1f-0ac7e56f6709","_postman_id":"5c07fb56-2d4e-4b00-8c1f-0ac7e56f6709","description":""},{"name":"Funding Configuration","item":[{"name":"Add Funding Configuration to a Submerchant","id":"75a38413-2985-4323-87c5-094330356554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"{\r\n \"fundingSystem\": \"Test\",\r\n \"companyName\": \"string\",\r\n \"taxIDNumber\": \"string\",\r\n \"fundingInstructionId\": \"string\",\r\n \"fundingInstructionCompanyId\": \"string\",\r\n \"transactionDataSource\": \"Test\"\r\n}"},"url":"{{BaseURL}}/api/Tenant/:tenantId/AddFundingConfig","description":"Use this method to add funding configuration to a submerchant.
\nSchema
\nResponse Schema
\n","urlObject":{"path":["api","Tenant",":tenantId","AddFundingConfig"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"6ccdedaa-d399-41b5-b00d-81e908b8f045","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"9cfa23df-c044-4d5c-9c58-739516fd5fbb","name":"Add Funding Configuration to a Submerchant","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"{\r\n \"fundingSystem\": \"Test\",\r\n \"companyName\": \"string\",\r\n \"taxIDNumber\": \"string\",\r\n \"fundingInstructionId\": \"string\",\r\n \"fundingInstructionCompanyId\": \"string\",\r\n \"transactionDataSource\": \"Test\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/Tenant/:tenantId/AddFundingConfig","host":["{{BaseURL}}"],"path":["api","Tenant",":tenantId","AddFundingConfig"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T17:58:34.046Z\",\r\n \"endTime\": \"2018-08-06T17:58:34.046Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"75a38413-2985-4323-87c5-094330356554"},{"name":"Update Funding Configuration for a Submerchant","id":"0b649229-a48a-4c13-9538-53b4536b4a20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"{\r\n \"fundingSystem\": \"Test\",\r\n \"companyName\": \"string\",\r\n \"taxIDNumber\": \"string\",\r\n \"fundingInstructionId\": \"string\",\r\n \"fundingInstructionCompanyId\": \"string\",\r\n \"transactionDataSource\": \"Test\"\r\n}"},"url":"{{BaseURL}}/api/Tenant/:tenantId/UpdateFundingConfig/:fundingConfigId","description":"Use this method to update funding instructions for a submerchant.
\nSchema
\nResponse Schema
\n","urlObject":{"path":["api","Tenant",":tenantId","UpdateFundingConfig",":fundingConfigId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"ca3ac4e7-3f34-432c-b66b-47a88f10dc60","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"1c016eaa-2632-422e-983d-7e44507ef85f","description":{"content":"Integer, required. The unique id of the funding configuration
\n","type":"text/plain"},"type":"string","value":"","key":"fundingConfigId"}]}},"response":[{"id":"aa505bb7-4baf-49c8-b973-85dd3bf77991","name":"Update Funding Configuration for a Submerchant","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"{\r\n \"fundingSystem\": \"Test\",\r\n \"companyName\": \"string\",\r\n \"taxIDNumber\": \"string\",\r\n \"fundingInstructionId\": \"string\",\r\n \"fundingInstructionCompanyId\": \"string\",\r\n \"transactionDataSource\": \"Test\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/Tenant/:tenantId/UpdateFundingConfig/:fundingConfigId","host":["{{BaseURL}}"],"path":["api","Tenant",":tenantId","UpdateFundingConfig",":fundingConfigId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"fundingConfigId","value":"Integer, required","description":"The unique id of the funding configuration"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T18:05:46.843Z\",\r\n \"endTime\": \"2018-08-06T18:05:46.843Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"0b649229-a48a-4c13-9538-53b4536b4a20"}],"id":"7d260e09-890a-4650-953c-9214545c22cf","_postman_id":"7d260e09-890a-4650-953c-9214545c22cf","description":""},{"name":"Disable a Submerchant","id":"07f924cc-9535-46af-9747-b502e3ff6070","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId/","description":"Use this to disable a submerchant.
\n","urlObject":{"path":["api",":tenantId","merchant",":submerchantId",""],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"46795c39-cb9c-4a12-a73f-f81fd2a1561f","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"cbe406ad-011b-4ef9-ab18-0a7d8fad877b","description":{"content":"Integer, required. The unique id of the submerchant
\n","type":"text/plain"},"type":"string","value":"","key":"submerchantId"}]}},"response":[{"id":"5bb33e91-4773-4a50-a201-aa899a093549","name":"Disable a Submerchant","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/merchant/:submerchantId/","host":["{{BaseURL}}"],"path":["api",":tenantId","merchant",":submerchantId",""],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"submerchantId","value":"305"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"07f924cc-9535-46af-9747-b502e3ff6070"}],"id":"9c9b708b-d39f-47cc-94ac-38678f836ddd","description":"A submerchant has filled out their application, gone through a round or more of underwriting checks, and has been approved and boarded to the Backoffice application. In the Backoffice, submerchant users can login and look at transactions, chargebacks, and deposits information. As a Payment Facilitator, you need to be able to understand your submerchants, put their payments processing on hold or release, look into transactions data, and more.
\nThe next few folders outline different ways to manage submerchant information.
\n","event":[{"listen":"prerequest","script":{"id":"d6d44c98-5e01-4a5f-b5b6-9e192bd3bb11","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9383b497-6108-4976-aacf-a4a08281286a","type":"text/javascript","exec":[""]}}],"_postman_id":"9c9b708b-d39f-47cc-94ac-38678f836ddd"},{"name":"Payment Information","item":[{"name":"Data Files","item":[{"name":"Import Data Files","id":"da84ae06-1e10-4089-b0e5-e8557c0d3c4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/dataimport/datafiles","description":"Use this method to import a data file from the configured location.
\n","urlObject":{"path":["api",":tenantId","dataimport","datafiles"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"2c3ff7a6-c6f1-4ad1-951e-ba8f0dcf4be4","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"f53e747d-3019-40ec-9b82-391180218bbe","name":"Import Data Files","originalRequest":{"method":"POST","header":[{"key":"AuthenticationKey","value":"{{AuthenticationToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/dataimport/datafiles","host":["{{BaseURL}}"],"path":["api",":tenantId","dataimport","datafiles"],"variable":[{"key":"tenantId","value":"Tenant1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"da84ae06-1e10-4089-b0e5-e8557c0d3c4b"},{"name":"Reprocess Data File","id":"4c9327c6-a90a-4b0e-abe2-3bed179b18e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/dataimport/datafiles/:dataFileId","description":"Use this to reprocess an individual data file.
\n","urlObject":{"path":["api",":tenantId","dataimport","datafiles",":dataFileId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"29787286-a5be-4777-be78-c98c774cdb27","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"274b5c80-758a-41bf-9f9e-9f039bb516d4","description":{"content":"Integer, required. The unique id of the data field
\n","type":"text/plain"},"type":"string","value":"","key":"dataFileId"}]}},"response":[{"id":"bd3614ea-d132-4144-8828-5f7bcbcc2346","name":"Reprocess Data File","originalRequest":{"method":"POST","header":[{"key":"AuthenticationKey","value":"{{AuthenticationToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/dataimport/datafiles/:dataFileId","host":["{{BaseURL}}"],"path":["api",":tenantId","dataimport","datafiles",":dataFileId"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"dataFileId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"4c9327c6-a90a-4b0e-abe2-3bed179b18e4"}],"id":"2778357c-f830-4656-a399-9128ab047654","description":"The commands for data files can be used for many different types of data files, such as TSYS files, D256, etc, as long as the files are in the configured location. Data files contain transactions, chargebacks, and deposits.
\n","event":[{"listen":"prerequest","script":{"id":"654d7e66-f60c-411f-b161-0b3ec4defb50","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"029128a8-bf2d-4b30-9868-67f6405c4e31","type":"text/javascript","exec":[""]}}],"_postman_id":"2778357c-f830-4656-a399-9128ab047654"},{"name":"Transactions","item":[{"name":"Transaction Notes","item":[{"name":"Get Transaction Notes","id":"e1515786-8b42-4a53-8c99-79de18645fe2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","value":""},{"description":"The authentication key secret
\n","key":"x-AuthenticationKeyValue","value":""}],"url":"{{BaseURL}}/api/:tenantId/transactions/:transactionId/notes","description":"Use this method to see all transaction notes.
\n","urlObject":{"path":["api",":tenantId","transactions",":transactionId","notes"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"cd5fd9aa-d811-40bb-ac04-3454ffdb3cbe","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"5ad29e6f-5080-4dbc-9b52-476d9fcfe556","description":{"content":"Integer, required. The unique id of the transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"cd180d21-aece-449b-bea0-857046607f43","name":"Get Transaction Notes","originalRequest":{"method":"GET","header":[{"description":"The authentication key","key":"x-AuthenticationKeyId","value":""},{"description":"The authentication key secret","key":"x-AuthenticationKeyValue","value":""}],"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions/:transactionId/notes","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions",":transactionId","notes"],"variable":[{"description":"String, required. The unique id of the tenant","key":"tenantId","value":""},{"description":"Integer, required. The unique id of the transaction","key":"transactionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 0,\n \"message\": \"string\",\n \"createdDate\": \"2019-06-03T16:45:16.917Z\",\n \"type\": \"NoteInternal\",\n \"createdBy\": \"string\"\n }\n]"}],"_postman_id":"e1515786-8b42-4a53-8c99-79de18645fe2"},{"name":"Create a Transaction Note","id":"f0ef7807-5d14-420a-a96f-1980ab6f32d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","value":""},{"description":"The authentication key secret
\n","key":"x-AuthenticationKeyValue","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"noteType\": \"NoteInternal\",\n \"message\": \"string\",\n \"username\": \"string\"\n}"},"url":"{{BaseURL}}/api/:tenantId/transactions/:transactionId/notes","description":"Use this method to create a transaction note.
\n","urlObject":{"path":["api",":tenantId","transactions",":transactionId","notes"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"4d169f5b-e517-4ae8-aa1d-f430fb7d34a1","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"4b2d0fd0-bc7f-441d-854b-5bd113ee3ca0","description":{"content":"Integer, required. The unique id of the transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[],"_postman_id":"f0ef7807-5d14-420a-a96f-1980ab6f32d7"}],"id":"54032355-99d0-4b6f-b920-e547b3a1b1f9","description":"","event":[{"listen":"prerequest","script":{"id":"70a8c1d0-3498-4ab7-8284-8912768c73be","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d7953933-c92d-4d37-a2b1-bbf07c61051e","type":"text/javascript","exec":[""]}}],"_postman_id":"54032355-99d0-4b6f-b920-e547b3a1b1f9"},{"name":"Review a Transaction","id":"a71dbca7-6a28-4910-b236-f113cc91cd7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/transactions/:transactionId","description":"Use this method to review a single transaction.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","transactions",":transactionId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"8952461a-be2d-4f7d-8d76-7418be15f2b8","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"6c8773cc-41dc-47dc-aaaa-b191fd51cfc8","description":{"content":"Integer, required. The unique id of the transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"aacd1f43-60d6-4292-ba2f-6afb0ec30dc3","name":"Review a Transaction","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions/:transactionId","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions",":transactionId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"transactionId","value":"Integer, required","description":"The unique id of the transaction"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 0,\r\n \"transactionDate\": \"2018-08-06T18:07:26.668Z\",\r\n \"arn\": \"string\",\r\n \"authorizationCode\": \"string\",\r\n \"authorizationSource\": \"string\",\r\n \"authorizationResponse\": \"string\",\r\n \"authorizationAmount\": 0,\r\n \"transactionAmount\": 0,\r\n \"submerchantBatchId\": \"string\",\r\n \"currency\": \"string\",\r\n \"cardBin\": \"string\",\r\n \"cardLastFour\": \"string\",\r\n \"cardType\": \"string\",\r\n \"network\": \"Unknown\",\r\n \"issuingBankID\": \"string\",\r\n \"interchangeFee\": 0,\r\n \"processorFee\": 0,\r\n \"assessmentFee\": 0,\r\n \"payfacFee\": 0,\r\n \"sourceDataEventId\": 0,\r\n \"processorMID\": \"string\",\r\n \"transactionType\": \"Deposit\",\r\n \"onHold\": true,\r\n \"terminalId\": \"string\",\r\n \"fundingStatus\": \"New\",\r\n \"processorTransactionID\": \"string\",\r\n \"submerchantName\": \"string\",\r\n \"submerchantId\": 0,\r\n \"settlementDate\": \"2018-08-06T18:07:26.669Z\",\r\n \"extendedData\": \"string\",\r\n \"interchangeCode\": null,\r\n \"interchangeLevel\": null,\r\n \"feeSettlementDate\": null,\r\n \"gatewayReferenceId\": null,\r\n \"partnerReferenceId\": null,\r\n \"totalFees\": 0,\r\n \"netAmount\": 0,\r\n \"depositIds\": [],\r\n \"feeProfileType\": 0,\r\n\"merchantIdentifiers\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-05-24T16:25:53.427Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"a71dbca7-6a28-4910-b236-f113cc91cd7b"},{"name":"Review a Transaction Using Gateway and Partner Reference Numbers","id":"9e0880db-fb85-462a-b077-b34993c1929d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/transactions/identifier?gatewayReferenceNumber=&partnerReferenceNumber=&transactionIdentifier=","description":"Use this method to get information for a single transaction using the gateway and partner reference numbers.
\n","urlObject":{"path":["api",":tenantId","transactions","identifier"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"The transaction's gateway reference number
\n","type":"text/plain"},"key":"gatewayReferenceNumber","value":""},{"description":{"content":"The transaction's partner reference number
\n","type":"text/plain"},"key":"partnerReferenceNumber","value":""},{"description":{"content":"The transaction identifier
\n","type":"text/plain"},"key":"transactionIdentifier","value":""}],"variable":[{"id":"c330550a-013d-4bb6-8581-2d26d0541a2b","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"0f203906-51a2-4941-9ea2-6c9fb7b22af2","name":"Review a Transaction Using Gateway and Partner Reference Numbers","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":"{{BaseURL}}/api/{tenantId}/transactions/identifier"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 0,\n \"transactionDate\": \"2018-09-19T21:57:13.576Z\",\n \"arn\": \"string\",\n \"authorizationCode\": \"string\",\n \"authorizationSource\": \"string\",\n \"authorizationResponse\": \"string\",\n \"authorizationAmount\": 0,\n \"transactionAmount\": 0,\n \"submerchantBatchId\": \"string\",\n \"currency\": \"string\",\n \"cardBin\": \"string\",\n \"cardLastFour\": \"string\",\n \"cardType\": \"string\",\n \"network\": \"Unknown\",\n \"issuingBankID\": \"string\",\n \"interchangeFee\": 0,\n \"processorFee\": 0,\n \"assessmentFee\": 0,\n \"payfacFee\": 0,\n \"sourceDataEventId\": 0,\n \"processorMID\": \"string\",\n \"transactionType\": \"Deposit\",\n \"onHold\": true,\n \"terminalId\": \"string\",\n \"fundingStatus\": \"New\",\n \"processorTransactionID\": \"string\",\n \"submerchantName\": \"string\",\n \"submerchantId\": 0,\n \"settlementDate\": \"2018-09-19T21:57:13.576Z\",\n \"extendedData\": \"string\",\n \"interchangeCode\": \"string\",\n \"interchangeLevel\": \"string\",\n \"gatewayReferenceId\": \"string\",\n \"partnerReferenceId\": \"string\",\n \"totalFees\": 0,\n \"netAmount\": 0,\n \"depositIds\": [],\n \"feeProfileType\": 0,\n\t\"merchantIdentifiers\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"notes\": [\n {\n \"id\": 0,\n \"message\": \"string\",\n \"createdDate\": \"2019-05-24T16:25:53.427Z\",\n \"type\": \"NoteInternal\",\n \"createdBy\": \"string\"\n }\n ]\n }"}],"_postman_id":"9e0880db-fb85-462a-b077-b34993c1929d"},{"name":"Review All Transactions","id":"6b480869-2a5e-4d18-b728-60199c180e32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/transactions","description":"Use this method to review all transactions within a tenant.
\n","urlObject":{"path":["api",":tenantId","transactions"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"17921e29-b8d0-43ef-aa53-6d3053b1ce7b","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"232c568f-281e-4a0d-86f5-3f869dbea750","name":"Review all Transactions","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 0,\r\n \"transactionDate\": \"2018-08-06T18:07:26.668Z\",\r\n \"arn\": \"string\",\r\n \"authorizationCode\": \"string\",\r\n \"authorizationSource\": \"string\",\r\n \"authorizationResponse\": \"string\",\r\n \"authorizationAmount\": 0,\r\n \"transactionAmount\": 0,\r\n \"submerchantBatchId\": \"string\",\r\n \"currency\": \"string\",\r\n \"cardBin\": \"string\",\r\n \"cardLastFour\": \"string\",\r\n \"cardType\": \"string\",\r\n \"network\": \"Unknown\",\r\n \"issuingBankID\": \"string\",\r\n \"interchangeFee\": 0,\r\n \"processorFee\": 0,\r\n \"assessmentFee\": 0,\r\n \"payfacFee\": 0,\r\n \"sourceDataEventId\": 0,\r\n \"processorMID\": \"string\",\r\n \"transactionType\": \"Deposit\",\r\n \"onHold\": true,\r\n \"terminalId\": \"string\",\r\n \"fundingStatus\": \"New\",\r\n \"processorTransactionID\": \"string\",\r\n \"submerchantName\": \"string\",\r\n \"submerchantId\": 0,\r\n \"settlementDate\": \"2018-08-06T18:07:26.669Z\",\r\n \"extendedData\": \"string\",\r\n \"interchangeCode\": null,\r\n \"interchangeLevel\": null,\r\n \"feeSettlementDate\": null,\r\n \"gatewayReferenceId\": null,\r\n \"partnerReferenceId\": null,\r\n \"totalFees\": 0,\r\n \"netAmount\": 0,\r\n \"depositIds\": [],\r\n \"feeProfileType\": 0,\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"MID\",\r\n \"value\": \"1234567891234\"\r\n },\r\n {\r\n \"key\": \"ClientExternal\",\r\n \"value\": \"1234567890\"\r\n }\r\n ], \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-05-24T16:25:53.427Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"6b480869-2a5e-4d18-b728-60199c180e32"},{"name":"Review All Transaction for a Submerchant","id":"bd080d62-9b0f-48c4-94c7-a5fb2147a2b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/transactions/submerchant/:submerchantId","description":"Use this method to review all transactions within a submerchant.
\n","urlObject":{"path":["api",":tenantId","transactions","submerchant",":submerchantId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"afc1940b-0075-4790-92a8-dcb6e608607a","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"1a759e90-017f-4e6d-894c-467905b8893d","description":{"content":"Integer, required. The unique id of the submerchant
\n","type":"text/plain"},"type":"string","value":"","key":"submerchantId"}]}},"response":[{"id":"4c20656a-463a-4c61-9816-b24ef0b3a6c3","name":"Review All Transaction for a Submerchant","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions/submerchant/:submerchantId","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions","submerchant",":submerchantId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"submerchantId","value":"Integer, required","description":"The unique id of the submerchant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 0,\r\n \"transactionDate\": \"2018-08-06T19:10:11.081Z\",\r\n \"arn\": \"string\",\r\n \"authorizationCode\": \"string\",\r\n \"authorizationSource\": \"string\",\r\n \"authorizationResponse\": \"string\",\r\n \"authorizationAmount\": 0,\r\n \"transactionAmount\": 0,\r\n \"submerchantBatchId\": \"string\",\r\n \"currency\": \"string\",\r\n \"cardBin\": \"string\",\r\n \"cardLastFour\": \"string\",\r\n \"cardType\": \"string\",\r\n \"network\": \"Unknown\",\r\n \"issuingBankID\": \"string\",\r\n \"interchangeFee\": 0,\r\n \"processorFee\": 0,\r\n \"assessmentFee\": 0,\r\n \"payfacFee\": 0,\r\n \"sourceDataEventId\": 0,\r\n \"processorMID\": \"string\",\r\n \"transactionType\": \"Deposit\",\r\n \"onHold\": true,\r\n \"terminalId\": \"string\",\r\n \"fundingStatus\": \"New\",\r\n \"processorTransactionID\": \"string\",\r\n \"submerchantName\": \"string\",\r\n \"submerchantId\": 0,\r\n \"settlementDate\": \"2018-08-06T19:10:11.081Z\",\r\n \"extendedData\": \"string\",\r\n \"interchangeCode\": null,\r\n \"interchangeLevel\": null,\r\n \"feeSettlementDate\": null,\r\n \"gatewayReferenceId\": null,\r\n \"partnerReferenceId\": null,\r\n \"totalFees\": 2,\r\n \"netAmount\": 98,\r\n \"depositIds\": [],\r\n \"feeProfileType\": 0,\r\n \"merchantIdentifiers\": []\r\n }\r\n ]"}],"_postman_id":"bd080d62-9b0f-48c4-94c7-a5fb2147a2b5"},{"name":"Review Paginated Transactions","id":"a4571f53-350f-481a-b342-f9a167072bbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","type":"text","value":""},{"description":"The authentication key secret
\n","key":"x-AuthenticationKeyValue","type":"text","value":""}],"url":"{{BaseURL}}/api/:tenantid/transactions/paginated","description":"If you need to do a transactions query that has more than 1,000 results, use this method. The results will return a total count of the transactions and the number of pages in the request, where each page has 1,000 transactions.
\nDate Filters
\nWhen searching using date filters, use the DateFilter query parameter with the following values:
\nToday = 1,\nYesterday = 2,\nThisWeek = 3,\nThisMonth = 4,\nThisYear = 5,\nLastYear = 6,\nDateRange = 7
\nAll DateFilters must be used with a DateFilterType, where 0 = transactionDate and 1 = fundedDate. For DateFilters with 7, or DateRange, you must and add a FromDate query parameter, with an optional ToDate query parameter. The dates for FromDate and ToDate are formatted YYYY-MM-DD
\nTime Filters
\nIf you need to filter by a specific time within a date range, add the time after the FromDate or ToDate. For example: {{BaseURL}}/api/{tenantId}/transactions?DateFilter=DateRange&DateFilterType=TransactionDate&FromDate=2018-11-21T00:00:00&ToDate=2018-11-21T12:00:00
Note that the dates are in UTC.
\nAscending and Descending Order
\nTo display transactions in ascending or descending order, declare which parameter you want to sort off by using a FieldName parameter, and declare either ASC (ascending) or DESC (descending) with the SortOrder parameter.\nFor example: {{BaseURL}}/api/{tenantId}/transactions?FieldName=TransactionAmount&SortOrder=DESC sorts transactions by the TransactionAmount in descending order.
Schema
\nTransactions
\nMerchant Identifiers
\n","urlObject":{"path":["api",":tenantid","transactions","paginated"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"c898f230-c979-40e3-81dc-d03968cc5218","description":{"content":"String, required. The tenant's unique id
\n","type":"text/plain"},"type":"string","value":"","key":"tenantid"}]}},"response":[{"id":"5b5e7776-6531-43b8-8392-6b9b9ef48dd8","name":"Review Paginated Transactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantid/transactions/paginated","host":["{{BaseURL}}"],"path":["api",":tenantid","transactions","paginated"],"variable":[{"key":"tenantid","value":"String, required","description":"The tenant's unique id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"transactions\": [\n {\n \"id\": 0,\n \"transactionDate\": \"2019-01-18T23:02:10.220Z\",\n \"arn\": \"string\",\n \"authorizationCode\": \"string\",\n \"authorizationSource\": \"string\",\n \"authorizationResponse\": \"string\",\n \"authorizationAmount\": 0,\n \"transactionAmount\": 0,\n \"submerchantBatchId\": \"string\",\n \"currency\": \"string\",\n \"cardBin\": \"string\",\n \"cardLastFour\": \"string\",\n \"cardType\": \"string\",\n \"network\": \"Unknown\",\n \"issuingBankID\": \"string\",\n \"interchangeFee\": 0,\n \"networkFees\": 0,\n \"processorFee\": 0,\n \"assessmentFee\": 0,\n \"payfacFee\": 0,\n \"sourceDataEventId\": 0,\n \"processorMID\": \"string\",\n \"transactionType\": \"Deposit\",\n \"onHold\": true,\n \"terminalId\": \"string\",\n \"fundingStatus\": \"New\",\n \"processorTransactionID\": \"string\",\n \"submerchantName\": \"string\",\n \"submerchantId\": 0,\n \"submerchantDbaName\": \"string\",\n \"settlementDate\": \"2019-01-18T23:02:10.220Z\",\n \"extendedData\": \"string\",\n \"interchangeCode\": \"string\",\n \"interchangeLevel\": \"string\",\n \"feeSettlementDate\": \"2019-01-18T23:02:10.220Z\",\n \"gatewayReferenceId\": \"string\",\n \"partnerReferenceId\": \"string\",\n \"totalFees\": 0,\n \"netAmount\": 0,\n \"depositIds\": [\n 0\n \t],\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"1234567891234\"\n }\n ],\n \"notes\": [\n {\n \"id\": 0,\n \"message\": \"string\",\n \"createdDate\": \"2019-05-24T16:48:44.655Z\",\n \"type\": \"NoteInternal\",\n \"createdBy\": \"string\"\n }\n ]\n }\n ],\n \"totalRequestedTransactions\": 0,\n \"currentPage\": 0,\n \"pageSize\": 0,\n \"totalPages\": 0\n}"}],"_postman_id":"a4571f53-350f-481a-b342-f9a167072bbe"},{"name":"Hold a Transaction","id":"5453ecdc-a949-407f-8e2b-07358c88102f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/transactions/:transactionId/hold","description":"To hold a single transaction, use this method.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","transactions",":transactionId","hold"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"b881af18-af78-4584-aa94-0a6be092bcc2","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"1c5f3495-8f46-4da2-9b0c-de2f85dc3dfb","description":{"content":"Integer, required. The unique id of the transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"b14d9518-13a2-468c-9cd0-af61415ab88e","name":"Hold a Transaction","originalRequest":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication value"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions/:transactionId/hold","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions",":transactionId","hold"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"transactionId","value":"Integer, required","description":"The unique id of the transaction"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T19:13:11.238Z\",\r\n \"endTime\": \"2018-08-06T19:13:11.238Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"5453ecdc-a949-407f-8e2b-07358c88102f"},{"name":"Hold Multiple Transactions","id":"bbed07f0-0a59-4391-90db-45eb47089244","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key value
\n"}],"body":{"mode":"raw","raw":"{\r\n \"id\": [\r\n 0\r\n ],\r\n \"arn\": [\r\n \"string\"\r\n ],\r\n \"authorizationCode\": [\r\n \"string\"\r\n ],\r\n \"authorizationSource\": [\r\n \"string\"\r\n ],\r\n \"authorizationResponse\": [\r\n \"string\"\r\n ],\r\n \"authorizationAmount\": [\r\n 0\r\n ],\r\n \"transactionAmount\": [\r\n 0\r\n ],\r\n \"submerchantBatchId\": [\r\n \"string\"\r\n ],\r\n \"currency\": [\r\n \"string\"\r\n ],\r\n \"cardBin\": [\r\n \"string\"\r\n ],\r\n \"cardLastFour\": [\r\n \"string\"\r\n ],\r\n \"cardType\": [\r\n \"string\"\r\n ],\r\n \"network\": [\r\n \"Unknown\"\r\n ],\r\n \"issuingBankID\": [\r\n \"string\"\r\n ],\r\n \"interchangeFee\": [\r\n 0\r\n ],\r\n \"networkFees\": [\r\n 0\r\n ],\r\n \"processorFee\": [\r\n 0\r\n ],\r\n \"assessmentFee\": [\r\n 0\r\n ],\r\n \"payfacFee\": [\r\n 0\r\n ],\r\n \"sourceDataEventId\": [\r\n 0\r\n ],\r\n \"processorMID\": [\r\n \"string\"\r\n ],\r\n \"transactionType\": [\r\n \"Deposit\"\r\n ],\r\n \"onHold\": [\r\n true\r\n ],\r\n \"terminalId\": [\r\n \"string\"\r\n ],\r\n \"fundingStatus\": [\r\n \"New\"\r\n ],\r\n \"processorTransactionID\": [\r\n \"string\"\r\n ],\r\n \"submerchantName\": [\r\n \"string\"\r\n ],\r\n \"submerchantId\": [\r\n 0\r\n ],\r\n \"submerchantDbaName\": [\r\n \"string\"\r\n ],\r\n \"extendedData\": [\r\n \"string\"\r\n ],\r\n \"interchangeCode\": [\r\n \"string\"\r\n ],\r\n \"gatewayReferenceId\": [\r\n \"string\"\r\n ],\r\n \"partnerReferenceId\": [\r\n \"string\"\r\n ],\r\n \"depositId\": [\r\n 0\r\n ]\r\n}"},"url":"{{BaseURL}}/api/:tenantId/transactions/holdmultiple","description":"If there are multiple transactions that need to be held, you can use this method to hold them at once. The body contains the transaction ids that need to be held.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","transactions","holdmultiple"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"727585e3-7d31-4dd6-8bda-25723faf9724","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"668dd582-a97d-4e5d-98bf-1f30ca4d5cd4","name":"Hold Multiple Transactions","originalRequest":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"[\r\n 0\r\n]"},"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions/holdmultiple","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions","holdmultiple"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T16:21:06.336Z\",\r\n \"endTime\": \"2018-08-06T16:21:06.336Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"bbed07f0-0a59-4391-90db-45eb47089244"},{"name":"Release Multiple Transactions","id":"1baadb85-81aa-474b-b449-663ff17dabac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"{\r\n \"id\": [\r\n 0\r\n ],\r\n \"arn\": [\r\n \"string\"\r\n ],\r\n \"authorizationCode\": [\r\n \"string\"\r\n ],\r\n \"authorizationSource\": [\r\n \"string\"\r\n ],\r\n \"authorizationResponse\": [\r\n \"string\"\r\n ],\r\n \"authorizationAmount\": [\r\n 0\r\n ],\r\n \"transactionAmount\": [\r\n 0\r\n ],\r\n \"submerchantBatchId\": [\r\n \"string\"\r\n ],\r\n \"currency\": [\r\n \"string\"\r\n ],\r\n \"cardBin\": [\r\n \"string\"\r\n ],\r\n \"cardLastFour\": [\r\n \"string\"\r\n ],\r\n \"cardType\": [\r\n \"string\"\r\n ],\r\n \"network\": [\r\n \"Unknown\"\r\n ],\r\n \"issuingBankID\": [\r\n \"string\"\r\n ],\r\n \"interchangeFee\": [\r\n 0\r\n ],\r\n \"networkFees\": [\r\n 0\r\n ],\r\n \"processorFee\": [\r\n 0\r\n ],\r\n \"assessmentFee\": [\r\n 0\r\n ],\r\n \"payfacFee\": [\r\n 0\r\n ],\r\n \"sourceDataEventId\": [\r\n 0\r\n ],\r\n \"processorMID\": [\r\n \"string\"\r\n ],\r\n \"transactionType\": [\r\n \"Deposit\"\r\n ],\r\n \"onHold\": [\r\n true\r\n ],\r\n \"terminalId\": [\r\n \"string\"\r\n ],\r\n \"fundingStatus\": [\r\n \"New\"\r\n ],\r\n \"processorTransactionID\": [\r\n \"string\"\r\n ],\r\n \"submerchantName\": [\r\n \"string\"\r\n ],\r\n \"submerchantId\": [\r\n 0\r\n ],\r\n \"submerchantDbaName\": [\r\n \"string\"\r\n ],\r\n \"extendedData\": [\r\n \"string\"\r\n ],\r\n \"interchangeCode\": [\r\n \"string\"\r\n ],\r\n \"gatewayReferenceId\": [\r\n \"string\"\r\n ],\r\n \"partnerReferenceId\": [\r\n \"string\"\r\n ],\r\n \"depositId\": [\r\n 0\r\n ]\r\n}"},"url":"{{BaseURL}}/api/:tenantId/transactions/releasemultiple","description":"If there are multiple held transactions, you can use this method to release them at once. The body contains the transaction ids that need to be released.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","transactions","releasemultiple"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"de72ef00-dfd8-438e-9db7-90680850c5c8","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"091a57f2-3ec8-4844-b1e4-78b7d9a31b59","name":"Release Multiple Transactions","originalRequest":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"[\r\n 0\r\n]"},"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions/releasemultiple","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions","releasemultiple"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T16:15:00.161Z\",\r\n \"endTime\": \"2018-08-06T16:15:00.161Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"1baadb85-81aa-474b-b449-663ff17dabac"},{"name":"Release a Transaction","id":"3ad84c75-1592-4432-939b-89cdc687cb88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/transactions/:transactionId/release","description":"To release a single transaction, use this method.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","transactions",":transactionId","release"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"4ce4b137-0e4f-4aae-92ed-975d36394fd3","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"e817c603-7392-4515-816a-4a1d123fffa1","description":{"content":"Integer, required. The unique id of the transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"37a9222d-ca4c-4b70-a49e-c26c57d487be","name":"Release a Transaction","originalRequest":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions/:transactionId/release","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions",":transactionId","release"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"transactionId","value":"Integer, required","description":"The unique id of the transaction"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T19:13:11.238Z\",\r\n \"endTime\": \"2018-08-06T19:13:11.238Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"3ad84c75-1592-4432-939b-89cdc687cb88"},{"name":"Release Transactions to Fund","id":"10a8ffea-d791-40f2-86ec-95bc5c568f7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","type":"text","value":""},{"description":"The authentication key secret
\n","key":"x-AuthenticationKeyValue","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"ARN\" : [\"74445008204300343822335\"]\r\n}"},"url":"{{BaseURL}}/api/:tenant/transactions/releasemultiple/filter","description":"If you need to board submerchants that require all transactions to be held until a specific date for funding, use this method. You will also need to setup the BackOffice boarding service to automatically hold all submerchant transactions in the boarding application.
\nAdd the ARN (Acquirer Reference Number) of each transaction that needs to be released.
\n","urlObject":{"path":["api",":tenant","transactions","releasemultiple","filter"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"08fb81e1-0017-4074-85f8-f89f0c3623a2","description":{"content":"String, required. The tenant's unique id
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"}]}},"response":[{"id":"2c490ed6-8245-4380-ac8f-837b47250ff2","name":"Release Transactions to Fund","originalRequest":{"method":"GET","header":[{"description":"The authentication key","key":"x-AuthenticationKeyId","type":"text","value":""},{"description":"The authentication key secret","key":"x-AuthenticationKeyValue","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"ARN\" : [\"74445008204300343822335\"]\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenant/transactions/releasemultiple/filter","host":["{{BaseURL}}"],"path":["api",":tenant","transactions","releasemultiple","filter"],"variable":[{"description":"String, required. The tenant's unique id","key":"tenant","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"eaa400bb-46d7-471c-ab92-15f7855ff012\",\r\n \"status\": 0,\r\n \"createTime\": \"2019-02-22T22:40:23.7901192+00:00\",\r\n \"endTime\": null,\r\n \"error\": null,\r\n \"message\": null\r\n}"}],"_postman_id":"10a8ffea-d791-40f2-86ec-95bc5c568f7c"},{"name":"Import Transactions","id":"34ed5bdb-5002-4e0d-bbb0-23aa5179daef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/dataimport/transactions","description":"You can use this to import transactions for a submerchant, as long as the transactions are available in the configured locations.
\n","urlObject":{"path":["api",":tenantId","dataimport","transactions"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"81e6bc93-e29c-43b0-bae5-a1508406a8d5","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"2bd342aa-9b5c-4ee5-afab-eb9de5dcb28a","name":"Import Transactions","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/dataimport/transactions","host":["{{BaseURL}}"],"path":["api",":tenantId","dataimport","transactions"],"variable":[{"key":"tenantId","value":"Tenant1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"34ed5bdb-5002-4e0d-bbb0-23aa5179daef"},{"name":"Create a Transaction","id":"fab8b791-b4f2-4c7c-9af6-f5ac41fbb0dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","type":"text","value":""},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n","type":"text"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": 0,\r\n \"transactionDate\": \"2019-06-27T18:39:42.743Z\",\r\n \"arn\": \"string\",\r\n \"authorizationCode\": \"string\",\r\n \"authorizationSource\": \"string\",\r\n \"authorizationResponse\": \"string\",\r\n \"authorizationAmount\": 0,\r\n \"transactionAmount\": 0,\r\n \"submerchantBatchId\": \"string\",\r\n \"currency\": \"string\",\r\n \"cardBin\": \"string\",\r\n \"cardLastFour\": \"string\",\r\n \"cardType\": \"string\",\r\n \"network\": \"Unknown\",\r\n \"issuingBankID\": \"string\",\r\n \"interchangeFee\": 0,\r\n \"networkFees\": 0,\r\n \"processorFee\": 0,\r\n \"assessmentFee\": 0,\r\n \"payfacFee\": 0,\r\n \"sourceDataEventId\": 0,\r\n \"processorMID\": \"string\",\r\n \"transactionType\": \"Deposit\",\r\n \"onHold\": true,\r\n \"terminalId\": \"string\",\r\n \"fundingStatus\": \"New\",\r\n \"feeFundingStatus\": \"New\",\r\n \"processorTransactionID\": \"string\",\r\n \"submerchantName\": \"string\",\r\n \"submerchantId\": 0,\r\n \"submerchantDbaName\": \"string\",\r\n \"settlementDate\": \"2019-06-27T18:39:42.743Z\",\r\n \"extendedData\": \"string\",\r\n \"interchangeCode\": \"string\",\r\n \"interchangeLevel\": \"string\",\r\n \"feeSettlementDate\": \"2019-06-27T18:39:42.743Z\",\r\n \"gatewayReferenceId\": \"string\",\r\n \"partnerReferenceId\": \"string\",\r\n \"tipAmount\": 0,\r\n \"totalFees\": 0,\r\n \"netAmount\": 0,\r\n \"depositIds\": [\r\n 0\r\n ],\r\n \"feeProfileType\": \"FlatRate\",\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-06-27T18:39:42.744Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ]\r\n }\r\n]"},"url":"{{BaseURL}}/api/:tenantId/transactions","description":"Use this method to create a transaction. To ensure you're creating a new transaction, the cardBin, cardLastFour, or authorizationCode must be unique.
To tie the transaction to a submechant, the submerchantId is evaluated first. If this doesn't match an existing submerchant, the processorMID is used.
Schema
\n","urlObject":{"path":["api",":tenantId","transactions"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"e6e464d7-f357-4402-a9e8-cc66b6659b12","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"9ade6ac3-0772-47f4-bed7-5d7366b6c4d6","name":"Create a Transaction","originalRequest":{"method":"POST","header":[{"key":"AuthenticationKey","value":"{{AuthenticationToken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": 0,\r\n \"transactionDate\": \"2019-06-27T18:39:42.743Z\",\r\n \"arn\": \"string\",\r\n \"authorizationCode\": \"string\",\r\n \"authorizationSource\": \"string\",\r\n \"authorizationResponse\": \"string\",\r\n \"authorizationAmount\": 0,\r\n \"transactionAmount\": 0,\r\n \"submerchantBatchId\": \"string\",\r\n \"currency\": \"string\",\r\n \"cardBin\": \"string\",\r\n \"cardLastFour\": \"string\",\r\n \"cardType\": \"string\",\r\n \"network\": \"Unknown\",\r\n \"issuingBankID\": \"string\",\r\n \"interchangeFee\": 0,\r\n \"networkFees\": 0,\r\n \"processorFee\": 0,\r\n \"assessmentFee\": 0,\r\n \"payfacFee\": 0,\r\n \"sourceDataEventId\": 0,\r\n \"processorMID\": \"string\",\r\n \"transactionType\": \"Deposit\",\r\n \"onHold\": true,\r\n \"terminalId\": \"string\",\r\n \"fundingStatus\": \"New\",\r\n \"feeFundingStatus\": \"New\",\r\n \"processorTransactionID\": \"string\",\r\n \"submerchantName\": \"string\",\r\n \"submerchantId\": 0,\r\n \"submerchantDbaName\": \"string\",\r\n \"settlementDate\": \"2019-06-27T18:39:42.743Z\",\r\n \"extendedData\": \"string\",\r\n \"interchangeCode\": \"string\",\r\n \"interchangeLevel\": \"string\",\r\n \"feeSettlementDate\": \"2019-06-27T18:39:42.743Z\",\r\n \"gatewayReferenceId\": \"string\",\r\n \"partnerReferenceId\": \"string\",\r\n \"tipAmount\": 0,\r\n \"totalFees\": 0,\r\n \"netAmount\": 0,\r\n \"depositIds\": [\r\n 0\r\n ],\r\n \"feeProfileType\": \"FlatRate\",\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-06-27T18:39:42.744Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ]\r\n }\r\n]"},"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"commandFingerprint\": \"89a09a36-bacf-4fb2-8906-4003df2be064\",\n \"status\": 0,\n \"createTime\": \"2019-01-08T18:12:23.2668373+00:00\",\n \"endTime\": null,\n \"error\": null,\n \"message\": null\n}"}],"_postman_id":"fab8b791-b4f2-4c7c-9af6-f5ac41fbb0dd"}],"id":"95d4e6de-c3e0-45e8-9306-b2bcfcb90b3a","description":"Transactions represents a single instance of a user purchasing something from the submerchant. Transactions displays with a breakdown of Interchange & Network Fees, Processor Fees, and Payfac Revenue.
\nResponse Schema
\nMerchant Identifiers
\nNotes
\n","event":[{"listen":"prerequest","script":{"id":"8e1b9497-aa57-45be-b02a-440bb3e08a6a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"80c3e695-6a2d-40a8-ba15-f5a7d2085ed4","type":"text/javascript","exec":[""]}}],"_postman_id":"95d4e6de-c3e0-45e8-9306-b2bcfcb90b3a"},{"name":"Chargebacks","item":[{"name":"Chargeback Documents","item":[{"name":"Review a Chargeback's Document","id":"7f7f9b4e-6ef0-42a4-8c6c-39aa94f4f83c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/Chargebacks/documents/:chargebackId/:documentId","description":"Use this method to review a chargeback's document.
\n","urlObject":{"path":["api",":tenantId","Chargebacks","documents",":chargebackId",":documentId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"77f9d12d-b7f7-4d2d-ba64-feeba5b8702b","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"dc69e98a-304e-4666-90eb-d5e96ae1145d","description":{"content":"Integer, requried. The unique id of the chargeback
\n","type":"text/plain"},"type":"string","value":"","key":"chargebackId"},{"id":"44f0876a-8c6c-4a2a-bd91-efe43b11df05","description":{"content":"Integer, requried. The unique id of the document
\n","type":"text/plain"},"type":"string","value":"","key":"documentId"}]}},"response":[{"id":"f1a33ccc-1160-41dc-a397-772d1673ef3a","name":"Review a Chargeback's Document","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/documents/:chargebackId/:documentId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","documents",":chargebackId",":documentId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"chargebackId","value":"Integer, requried","description":"The unique id of the chargeback"},{"key":"documentId","value":"Integer, requried","description":"The unique id of the document"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T16:31:15.252Z\",\r\n \"endTime\": \"2018-08-06T16:31:15.252Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"7f7f9b4e-6ef0-42a4-8c6c-39aa94f4f83c"},{"name":"Review a Chargeback's Documents","id":"10f3b8ea-8742-4e57-848c-69a7363bf2ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/Chargebacks/documents/:chargebackId","description":"Use this method to view the types of documents uploaded to a chargeback.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","Chargebacks","documents",":chargebackId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"025d91a5-7b94-45db-9048-84867c0b7070","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"7e9aa510-59ad-4042-9202-f6364cf568a8","description":{"content":"Integer, required. The unique id of the chargeback
\n","type":"text/plain"},"type":"string","value":"","key":"chargebackId"}]}},"response":[{"id":"5579ae4d-64ff-435f-985a-746650db9523","name":"Review Chargeback Documents","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/documents/:chargebackId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","documents",":chargebackId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"chargebackId","value":"Integer, required","description":"The unique id of the chargeback"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 0,\r\n \"path\": \"string\",\r\n \"name\": \"string\",\r\n \"documentType\": \"string\",\r\n \"documentTypeName\": \"string\",\r\n \"chargebackId\": 0,\r\n \"userId\": 0,\r\n \"username\": \"string\",\r\n \"date\": \"2018-08-03T23:22:11.584Z\",\r\n \"dateLocal\": \"2018-08-03T23:22:11.584Z\"\r\n }\r\n]"}],"_postman_id":"10f3b8ea-8742-4e57-848c-69a7363bf2ef"},{"name":"Upload Chargeback Documents","id":"81f28449-4471-4b39-9fcd-b38ac1457c00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"{\r\n \"documentType\": 0,\r\n \"fileName\": \"string\",\r\n \"documentTypeName\": \"string\",\r\n \"fileByteArray\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/documents/:chargebackId","description":"Use this method to create a chargeback document.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","Chargebacks","documents",":chargebackId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"b1e59324-bf62-455b-955b-61264750c653","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"85aa6143-0162-411f-8102-f7db04e44c27","description":{"content":"Integer, required. The unique id of the chargeback
\n","type":"text/plain"},"type":"string","value":"","key":"chargebackId"}]}},"response":[{"id":"67a5339f-ceea-4687-9680-a0011e6d4a0b","name":"Create Chargeback Documents","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"{\r\n \"documentType\": 0,\r\n \"fileName\": \"string\",\r\n \"documentTypeName\": \"string\",\r\n \"fileByteArray\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/documents/:chargebackId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","documents",":chargebackId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"chargebackId","value":"Integer, required","description":"The unique id of the chargeback"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-03T23:28:25.488Z\",\r\n \"endTime\": \"2018-08-03T23:28:25.488Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"81f28449-4471-4b39-9fcd-b38ac1457c00"},{"name":"Delete a Chargeback Document","id":"bf448920-3ad7-4ef8-91a4-462eddb59e0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\"username\""},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/documents/delete/:documentId","description":"Use this method to delete a chargeback document. The body contains the username who deleted the document.
\n","urlObject":{"path":["api",":tenantId","Chargebacks","documents","delete",":documentId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"description":{"content":"Integer, required. The unique id of the document
\n","type":"text/plain"},"type":"string","value":"","key":"documentId"}]}},"response":[{"id":"f26083b6-299f-4c44-9fb8-d33a55cd92a1","name":"Delete a Chargeback Document","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\"Jane Doe\""},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/documents/delete/:documentId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","documents","delete",":documentId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"documentId","value":"Integer, required","description":"The unique id of the document"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T20:44:44.023Z\",\r\n \"endTime\": \"2018-08-06T20:44:44.023Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"bf448920-3ad7-4ef8-91a4-462eddb59e0d"}],"id":"9b40970c-dde4-4517-98a2-f55a9a1ecdde","description":"Documents can be uploaded to chargebacks to provide required information to resolve the chargeback.
\nThe document types are:\n1 = Invoice\n2 = ProofOfShipping\n3 = Other
The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/Chargebacks/notes/:chargebackId","description":"Use this method to review a chargeback's note.
\n","urlObject":{"path":["api",":tenantId","Chargebacks","notes",":chargebackId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"9bfc8fdc-ecdc-4694-8d3c-a5854ca3ec6c","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"80863d5d-5162-4e44-a03c-e68d7ec66631","description":{"content":"Integer, required. The unique id of the chargeback
\n","type":"text/plain"},"type":"string","value":"","key":"chargebackId"}]}},"response":[{"id":"532a73f3-b65c-4220-a6a7-a252d4a459d1","name":"Review a Chargeback Note","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/notes/:chargebackId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","notes",":chargebackId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"chargebackId","value":"Integer, required","description":"The unique id of the chargeback"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T21:22:32.683Z\",\r\n \"endTime\": \"2018-08-06T21:22:32.683Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"19c3a13e-8290-460c-9f6d-c66d1b237220"},{"name":"Create a Chargeback Note","id":"7ad5d309-fcef-4630-8fdc-3b6f981c1fa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"noteType\": \"NoteInternal\",\r\n \"message\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/notes/:chargebackId","description":"Use this method to create a chargeback note.
\n","urlObject":{"path":["api",":tenantId","Chargebacks","notes",":chargebackId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"description":{"content":"Integer, required. The unique id of the chargeback
\n","type":"text/plain"},"type":"string","value":"","key":"chargebackId"}]}},"response":[{"id":"bd03437d-02a3-420a-8759-5fdf9ceb6108","name":"Create a Chargeback Note","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"{\r\n \"noteType\": \"NoteInternal\",\r\n \"message\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/notes/:chargebackId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","notes",":chargebackId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"chargebackId","value":"Integer, required","description":"The unique id of the chargeback"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T21:22:32.683Z\",\r\n \"endTime\": \"2018-08-06T21:22:32.683Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"7ad5d309-fcef-4630-8fdc-3b6f981c1fa8"},{"name":"Update Chargeback Note","id":"51d5e30e-e4e7-4a75-94ea-9dd38301ce41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"noteType\": \"NoteInternal\",\r\n \"message\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/notes/update/:noteId","description":"Use this method to update a chargeback note.
\n","urlObject":{"path":["api",":tenantId","Chargebacks","notes","update",":noteId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"description":{"content":"Integer, required. The unique id of the note
\n","type":"text/plain"},"type":"string","value":"","key":"noteId"}]}},"response":[{"id":"afc03a70-4200-410e-98da-98dfad8ab284","name":"Update Chargeback Note","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"{\r\n \"noteType\": \"NoteInternal\",\r\n \"message\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/notes/update/:noteId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","notes","update",":noteId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"noteId","value":"Integer, required","description":"The unique id of the note"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T21:31:11.768Z\",\r\n \"endTime\": \"2018-08-06T21:31:11.768Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"51d5e30e-e4e7-4a75-94ea-9dd38301ce41"},{"name":"Delete a Chargeback Note","id":"894e9b1b-04fd-4afe-a738-03e7b3e5deb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\"username\""},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/notes/delete/:noteId","description":"Use this method to delete a chargeback note. The body contains the user who deleted the note.
\n","urlObject":{"path":["api",":tenantId","Chargebacks","notes","delete",":noteId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"description":{"content":"Integer, required. The unique id of the note
\n","type":"text/plain"},"type":"string","value":"","key":"noteId"}]}},"response":[{"id":"fe7640f6-0016-4388-b0a7-d03b0784b7a4","name":"Delete a Chargeback Note","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\"Jane Doe\""},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/notes/delete/:noteId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","notes","delete",":noteId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"noteId","value":"Integer, required","description":"The unique id of the note"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T21:37:25.133Z\",\r\n \"endTime\": \"2018-08-06T21:37:25.133Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"894e9b1b-04fd-4afe-a738-03e7b3e5deb0"}],"id":"07b6a698-4ae7-4fab-8510-a5a0c94a0c05","description":"Payfacs and submerchants can add notes to chargebacks. Payfacs can select if a note is interal (viewable by the payfac only) or public (viewable by the payfac and submerchant).
\nAll methods use the same schema.
\nSchema
\nResponse Schema
\n","event":[{"listen":"prerequest","script":{"id":"5ecce944-67b3-44e6-b44f-2c89cda1337e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6d510804-38c7-4887-9cfe-3ada217b4b41","type":"text/javascript","exec":[""]}}],"_postman_id":"07b6a698-4ae7-4fab-8510-a5a0c94a0c05"},{"name":"Chargeback Member Message Block","item":[{"name":"Create a Chargeback Member Message Block","id":"afa9dfb1-58ad-4bfd-908a-4492bcbaf27c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"{\r\n \"noteType\": \"NoteInternal\",\r\n \"message\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/messageblock/:chargebackId","description":"Use this method to create a chargeback member message block.
\n","urlObject":{"path":["api",":tenantId","Chargebacks","messageblock",":chargebackId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"660867cc-f1f1-4cfd-b153-4b34a2a72ef9","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"c79b758e-9b1c-4086-801b-c5ed02c91484","description":{"content":"Integer, required. The unique id of the chargeback
\n","type":"text/plain"},"type":"string","value":"","key":"chargebackId"}]}},"response":[{"id":"44f1e7ab-467a-43c9-92d5-f1f68be182a6","name":"Create a Chargeback Member Message Block","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"{\r\n \"noteType\": \"NoteInternal\",\r\n \"message\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/messageblock/:chargebackId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","messageblock",":chargebackId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"chargebackId","value":"Integer, required","description":"The unique id of the chargeback"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T21:38:26.874Z\",\r\n \"endTime\": \"2018-08-06T21:38:26.874Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"afa9dfb1-58ad-4bfd-908a-4492bcbaf27c"},{"name":"Update a Chargeback Member Message Block","id":"89422287-388c-4838-95a1-a8be49d62e0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"{\r\n \"noteType\": \"NoteInternal\",\r\n \"message\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/messageblock/update/:messageBlockId","description":"Use this method to update an existing chargeback member message block.
\n","urlObject":{"path":["api",":tenantId","Chargebacks","messageblock","update",":messageBlockId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"3f4d3b62-6186-4bc7-a369-24a71c4a40a5","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"6286cf50-4d9a-4b57-8d32-aae778724dad","description":{"content":"Integer, required. The unique id of the message block
\n","type":"text/plain"},"type":"string","value":"","key":"messageBlockId"}]}},"response":[{"id":"3be42324-387d-43b7-b8a3-cfe5e2a3c663","name":"Update a Chargeback Message Block","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"{\r\n \"noteType\": \"NoteInternal\",\r\n \"message\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/messageblock/update/:messageBlockId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","messageblock","update",":messageBlockId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"messageBlockId","value":"Integer, required","description":"The unique id of the message block"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T16:24:56.955Z\",\r\n \"endTime\": \"2018-08-06T16:24:56.956Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"89422287-388c-4838-95a1-a8be49d62e0a"},{"name":"Delete a Chargeback Member Message Block","id":"665dd4aa-f076-4570-b82f-022a4612588a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"\"string\""},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/messageblock/delete/:messageBlockId","description":"Use this method to delete a chargeback member message block. The body contains the user who deleted the chargeback member message block.
\n","urlObject":{"path":["api",":tenantId","Chargebacks","messageblock","delete",":messageBlockId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"1ec617e8-e370-4e8f-a287-6c3025d6a28d","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"a52cda3e-f6f5-4699-a803-e2d839cce557","description":{"content":"Integer, required. The unique id of the message block
\n","type":"text/plain"},"type":"string","value":"","key":"messageBlockId"}]}},"response":[{"id":"3aa1fca6-c2dc-4fd4-ab85-220d37e2576e","name":"Delete a Chargeback Member Message Block","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/messageblock/delete/:messageBlockId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","messageblock","delete",":messageBlockId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"messageBlockId","value":"Integer, required","description":"The unique id of the message block"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T21:39:02.798Z\",\r\n \"endTime\": \"2018-08-06T21:39:02.798Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"665dd4aa-f076-4570-b82f-022a4612588a"}],"id":"30d8dcf1-25b7-4e3b-9c39-3623292f546f","description":"The chargeback member message block displays messages from the processor or card brand that is viewable to the payment facilitator. The chargeback member message block doesn't display in the submerchant portal.
\nAll methods use the same schema.
\nSchema
\nResponse Schema
\n","event":[{"listen":"prerequest","script":{"id":"592ee3eb-a460-4228-8047-f79964574d53","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"919bef02-87ee-4d3f-abe2-17d73cf8a086","type":"text/javascript","exec":[""]}}],"_postman_id":"30d8dcf1-25b7-4e3b-9c39-3623292f546f"},{"name":"Review Chargebacks","id":"6f3e5ec9-bf73-4e39-81ca-5019d357fbe0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/Chargebacks","description":"Use this method to review all chargebacks for a a tenant.
\n","urlObject":{"path":["api",":tenantId","Chargebacks"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"af630b9c-fd9a-43f5-8bcd-12fbb829b7ec","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"String, required","key":"tenantId"}]}},"response":[{"id":"81349720-11dd-45c9-b263-e7d721e85b19","name":"Review Chargebacks","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"submerchantId\": 0,\n \"submerchant\": \"string\",\n \"statusId\": 0,\n \"statusName\": \"string\",\n \"fee\": 0,\n \"caseID\": \"string\",\n \"reasonCode\": \"string\",\n \"message\": \"string\",\n \"chargebackType\": 0,\n \"chargebackDate\": \"2018-08-03T23:06:47.626Z\",\n \"createdDate\": \"2018-08-03T23:06:47.626Z\",\n \"merchantActionDate\": \"2018-08-03T23:06:47.626Z\",\n \"merchantActionUser\": \"string\",\n \"amount\": 0,\n \"merchantIdentifiers\": []\n }\n]"}],"_postman_id":"6f3e5ec9-bf73-4e39-81ca-5019d357fbe0"},{"name":"Review a Single Chargeback","id":"cc6c683c-2953-419f-817e-e2b1bee604e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/Chargebacks/:chargebackId","description":"Use this method to review a single chargeback.
\n","urlObject":{"path":["api",":tenantId","Chargebacks",":chargebackId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"17340d7e-2da0-46e2-ae4c-bfcf9b387e98","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"36d64496-2c3a-4588-9758-d991a62ef2e9","description":{"content":"Integer, required. The unique id of the chargeback
\n","type":"text/plain"},"type":"string","value":"","key":"chargebackId"}]}},"response":[{"id":"23e20aab-9c21-4d36-af46-cd501c4260b3","name":"Review a Single Chargeback","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/:chargebackId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks",":chargebackId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"chargebackId","value":"Integer, required","description":"The unique id of the chargeback"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 0,\n \"transactionId\": 0,\n \"submerchantId\": 0,\n \"submerchant\": \"string\",\n \"statusId\": 0,\n \"statusName\": \"string\",\n \"fee\": 0,\n \"caseID\": \"string\",\n \"reasonCode\": \"string\",\n \"message\": \"string\",\n \"chargebackType\": 0,\n \"chargebackDate\": \"2018-08-03T23:19:47.017Z\",\n \"createdDate\": \"2018-08-03T23:19:47.017Z\",\n \"merchantActionDate\": \"2018-08-03T23:19:47.017Z\",\n \"merchantActionUser\": \"string\",\n \"amount\": 0,\n \"merchantIdentifiers\": []\n}"}],"_postman_id":"cc6c683c-2953-419f-817e-e2b1bee604e2"},{"name":"Create Chargebacks","id":"d23695fb-a4f2-42e0-8e80-cbc65139fcb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/dataimport/chargebacks","description":"Use this method to create a chargeback if the file is in the configured location.
\n","urlObject":{"path":["api",":tenantId","dataimport","chargebacks"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"bdc2dc28-d86e-4924-94fb-416368e05cec","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"e4956671-4f2f-45ed-8d3d-3a8638523042","name":"Import Chargebacks","originalRequest":{"method":"POST","header":[{"key":"AuthenticationKey","value":"{{AuthenticationToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/dataimport/chargebacks","host":["{{BaseURL}}"],"path":["api",":tenantId","dataimport","chargebacks"],"variable":[{"key":"tenantId","value":"Tenant1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"d23695fb-a4f2-42e0-8e80-cbc65139fcb3"},{"name":"Change a Chargeback Status","id":"867f13d3-b390-4216-96f0-7e3129374ca6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"\"string\""},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/changestatus/:chargebackId?Status=","description":"Use this method to change a chargeback's status. The body contains the username that changed the status. The statuses are:
\nThe new chargeback status
\n","type":"text/plain"},"key":"Status","value":""}],"variable":[{"id":"15e371e6-3a9b-4365-b986-17fe8477033f","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"b79da5d8-c089-4d47-9a44-8b84d9543027","description":{"content":"Integer, required. The unique id of the chargeback
\n","type":"text/plain"},"type":"string","value":"","key":"chargebackId"}]}},"response":[{"id":"a0b6bd21-27af-4aa7-a363-59bf12ddd658","name":"Change a Chargeback Status","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/changestatus/:chargebackId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","changestatus",":chargebackId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"chargebackId","value":"Integer, required","description":"The unique id of the chargeback"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T21:40:27.532Z\",\r\n \"endTime\": \"2018-08-06T21:40:27.532Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"867f13d3-b390-4216-96f0-7e3129374ca6"},{"name":"Update Chargeback Notifications Setting","id":"b4c744f4-4629-4c17-86d7-49adc2189266","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/Chargebacks/notification/:settingsId","urlObject":{"path":["api",":tenantId","Chargebacks","notification",":settingsId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"c8abb01c-fa23-49af-abdd-d7ebd188f404","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"cc9e25a2-c3d1-4ff7-b23e-812585c31b4e","description":{"content":"Integer, required. The unique id of the settings
\n","type":"text/plain"},"type":"string","value":"","key":"settingsId"}]}},"response":[{"id":"bb785476-f5a0-4ecf-81b4-befca828d146","name":"Update Chargeback Notifications Setting","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/Chargebacks/notification/:settingsId","host":["{{BaseURL}}"],"path":["api",":tenantId","Chargebacks","notification",":settingsId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"settingsId","value":"Integer, required","description":"The unique id of the settings"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-06T22:25:37.086Z\",\r\n \"endTime\": \"2018-08-06T22:25:37.086Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"b4c744f4-4629-4c17-86d7-49adc2189266"}],"id":"6f205c9f-0f90-4ca6-b347-620fc367e791","description":"A chargeback is something that a customer may issue through their bank if they purchased an unsatisfactory product or were a victim of fraud.
\nResponse Schema
\nMerchant Identifiers
\n","event":[{"listen":"prerequest","script":{"id":"5df3282a-bf04-40af-a41d-b924b925ab03","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"adb76b33-9936-4641-a173-9c1bc2a27de0","type":"text/javascript","exec":[""]}}],"_postman_id":"6f205c9f-0f90-4ca6-b347-620fc367e791"},{"name":"Deposits","item":[{"name":"Review All Deposits","id":"2ea5910c-aa6e-420d-8dc1-b769744e7230","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantid/fundinginstructions","description":"Use this to review all deposits for a tenant.
\n","urlObject":{"path":["api",":tenantid","fundinginstructions"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"a7f12df9-6b8d-4b3b-ba1b-041f1919c5a8","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantid"}]}},"response":[{"id":"06ef6cd3-c1f5-49a2-a9dc-68809afddcf0","name":"Review Deposits","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/fundinginstructions","host":["{{BaseURL}}"],"path":["api",":tenantId","fundinginstructions"],"variable":[{"key":"tenantId","value":"Tenant1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 0,\r\n \"createdDate\": \"2019-10-01T15:46:30.756Z\",\r\n \"status\": \"New\",\r\n \"modifiedDate\": \"2019-10-01T15:46:30.756Z\",\r\n \"salesCount\": 0,\r\n \"salesTotal\": 0,\r\n \"refundCount\": 0,\r\n \"refundTotal\": 0,\r\n \"chargebackCount\": 0,\r\n \"chargebackTotal\": 0,\r\n \"grossDepositAmount\": 0,\r\n \"interchangeFees\": 0,\r\n \"networkFees\": 0,\r\n \"processorFees\": 0,\r\n \"payfacRevenue\": 0,\r\n \"totalFees\": 0,\r\n \"netDepositAmount\": 0,\r\n \"type\": \"Transactions\",\r\n \"submerchantDeposits\": [\r\n {\r\n \"id\": 0,\r\n \"fundingDepositId\": 0,\r\n \"submerchantId\": 0,\r\n \"submerchantDbaName\": \"string\",\r\n \"submerchantLegalEntityName\": \"string\",\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"createdDate\": \"2019-10-01T15:46:30.756Z\",\r\n \"status\": \"New\",\r\n \"modifiedDate\": \"2019-10-01T15:46:30.756Z\",\r\n \"salesCount\": 0,\r\n \"salesTotal\": 0,\r\n \"refundCount\": 0,\r\n \"refundTotal\": 0,\r\n \"chargebackCount\": 0,\r\n \"chargebackTotal\": 0,\r\n \"grossDepositAmount\": 0,\r\n \"interchangeFees\": 0,\r\n \"networkFees\": 0,\r\n \"processorFees\": 0,\r\n \"payfacRevenue\": 0,\r\n \"totalFees\": 0,\r\n \"netDepositAmount\": 0,\r\n \"type\": \"Transactions\",\r\n \"timing\": \"NextDay\",\r\n \"transactions\": [\r\n {\r\n \"id\": 0,\r\n \"transactionDate\": \"2019-10-01T15:46:30.756Z\",\r\n \"arn\": \"string\",\r\n \"authorizationCode\": \"string\",\r\n \"authorizationSource\": \"string\",\r\n \"authorizationResponse\": \"string\",\r\n \"authorizationAmount\": 0,\r\n \"transactionAmount\": 0,\r\n \"submerchantBatchId\": \"string\",\r\n \"currency\": \"string\",\r\n \"cardBin\": \"string\",\r\n \"cardLastFour\": \"string\",\r\n \"cardType\": \"string\",\r\n \"network\": \"Unknown\",\r\n \"issuingBankID\": \"string\",\r\n \"interchangeFee\": 0,\r\n \"networkFees\": 0,\r\n \"processorFee\": 0,\r\n \"assessmentFee\": 0,\r\n \"payfacFee\": 0,\r\n \"chargebackFee\": 0,\r\n \"commissionFee\": 0,\r\n \"sourceDataEventId\": 0,\r\n \"processorMID\": \"string\",\r\n \"transactionType\": \"Deposit\",\r\n \"onHold\": true,\r\n \"terminalId\": \"string\",\r\n \"fundingStatus\": \"New\",\r\n \"feeFundingStatus\": \"New\",\r\n \"processorTransactionID\": \"string\",\r\n \"submerchantName\": \"string\",\r\n \"submerchantId\": 0,\r\n \"submerchantDbaName\": \"string\",\r\n \"submerchantStatus\": \"Active\",\r\n \"processedDate\": \"2019-10-01T15:46:30.756Z\",\r\n \"settlementDate\": \"2019-10-01T15:46:30.756Z\",\r\n \"extendedData\": \"string\",\r\n \"interchangeCode\": \"string\",\r\n \"interchangeLevel\": \"string\",\r\n \"feeSettlementDate\": \"2019-10-01T15:46:30.756Z\",\r\n \"gatewayReferenceId\": \"string\",\r\n \"partnerReferenceId\": \"string\",\r\n \"tipAmount\": 0,\r\n \"totalFees\": 0,\r\n \"netAmount\": 0,\r\n \"depositIds\": [\r\n 0\r\n ],\r\n \"feeProfileType\": \"FlatRate\",\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-10-01T15:46:30.756Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"2ea5910c-aa6e-420d-8dc1-b769744e7230"},{"name":"Review Single Deposit","id":"8300146c-14c1-47eb-b943-1a0c5b46b316","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/fundinginstructions/:depositId","description":"Use this to review a single deposit.
\n","urlObject":{"path":["api",":tenantId","fundinginstructions",":depositId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"520cb326-8169-46f4-b6fd-9550211e3405","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"7d37dde6-b4f3-4512-a39e-fe3f4bffcc75","description":{"content":"Integer, required. The unique id of the deposit
\n","type":"text/plain"},"type":"string","value":"","key":"depositId"}]}},"response":[{"id":"f7b97030-7b70-4d79-bc9c-6b6768ec2154","name":"View Deposit","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/fundinginstructions/:depositId","host":["{{BaseURL}}"],"path":["api",":tenantId","fundinginstructions",":depositId"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"depositId","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 0,\r\n \"createdDate\": \"2019-10-01T15:46:47.864Z\",\r\n \"status\": \"New\",\r\n \"modifiedDate\": \"2019-10-01T15:46:47.864Z\",\r\n \"salesCount\": 0,\r\n \"salesTotal\": 0,\r\n \"refundCount\": 0,\r\n \"refundTotal\": 0,\r\n \"chargebackCount\": 0,\r\n \"chargebackTotal\": 0,\r\n \"grossDepositAmount\": 0,\r\n \"interchangeFees\": 0,\r\n \"networkFees\": 0,\r\n \"processorFees\": 0,\r\n \"payfacRevenue\": 0,\r\n \"totalFees\": 0,\r\n \"netDepositAmount\": 0,\r\n \"type\": \"Transactions\",\r\n \"submerchantDeposits\": [\r\n {\r\n \"id\": 0,\r\n \"fundingDepositId\": 0,\r\n \"submerchantId\": 0,\r\n \"submerchantDbaName\": \"string\",\r\n \"submerchantLegalEntityName\": \"string\",\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"createdDate\": \"2019-10-01T15:46:47.864Z\",\r\n \"status\": \"New\",\r\n \"modifiedDate\": \"2019-10-01T15:46:47.864Z\",\r\n \"salesCount\": 0,\r\n \"salesTotal\": 0,\r\n \"refundCount\": 0,\r\n \"refundTotal\": 0,\r\n \"chargebackCount\": 0,\r\n \"chargebackTotal\": 0,\r\n \"grossDepositAmount\": 0,\r\n \"interchangeFees\": 0,\r\n \"networkFees\": 0,\r\n \"processorFees\": 0,\r\n \"payfacRevenue\": 0,\r\n \"totalFees\": 0,\r\n \"netDepositAmount\": 0,\r\n \"type\": \"Transactions\",\r\n \"timing\": \"NextDay\",\r\n \"transactions\": [\r\n {\r\n \"id\": 0,\r\n \"transactionDate\": \"2019-10-01T15:46:47.864Z\",\r\n \"arn\": \"string\",\r\n \"authorizationCode\": \"string\",\r\n \"authorizationSource\": \"string\",\r\n \"authorizationResponse\": \"string\",\r\n \"authorizationAmount\": 0,\r\n \"transactionAmount\": 0,\r\n \"submerchantBatchId\": \"string\",\r\n \"currency\": \"string\",\r\n \"cardBin\": \"string\",\r\n \"cardLastFour\": \"string\",\r\n \"cardType\": \"string\",\r\n \"network\": \"Unknown\",\r\n \"issuingBankID\": \"string\",\r\n \"interchangeFee\": 0,\r\n \"networkFees\": 0,\r\n \"processorFee\": 0,\r\n \"assessmentFee\": 0,\r\n \"payfacFee\": 0,\r\n \"chargebackFee\": 0,\r\n \"commissionFee\": 0,\r\n \"sourceDataEventId\": 0,\r\n \"processorMID\": \"string\",\r\n \"transactionType\": \"Deposit\",\r\n \"onHold\": true,\r\n \"terminalId\": \"string\",\r\n \"fundingStatus\": \"New\",\r\n \"feeFundingStatus\": \"New\",\r\n \"processorTransactionID\": \"string\",\r\n \"submerchantName\": \"string\",\r\n \"submerchantId\": 0,\r\n \"submerchantDbaName\": \"string\",\r\n \"submerchantStatus\": \"Active\",\r\n \"processedDate\": \"2019-10-01T15:46:47.864Z\",\r\n \"settlementDate\": \"2019-10-01T15:46:47.864Z\",\r\n \"extendedData\": \"string\",\r\n \"interchangeCode\": \"string\",\r\n \"interchangeLevel\": \"string\",\r\n \"feeSettlementDate\": \"2019-10-01T15:46:47.864Z\",\r\n \"gatewayReferenceId\": \"string\",\r\n \"partnerReferenceId\": \"string\",\r\n \"tipAmount\": 0,\r\n \"totalFees\": 0,\r\n \"netAmount\": 0,\r\n \"depositIds\": [\r\n 0\r\n ],\r\n \"feeProfileType\": \"FlatRate\",\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-10-01T15:46:47.864Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"8300146c-14c1-47eb-b943-1a0c5b46b316"},{"name":"Review and Submit Deposits","id":"0993b1a9-5c3b-4a37-aecb-26acd6485e4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","value":""},{"description":"The authentication key secret
\n","key":"x-AuthenticationKeyValue","value":""}],"url":"{{BaseURL}}/api/:tenantId/fundinginstructions/createandsubmit","description":"Use this to review and submit deposits with one command.
\n","urlObject":{"path":["api",":tenantId","fundinginstructions","createandsubmit"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"e2db6051-5a7b-46b6-bae3-c47fb08762e0","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"765b316a-0da7-4b50-a9f0-36655f88b321","name":"Review and Submit Desposits","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/fundinginstructions/createandsubmit","host":["{{BaseURL}}"],"path":["api",":tenantId","fundinginstructions","createandsubmit"],"variable":[{"key":"tenantId","value":"Tenant1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"commandFingerprint\": \"string\",\n \"status\": \"Processing\",\n \"createTime\": \"2019-10-01T15:47:13.443Z\",\n \"endTime\": \"2019-10-01T15:47:13.443Z\",\n \"error\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"0993b1a9-5c3b-4a37-aecb-26acd6485e4d"},{"name":"Review A Deposit","id":"181fcb76-bc15-4305-a833-22016e0a2754","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/transactions/deposit/:depositId","description":"Use this method to review a single deposit.
\n","urlObject":{"path":["api",":tenantId","transactions","deposit",":depositId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"bff7a6fe-4509-41ed-87ae-03510e41a6d5","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"482cb419-00ee-41ef-9a39-a9c95c63ca08","description":{"content":"Integer, required. The unique id of the deposit
\n","type":"text/plain"},"type":"string","value":"","key":"depositId"}]}},"response":[{"id":"987f0001-a1b5-473b-8ee5-e1f624667404","name":"Review All Deposits","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/transactions/deposit/:depositId","host":["{{BaseURL}}"],"path":["api",":tenantId","transactions","deposit",":depositId"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"depositId","value":"Integer, required","description":"The unique id of the deposit"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 0,\r\n \"transactionDate\": \"2019-10-01T15:47:52.111Z\",\r\n \"arn\": \"string\",\r\n \"authorizationCode\": \"string\",\r\n \"authorizationSource\": \"string\",\r\n \"authorizationResponse\": \"string\",\r\n \"authorizationAmount\": 0,\r\n \"transactionAmount\": 0,\r\n \"submerchantBatchId\": \"string\",\r\n \"currency\": \"string\",\r\n \"cardBin\": \"string\",\r\n \"cardLastFour\": \"string\",\r\n \"cardType\": \"string\",\r\n \"network\": \"Unknown\",\r\n \"issuingBankID\": \"string\",\r\n \"interchangeFee\": 0,\r\n \"networkFees\": 0,\r\n \"processorFee\": 0,\r\n \"assessmentFee\": 0,\r\n \"payfacFee\": 0,\r\n \"chargebackFee\": 0,\r\n \"commissionFee\": 0,\r\n \"sourceDataEventId\": 0,\r\n \"processorMID\": \"string\",\r\n \"transactionType\": \"Deposit\",\r\n \"onHold\": true,\r\n \"terminalId\": \"string\",\r\n \"fundingStatus\": \"New\",\r\n \"feeFundingStatus\": \"New\",\r\n \"processorTransactionID\": \"string\",\r\n \"submerchantName\": \"string\",\r\n \"submerchantId\": 0,\r\n \"submerchantDbaName\": \"string\",\r\n \"submerchantStatus\": \"Active\",\r\n \"processedDate\": \"2019-10-01T15:47:52.111Z\",\r\n \"settlementDate\": \"2019-10-01T15:47:52.111Z\",\r\n \"extendedData\": \"string\",\r\n \"interchangeCode\": \"string\",\r\n \"interchangeLevel\": \"string\",\r\n \"feeSettlementDate\": \"2019-10-01T15:47:52.111Z\",\r\n \"gatewayReferenceId\": \"string\",\r\n \"partnerReferenceId\": \"string\",\r\n \"tipAmount\": 0,\r\n \"totalFees\": 0,\r\n \"netAmount\": 0,\r\n \"depositIds\": [\r\n 0\r\n ],\r\n \"feeProfileType\": \"FlatRate\",\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-10-01T15:47:52.111Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"181fcb76-bc15-4305-a833-22016e0a2754"},{"name":"Review Paginated Deposits","id":"0b3907dc-1eff-4f6f-a39e-e065c07c2e63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n","type":"text"}],"url":"{{BaseURL}}/api/:tenantid/fundinginstructions/paged","description":"If you need to do a deposits query that has more than 15 results, use this method. The results will return a total count of the deposits and the number of pages in the request, where each page has 15 deposits.
\nSummary
\nUse the summary query parameter to view the results without deposits. See the sidebar for examples.
\nDate Filters
\nWhen searching using date filters, use the DateFilter query parameter with the following values:
\nToday = 1,\nYesterday = 2,\nThisWeek = 3,\nThisMonth = 4,\nThisYear = 5,\nLastYear = 6,\nDateRange = 7
\nAll DateFilters must be used with a DateFilterType, where 0 = transactionDate and 1 = fundedDate. For DateFilters with 7, or DateRange, you must and add a FromDate query parameter, with an optional ToDate query parameter. The dates for FromDate and ToDate are formatted YYYY-MM-DD
\nTime Filters
\nIf you need to filter by a specific time within a date range, add the time after the FromDate or ToDate. For example: {{BaseURL}}/api/{tenantId}/fundinginstructions/paged?DateFilter=DateRange&DateFilterType=TransactionDate&FromDate=2018-11-21T00:00:00&ToDate=2018-11-21T12:00:00
Note that the dates are in UTC.
\nAscending and Descending Order
\nTo display deposits in ascending or descending order, declare which parameter you want to sort off by using a FieldName parameter, and declare either ASC (ascending) or DESC (descending) with the SortOrder parameter.\nFor example: {{BaseURL}}/api/{tenantId}/fundinginstructions?FieldName=createdDate&SortOrder=DESC sorts deposits by the createdDate in descending order.
Schema
\nSchema
\nDeposits
\nTransactions
\n","urlObject":{"path":["api",":tenantid","fundinginstructions","paged"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"195bbc2b-cf37-4fbd-8077-2efa08c2277b","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantid"}]}},"response":[{"id":"3772e57e-cbea-47b1-a09e-836621cfacc1","name":"Review Paginated Deposits - With Summary","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret","type":"text"}],"url":{"raw":"{{BaseURL}}/api/:tenantid/fundinginstructions/paged?summaryOnly=True","host":["{{BaseURL}}"],"path":["api",":tenantid","fundinginstructions","paged"],"query":[{"key":"summaryOnly","value":"True"}],"variable":[{"key":"tenantid","value":"","description":"String, required. The unique id of the tenant"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 83,\n \"createdDate\": \"2019-02-28T18:32:14.2676291+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 1,\n \"salesTotal\": 0,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 0,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 0,\n \"payfacRevenue\": 0,\n \"totalFees\": 0,\n \"netDepositAmount\": 0,\n \"type\": 0,\n \"submerchantDeposits\": [\n {\n \"id\": 121,\n \"fundingDepositId\": 83,\n \"submerchantId\": 167,\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"4445000123824167\"\n }\n ],\n \"createdDate\": \"2019-02-28T18:32:14.2676378+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 1,\n \"salesTotal\": 0,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 0,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 0,\n \"payfacRevenue\": 0,\n \"totalFees\": 0,\n \"netDepositAmount\": 0,\n \"type\": 0,\n \"transactions\": []\n }\n ]\n },\n {\n \"id\": 82,\n \"createdDate\": \"2019-02-27T22:27:49.3409344+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 1,\n \"salesTotal\": 0,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 0,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 0,\n \"payfacRevenue\": 0,\n \"totalFees\": 0,\n \"netDepositAmount\": 0,\n \"type\": 0,\n \"submerchantDeposits\": [\n {\n \"id\": 120,\n \"fundingDepositId\": 82,\n \"submerchantId\": 167,\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"4445000123824167\"\n }\n ],\n \"createdDate\": \"2019-02-27T22:27:49.340944+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 1,\n \"salesTotal\": 0,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 0,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 0,\n \"payfacRevenue\": 0.9,\n \"totalFees\": 0,\n \"netDepositAmount\": 0,\n \"type\": 0,\n \"transactions\": []\n }\n ]\n },\n {\n \"id\": 81,\n \"createdDate\": \"2019-02-27T21:33:57.9282877+00:00\",\n \"status\": 1,\n \"modifiedDate\": \"2019-02-27T21:33:58.6836925+00:00\",\n \"salesCount\": 0,\n \"salesTotal\": 0,\n \"refundCount\": 1,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 0,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 0,\n \"payfacRevenue\": 0,\n \"totalFees\": 0,\n \"netDepositAmount\": 0,\n \"type\": 0,\n \"submerchantDeposits\": [\n {\n \"id\": 119,\n \"fundingDepositId\": 81,\n \"submerchantId\": 167,\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"4445000123824167\"\n }\n ],\n \"createdDate\": \"2019-02-27T21:33:57.929705+00:00\",\n \"status\": 1,\n \"modifiedDate\": null,\n \"salesCount\": 0,\n \"salesTotal\": 0,\n \"refundCount\": 1,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 0,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 06,\n \"payfacRevenue\": 0,\n \"totalFees\": 0,\n \"netDepositAmount\": 0,\n \"type\": 0,\n \"transactions\": []\n }\n ]\n },\n {\n \"id\": 80,\n \"createdDate\": \"2019-02-27T21:30:22.1596628+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 0,\n \"salesTotal\": 0,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 0,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 0,\n \"payfacRevenue\": 0,\n \"totalFees\": 0,\n \"netDepositAmount\": 0,\n \"type\": 0,\n \"submerchantDeposits\": []\n }\n ],\n \"totalRequestedDataCount\": 4,\n \"currentPage\": 1,\n \"pageSize\": 15,\n \"totalPages\": 1\n}"},{"id":"96a1b151-da02-45a3-88fc-b74507604edc","name":"Review Paginated Deposits - Without Summary","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret","type":"text"}],"url":{"raw":"{{BaseURL}}/api/:tenantid/fundinginstructions/paged","host":["{{BaseURL}}"],"path":["api",":tenantid","fundinginstructions","paged"],"query":[{"key":"","value":"","type":"text"}],"variable":[{"key":"tenantid","value":"","description":"String, required. The unique id of the tenant"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 83,\n \"createdDate\": \"2019-02-28T18:32:14.2676291+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 1,\n \"salesTotal\": 674.64,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 674.64,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 2.05,\n \"payfacRevenue\": 0.9,\n \"totalFees\": 0.9,\n \"netDepositAmount\": 673.74,\n \"type\": 0,\n \"submerchantDeposits\": [\n {\n \"id\": 121,\n \"fundingDepositId\": 83,\n \"submerchantId\": 167,\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"4445000123824167\"\n }\n ],\n \"createdDate\": \"2019-02-28T18:32:14.2676378+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 1,\n \"salesTotal\": 674.64,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 674.64,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 2.05,\n \"payfacRevenue\": 0.9,\n \"totalFees\": 2.95,\n \"netDepositAmount\": 671.69,\n \"type\": 0,\n \"transactions\": [\n {\n \"id\": 311,\n \"transactionDate\": \"2019-02-25T22:24:10.29+00:00\",\n \"arn\": \"638282\",\n \"authorizationCode\": \"23702\",\n \"authorizationSource\": \"E\",\n \"authorizationResponse\": \"14050\",\n \"authorizationAmount\": 674.64,\n \"transactionAmount\": 674.64,\n \"submerchantBatchId\": \"76363\",\n \"currency\": \"USD\",\n \"cardBin\": \"70524\",\n \"cardLastFour\": \"9091\",\n \"cardType\": \"Unknown\",\n \"network\": 3,\n \"issuingBankID\": \"BankID\",\n \"interchangeFee\": 4.14,\n \"networkFees\": 0,\n \"processorFee\": 2.05,\n \"assessmentFee\": 1.11,\n \"payfacFee\": 0.9,\n \"sourceDataEventId\": 116,\n \"processorMID\": \"421563495\",\n \"transactionType\": 0,\n \"onHold\": false,\n \"terminalId\": \"338452702\",\n \"fundingStatus\": 0,\n \"processorTransactionID\": \"581762196\",\n \"submerchantName\": \"Sally's Seashore Shells\",\n \"submerchantId\": 167,\n \"submerchantDbaName\": \"Sally's Seashore Shells\",\n \"settlementDate\": null,\n \"extendedData\": null,\n \"interchangeCode\": null,\n \"interchangeLevel\": null,\n \"feeSettlementDate\": \"2019-02-26T21:30:37.3745996+00:00\",\n \"gatewayReferenceId\": null,\n \"partnerReferenceId\": null,\n \"totalFees\": 4.06,\n \"netAmount\": 670.58,\n \"depositIds\": [\n 83,\n 82\n ],\n \"feeProfileType\": 0,\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"4445000123824167\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"id\": 82,\n \"createdDate\": \"2019-02-27T22:27:49.3409344+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 1,\n \"salesTotal\": 674.64,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 674.64,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 2.05,\n \"payfacRevenue\": 0.9,\n \"totalFees\": 0.9,\n \"netDepositAmount\": 673.74,\n \"type\": 0,\n \"submerchantDeposits\": [\n {\n \"id\": 120,\n \"fundingDepositId\": 82,\n \"submerchantId\": 167,\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"4445000123824167\"\n }\n ],\n \"createdDate\": \"2019-02-27T22:27:49.340944+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 1,\n \"salesTotal\": 674.64,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 674.64,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 2.05,\n \"payfacRevenue\": 0.9,\n \"totalFees\": 2.95,\n \"netDepositAmount\": 671.69,\n \"type\": 0,\n \"transactions\": [\n {\n \"id\": 311,\n \"transactionDate\": \"2019-02-25T22:24:10.29+00:00\",\n \"arn\": \"638282\",\n \"authorizationCode\": \"23702\",\n \"authorizationSource\": \"E\",\n \"authorizationResponse\": \"14050\",\n \"authorizationAmount\": 674.64,\n \"transactionAmount\": 674.64,\n \"submerchantBatchId\": \"76363\",\n \"currency\": \"USD\",\n \"cardBin\": \"70524\",\n \"cardLastFour\": \"9091\",\n \"cardType\": \"Unknown\",\n \"network\": 3,\n \"issuingBankID\": \"BankID\",\n \"interchangeFee\": 4.14,\n \"networkFees\": 0,\n \"processorFee\": 2.05,\n \"assessmentFee\": 1.11,\n \"payfacFee\": 0.9,\n \"sourceDataEventId\": 116,\n \"processorMID\": \"421563495\",\n \"transactionType\": 0,\n \"onHold\": false,\n \"terminalId\": \"338452702\",\n \"fundingStatus\": 0,\n \"processorTransactionID\": \"581762196\",\n \"submerchantName\": \"Sally's Seashore Shells\",\n \"submerchantId\": 167,\n \"submerchantDbaName\": \"Sally's Seashore Shells\",\n \"settlementDate\": null,\n \"extendedData\": null,\n \"interchangeCode\": null,\n \"interchangeLevel\": null,\n \"feeSettlementDate\": \"2019-02-26T21:30:37.3745996+00:00\",\n \"gatewayReferenceId\": null,\n \"partnerReferenceId\": null,\n \"totalFees\": 4.06,\n \"netAmount\": 670.58,\n \"depositIds\": [\n 83,\n 82\n ],\n \"feeProfileType\": 0,\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"4445000123824167\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"id\": 81,\n \"createdDate\": \"2019-02-27T21:33:57.9282877+00:00\",\n \"status\": 1,\n \"modifiedDate\": \"2019-02-27T21:33:58.6836925+00:00\",\n \"salesCount\": 0,\n \"salesTotal\": 0,\n \"refundCount\": 1,\n \"refundTotal\": 939.52,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": -939.52,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 1.36,\n \"payfacRevenue\": -0.98,\n \"totalFees\": -0.98,\n \"netDepositAmount\": -938.54,\n \"type\": 0,\n \"submerchantDeposits\": [\n {\n \"id\": 119,\n \"fundingDepositId\": 81,\n \"submerchantId\": 167,\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"4445000123824167\"\n }\n ],\n \"createdDate\": \"2019-02-27T21:33:57.929705+00:00\",\n \"status\": 1,\n \"modifiedDate\": null,\n \"salesCount\": 0,\n \"salesTotal\": 0,\n \"refundCount\": 1,\n \"refundTotal\": 939.52,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": -939.52,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 1.36,\n \"payfacRevenue\": -0.98,\n \"totalFees\": 2.34,\n \"netDepositAmount\": -941.86,\n \"type\": 0,\n \"transactions\": [\n {\n \"id\": 309,\n \"transactionDate\": \"2019-02-25T22:24:10.29+00:00\",\n \"arn\": \"210856\",\n \"authorizationCode\": \"88068\",\n \"authorizationSource\": \"E\",\n \"authorizationResponse\": \"33074\",\n \"authorizationAmount\": 939.52,\n \"transactionAmount\": 939.52,\n \"submerchantBatchId\": \"76237\",\n \"currency\": \"USD\",\n \"cardBin\": \"81001\",\n \"cardLastFour\": \"6840\",\n \"cardType\": \"Unknown\",\n \"network\": 2,\n \"issuingBankID\": \"BankID\",\n \"interchangeFee\": 0.52,\n \"networkFees\": 0,\n \"processorFee\": 1.36,\n \"assessmentFee\": 1.6,\n \"payfacFee\": 0.98,\n \"sourceDataEventId\": 116,\n \"processorMID\": \"968697124\",\n \"transactionType\": 1,\n \"onHold\": false,\n \"terminalId\": \"218554326\",\n \"fundingStatus\": 3,\n \"processorTransactionID\": \"840946317\",\n \"submerchantName\": \"Sally's Seashore Shells\",\n \"submerchantId\": 167,\n \"submerchantDbaName\": \"Sally's Seashore Shells\",\n \"settlementDate\": \"2019-02-27T21:33:58.6836925+00:00\",\n \"extendedData\": null,\n \"interchangeCode\": null,\n \"interchangeLevel\": null,\n \"feeSettlementDate\": \"2019-02-27T21:33:58.6836925+00:00\",\n \"gatewayReferenceId\": null,\n \"partnerReferenceId\": null,\n \"totalFees\": 3.94,\n \"netAmount\": 935.58,\n \"depositIds\": [\n 81\n ],\n \"feeProfileType\": 0,\n \"merchantIdentifiers\": [\n {\n \"key\": \"MID\",\n \"value\": \"4445000123824167\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"id\": 80,\n \"createdDate\": \"2019-02-27T21:30:22.1596628+00:00\",\n \"status\": 0,\n \"modifiedDate\": null,\n \"salesCount\": 0,\n \"salesTotal\": 0,\n \"refundCount\": 0,\n \"refundTotal\": 0,\n \"chargebackCount\": 0,\n \"chargebackTotal\": 0,\n \"grossDepositAmount\": 0,\n \"interchangeFees\": 0,\n \"networkFees\": 0,\n \"processorFees\": 0,\n \"payfacRevenue\": 0,\n \"totalFees\": 0,\n \"netDepositAmount\": 0,\n \"type\": 0,\n \"submerchantDeposits\": []\n }\n ],\n \"totalRequestedDataCount\": 4,\n \"currentPage\": 1,\n \"pageSize\": 15,\n \"totalPages\": 1\n}"}],"_postman_id":"0b3907dc-1eff-4f6f-a39e-e065c07c2e63"},{"name":"Create Deposit","id":"38199f8d-f206-4227-bca6-58d5a00bbfff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenant/fundinginstructions","description":"Use this to create a deposit.
\n","urlObject":{"path":["api",":tenant","fundinginstructions"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"c141dc67-24e9-4f68-83c7-fde0229b81a9","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"}]}},"response":[{"id":"3c65570a-7b13-4673-8e2f-4f54a2a2deaf","name":"Create Deposit","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/fundinginstructions","host":["{{BaseURL}}"],"path":["api",":tenantId","fundinginstructions"],"variable":[{"key":"tenantId","value":"Tenant1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"38199f8d-f206-4227-bca6-58d5a00bbfff"},{"name":"Submit Deposit","id":"33e2eea4-28c2-42c1-9afd-81d2d9357003","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenant/fundinginstructions/:depositId","description":"Use this to submit a single deposit to the processor.
\n","urlObject":{"path":["api",":tenant","fundinginstructions",":depositId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"5597d28e-a574-4f86-bc75-b7966effa56f","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"},{"id":"4d9ca4b1-c2f6-4dcc-b175-3cdf7ade6edd","description":{"content":"String, required. The unique id of the deposit
\n","type":"text/plain"},"type":"string","value":"","key":"depositId"}]}},"response":[{"id":"7519fc95-69d2-4de2-85fe-78626497eaec","name":"Submit Deposit","originalRequest":{"method":"POST","header":[{"key":"AuthenticationKey","value":"{{AuthenticationToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenant/fundinginstructions/:depositId","host":["{{BaseURL}}"],"path":["api",":tenant","fundinginstructions",":depositId"],"variable":[{"key":"tenant","value":"Tenant1"},{"key":"depositId","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"33e2eea4-28c2-42c1-9afd-81d2d9357003"}],"id":"b96de8f2-f627-4eef-963c-16bd0c439888","description":"Deposits represent the funds deposited into the submerchant's bank account. Use these methods to review details on existing deposits, create new deposits, or submit deposits to the processor.
\nMerchant Identifiers
\n","event":[{"listen":"prerequest","script":{"id":"1bb11b54-59f6-49d2-b771-d0cc15e93459","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cd4e57f3-011c-4b16-9f13-ddc99ea6a586","type":"text/javascript","exec":[""]}}],"_postman_id":"b96de8f2-f627-4eef-963c-16bd0c439888"}],"id":"49d4c8c7-a83e-4825-a5d3-c68e679055ab","description":"Now that the submerchant is in the Backoffice application, they can begin processing funds. The types of funds are:
\nA transaction represents a single instance of a user purchasing something from the submerchant. Transactions displays with a breakdown of Interchange & Network Fees, Processor Fees, and Payfac Revenue.
\nA chargeback is something that a customer may issue through their bank if they purchased an unsatisfactory product or were a victim of fraud.
\nA deposit represents the funds deposited into the submerchant's bank account
\nThese funds can be processed through data files, such as TSYS or D256 files, depending on the processor you're using.
\n","event":[{"listen":"prerequest","script":{"id":"8ab22ef7-44d3-4aa0-aa3e-0b80481af693","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"04a68e15-6513-4066-9f8f-d7bf71a74a25","type":"text/javascript","exec":[""]}}],"_postman_id":"49d4c8c7-a83e-4825-a5d3-c68e679055ab"},{"name":"Reports","item":[{"name":"Exception Reports","item":[{"name":"Exception Report Definitions","item":[{"name":"View Exception Report Definintions","id":"9ce3d3b7-96ca-409e-a320-59304f81c727","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n","type":"text"}],"url":"{{BaseURL}}/api/:tenant/riskexceptions/definitions","description":"Use this method to view how each exception report is set up.
\n","urlObject":{"path":["api",":tenant","riskexceptions","definitions"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"7b133f8d-99c1-4096-aa75-f8b797448ba8","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"}]}},"response":[{"id":"c6d720dd-f238-418d-acd7-efbf8bd8330b","name":"View Exception Report Definintions","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret","type":"text"}],"url":{"raw":"{{BaseURL}}/api/:tenant/riskexceptions/definitions","host":["{{BaseURL}}"],"path":["api",":tenant","riskexceptions","definitions"],"variable":[{"key":"tenant","value":"","description":"String, required. The unique id for the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"displayName\": \"First Transaction Processed\",\n \"description\": \"The first transaction may be reviewed to ensure they are processing within the guidelines established and to ensure underwriting can be completed.\",\n \"submerchant\": null,\n \"submerchantId\": null,\n \"activateDate\": \"2019-05-01T00:00:00+00:00\",\n \"deactivateDate\": null,\n \"isActive\": true,\n \"isTenantDefinition\": true,\n \"exceptionLogicId\": 1,\n \"thresholdData\": null\n },\n {\n \"displayName\": \"Transaction Over Maximum\",\n \"description\": \"A ticket is over the maximum when any one sale amount in any one batch exceeds the average or maximum amount approved for that submerchant as defined in the submerchant’s profile.\",\n \"submerchant\": null,\n \"submerchantId\": null,\n \"activateDate\": \"2019-05-01T00:00:00+00:00\",\n \"deactivateDate\": null,\n \"isActive\": true,\n \"isTenantDefinition\": true,\n \"exceptionLogicId\": 2,\n \"thresholdData\": \"1000\"\n }\n]"}],"_postman_id":"9ce3d3b7-96ca-409e-a320-59304f81c727"},{"name":"View Paginated Exception Report Definitions","id":"daf626cc-a736-4140-b31f-50119cf38a87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","type":"text","value":""},{"description":"The authentication key value
\n","key":"x-AuthenticationKeyValue","type":"text","value":""}],"url":"{{BaseURL}}/api/:tenantId/riskexceptions/definitions/paginated?isActive&isTenantDefinition&submerchantId&activateDate&deactivateDate&exceptionLogicId¤tPage&pageSize&fieldName&sortOrder","description":"Use this method to view the exception reporting definitions in a paginated view.
\n","urlObject":{"path":["api",":tenantId","riskexceptions","definitions","paginated"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"Boolean, optional. Whether or not the definition is active or not
\n","type":"text/plain"},"key":"isActive","value":null},{"description":{"content":"Boolean, optional. Describes if the exception definition is at the tenant-level or not
\n","type":"text/plain"},"key":"isTenantDefinition","value":null},{"description":{"content":"Integer, optional. The submerchant id
\n","type":"text/plain"},"key":"submerchantId","value":null},{"description":{"content":"String, optional. The date the exception definition became active.
\n","type":"text/plain"},"key":"activateDate","value":null},{"description":{"content":"String, optional. The date the exception report is deactivated, if applicable
\n","type":"text/plain"},"key":"deactivateDate","value":null},{"description":{"content":"Array, optional. Can select between FirstTransactionProcessed, TransactionOverMaximum, DailyDepositOverMaximum, ForeignCardPercentageOverLimit, MultipleRefundsToSameCard, ExcessiveRefundVolumeInBatch, ExcessiveRefundCountPercentage, ExcessivePercentageOfKeyedTransactions, OutOfPatternLowDollarTransaction, RefundGreaterThanMaxAllowed, RefundWithoutOffsettingSale, ExcessiveForcedTransactions, FallbackTransaction, HighPercentageOfChargebacks, LargeChargeback, RefundAfterChargeback, ProcessingApproachingApprovedMonthlyLimit, ExcessiveProcessing, DormantSubmerchantActive
Integer, optional. The current page of risk exception definitions from the request
\n","type":"text/plain"},"key":"currentPage","value":null},{"description":{"content":"Integer, optional. The number of risk exception definitions on that page
\n","type":"text/plain"},"key":"pageSize","value":null},{"description":{"content":"String, optional. Declares which date to sort by. Used in conjunction with sortOrder
Array, optional. Use either ASC (ascending) or DESC (descending) to display the results in order. Used in conjunction with fieldName.
String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"1367e748-477d-49b9-a0f8-484acf1f371a","name":"View Paginated Exception Report Definitions","originalRequest":{"method":"GET","header":[{"description":"The authentication key","key":"x-AuthenticationKeyId","type":"text","value":""},{"description":"The authentication key value","key":"x-AuthenticationKeyValue","type":"text","value":""}],"url":{"raw":"{{BaseURL}}/api/:tenantId/riskexceptions/definitions/paginated","host":["{{BaseURL}}"],"path":["api",":tenantId","riskexceptions","definitions","paginated"],"variable":[{"description":"String, required. The unique id for the tenant","key":"tenantId","value":""}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"submerchantId\": 0,\n \"activateDate\": \"2019-05-31T21:58:25.676Z\",\n \"deactivateDate\": \"2019-05-31T21:58:25.676Z\",\n \"isActive\": true,\n \"isTenantDefinition\": true,\n \"exceptionLogicId\": \"FirstTransactionProcessed\",\n \"thresholdData\": \"string\"\n }\n ],\n \"totalRequestedDataCount\": 0,\n \"currentPage\": 0,\n \"pageSize\": 0,\n \"totalPages\": 0\n}"}],"_postman_id":"daf626cc-a736-4140-b31f-50119cf38a87"}],"id":"b95080cd-e6ac-4149-901a-ba8232477c4d","description":"Use these methods to see the definitions set up for exception reports.
\nResonse Schema
\nAdditional Response Schema for Pagination
\n","event":[{"listen":"prerequest","script":{"id":"104ab0bd-b9e1-478b-9812-a803fa4bd1d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2f645073-5afd-4768-814d-6252743098d7","type":"text/javascript","exec":[""]}}],"_postman_id":"b95080cd-e6ac-4149-901a-ba8232477c4d"},{"name":"Exception Report Notes","item":[{"name":"View Exception Report Notes","id":"6eabbccf-9b6b-4f68-bd3e-93a0fe443475","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","value":""},{"description":"The authentication key secret
\n","key":"x-AuthenticationKeyValue","value":""}],"url":"{{BaseURL}}/api/:tenant/riskexceptions/notes/:riskExceptionId","description":"Use this method to view exception report notes.
\n","urlObject":{"path":["api",":tenant","riskexceptions","notes",":riskExceptionId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"652d25d8-cea6-4d8b-9db1-1750ef579c85","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"},{"id":"937bd976-a615-4aba-a6c3-e10467a0b194","type":"string","value":"","key":"riskExceptionId"}]}},"response":[{"id":"8a74cbea-a737-431b-a06f-665176cfe3d7","name":"View Exception Report Notes","originalRequest":{"method":"GET","header":[{"description":"The authentication key","key":"x-AuthenticationKeyId","value":""},{"description":"The authentication key secret","key":"x-AuthenticationKeyValue","value":""}],"url":{"raw":"{{BaseURL}}/api/:tenant/riskexceptions/:riskExceptionId","host":["{{BaseURL}}"],"path":["api",":tenant","riskexceptions",":riskExceptionId"],"variable":[{"description":"String, required. The unique id for the tenant","key":"tenant","value":""},{"key":"riskExceptionId","value":"","description":"Integer, required. The unique id for the risk exception"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 0,\n \"message\": \"string\",\n \"createdDate\": \"2019-06-03T15:28:03.153Z\",\n \"type\": \"NoteInternal\",\n \"createdBy\": \"string\"\n }\n]"}],"_postman_id":"6eabbccf-9b6b-4f68-bd3e-93a0fe443475"},{"name":"Create Exception Report Notes","id":"1c0bcd53-adb5-46eb-96e9-36191bca31f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","value":""},{"description":"The authentication key secret
\n","key":"x-AuthenticationKeyValue","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"noteType\": \"NoteInternal\",\r\n \"message\": \"string\",\r\n \"username\": \"string\"\r\n}"},"url":"{{BaseURL}}/api/:tenant/riskexceptions/notes/:riskExceptionId","description":"Use this method to create exception report notes.
\n","urlObject":{"path":["api",":tenant","riskexceptions","notes",":riskExceptionId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"31462abc-b011-4e59-a34e-54a28aa8476b","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"},{"id":"5ed8d262-42c3-4271-9b47-523903dc05fb","type":"string","value":"","key":"riskExceptionId"}]}},"response":[{"id":"92d929ee-5718-44bc-ac93-cfee7fe0a7e4","name":"View Exception Report Notes","originalRequest":{"method":"GET","header":[{"description":"The authentication key","key":"x-AuthenticationKeyId","value":""},{"description":"The authentication key secret","key":"x-AuthenticationKeyValue","value":""}],"url":{"raw":"{{BaseURL}}/api/:tenant/riskexceptions/:riskExceptionId","host":["{{BaseURL}}"],"path":["api",":tenant","riskexceptions",":riskExceptionId"],"variable":[{"description":"String, required. The unique id for the tenant","key":"tenant","value":""},{"key":"riskExceptionId","value":"","description":"Integer, required. The unique id for the risk exception"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 0,\n \"message\": \"string\",\n \"createdDate\": \"2019-06-03T15:28:03.153Z\",\n \"type\": \"NoteInternal\",\n \"createdBy\": \"string\"\n }\n]"}],"_postman_id":"1c0bcd53-adb5-46eb-96e9-36191bca31f1"}],"id":"d324c669-365b-4937-a4c7-9c891d01a5fb","description":"","event":[{"listen":"prerequest","script":{"id":"70bae105-08f3-4721-8db3-ed2b6e02c06b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"522e4cc8-610a-4726-b09c-db86076d01fa","type":"text/javascript","exec":[""]}}],"_postman_id":"d324c669-365b-4937-a4c7-9c891d01a5fb"},{"name":"View Exception Reports","id":"f04ba471-0235-4930-a564-0215df71b081","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenant/riskexceptions","description":"Use this method to view all available exception reports.
\nResponse Schema
\n","urlObject":{"path":["api",":tenant","riskexceptions"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"c1f41126-11ec-48e0-b551-68c3fcbdd72b","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"}]}},"response":[{"id":"53af573d-5ef7-432d-afb0-de32b0f2b705","name":"View Exception Reports","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenant/riskexceptions","host":["{{BaseURL}}"],"path":["api",":tenant","riskexceptions"],"variable":[{"key":"tenant","value":"","description":"String, required. The unique id for the tenant"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 0,\r\n \"resolved\": true,\r\n \"submerchantName\": \"string\",\r\n \"submerchantMID\": \"string\",\r\n \"batchId\": 0,\r\n \"batchDate\": \"2019-05-31T18:54:31.392Z\",\r\n \"riskExceptionName\": \"string\",\r\n \"riskExceptionDescription\": \"string\",\r\n \"exceptionDate\": \"2019-05-31T18:54:31.392Z\",\r\n \"numberOfTransactions\": 0,\r\n \"numberOfAuthorizations\": 0,\r\n \"total\": 0,\r\n \"refundCount\": 0,\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-05-31T18:54:31.392Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ],\r\n \"affectedTransactions\": [\r\n {\r\n \"id\": 0,\r\n \"transactionDate\": \"2019-05-31T18:54:31.392Z\",\r\n \"arn\": \"string\",\r\n \"authorizationCode\": \"string\",\r\n \"authorizationSource\": \"string\",\r\n \"authorizationResponse\": \"string\",\r\n \"authorizationAmount\": 0,\r\n \"transactionAmount\": 0,\r\n \"submerchantBatchId\": \"string\",\r\n \"currency\": \"string\",\r\n \"cardBin\": \"string\",\r\n \"cardLastFour\": \"string\",\r\n \"cardType\": \"string\",\r\n \"network\": \"Unknown\",\r\n \"issuingBankID\": \"string\",\r\n \"interchangeFee\": 0,\r\n \"networkFees\": 0,\r\n \"processorFee\": 0,\r\n \"assessmentFee\": 0,\r\n \"payfacFee\": 0,\r\n \"sourceDataEventId\": 0,\r\n \"processorMID\": \"string\",\r\n \"transactionType\": \"Deposit\",\r\n \"onHold\": true,\r\n \"terminalId\": \"string\",\r\n \"fundingStatus\": \"New\",\r\n \"feeFundingStatus\": \"New\",\r\n \"processorTransactionID\": \"string\",\r\n \"submerchantName\": \"string\",\r\n \"submerchantId\": 0,\r\n \"submerchantDbaName\": \"string\",\r\n \"settlementDate\": \"2019-05-31T18:54:31.392Z\",\r\n \"extendedData\": \"string\",\r\n \"interchangeCode\": \"string\",\r\n \"interchangeLevel\": \"string\",\r\n \"feeSettlementDate\": \"2019-05-31T18:54:31.392Z\",\r\n \"gatewayReferenceId\": \"string\",\r\n \"partnerReferenceId\": \"string\",\r\n \"tipAmount\": 0,\r\n \"totalFees\": 0,\r\n \"netAmount\": 0,\r\n \"depositIds\": [\r\n 0\r\n ],\r\n \"feeProfileType\": \"FlatRate\",\r\n \"merchantIdentifiers\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-05-31T18:54:31.392Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"f04ba471-0235-4930-a564-0215df71b081"},{"name":"View Paginated Exception Reports","id":"f57933c4-ab6c-4425-88f7-7184d6def469","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key value
\n","type":"text"}],"url":"{{BaseURL}}/api/:tenant/riskexceptions/paginated?id&resolved&submerchantId&batchId&affectedTransactionId&definitionId&exceptionLogicType¤tPage&pageSize&fieldName&sortOrder","description":"Use this method to see all exception report definitions by page.
\nAll parameters below are optional query parameters.
\n","urlObject":{"path":["api",":tenant","riskexceptions","paginated"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"Integer, optional. The unique exception report id
\n","type":"text/plain"},"key":"id","value":null},{"description":{"content":"Boolean, optional. Whether or not the exception has been resolved
\n","type":"text/plain"},"key":"resolved","value":null},{"description":{"content":"Integer, optional. The submerchant id where the exception was found
\n","type":"text/plain"},"key":"submerchantId","value":null},{"description":{"content":"Integer, optional. The batch id that the application transaction was in
\n","type":"text/plain"},"key":"batchId","value":null},{"description":{"content":"Integer, optional. The ids of the transactions afffected by the exception
\n","type":"text/plain"},"key":"affectedTransactionId","value":null},{"description":{"content":"Integer, optional. The definition id
\n","type":"text/plain"},"key":"definitionId","value":null},{"description":{"content":"Array, optional. Can select between FirstTransactionProcessed, TransactionOverMaximum, DailyDepositOverMaximum, ForeignCardPercentageOverLimit, MultipleRefundsToSameCard, ExcessiveRefundVolumeInBatch, ExcessiveRefundCountPercentage, ExcessivePercentageOfKeyedTransactions, OutOfPatternLowDollarTransaction, RefundGreaterThanMaxAllowed, RefundWithoutOffsettingSale, ExcessiveForcedTransactions, FallbackTransaction, HighPercentageOfChargebacks, LargeChargeback, RefundAfterChargeback, ProcessingApproachingApprovedMonthlyLimit, ExcessiveProcessing, DormantSubmerchantActive
Integer, optional. The current page of risk exception definitions from the request
\n","type":"text/plain"},"key":"currentPage","value":null},{"description":{"content":"Integer, optional. The number of risk exception definitions on that page
\n","type":"text/plain"},"key":"pageSize","value":null},{"description":{"content":"String, optional. Declares which date to sort by. Used in conjunction with sortOrder
Array, optional. Use either ASC (ascending) or DESC (descending) to display the results in order. Used in conjunction with fieldName.
String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"}]}},"response":[{"id":"6282e917-d52a-4964-aa20-1fbf541aca44","name":"Get Paginated Exception Report Definitions","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key value","type":"text"}],"url":"{{BaseURL}}/api/{tenantId}/riskexceptions/paginated"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"displayName\": \"string\",\r\n \"description\": \"string\",\r\n \"submerchantId\": 0,\r\n \"activateDate\": \"2019-05-31T18:55:53.224Z\",\r\n \"deactivateDate\": \"2019-05-31T18:55:53.224Z\",\r\n \"isActive\": true,\r\n \"isTenantDefinition\": true,\r\n \"exceptionLogicId\": \"FirstTransactionProcessed\",\r\n \"thresholdData\": \"string\"\r\n }\r\n ],\r\n \"totalRequestedDataCount\": 0,\r\n \"currentPage\": 0,\r\n \"pageSize\": 0,\r\n \"totalPages\": 0\r\n}"}],"_postman_id":"f57933c4-ab6c-4425-88f7-7184d6def469"},{"name":"View Exception Reports by Risk Exception Id","id":"a26a3c05-4510-4fee-b3bc-98c6d6e2a2f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","type":"text","value":""},{"description":"The authentication key value
\n","key":"x-AuthenticationKeyValue","type":"text","value":""}],"url":"{{BaseURL}}/api/:tenantId/riskexceptions/:riskExceptionId?submerchantid&batchId&summaryOnly","description":"Use this method to see all exception reports by the risk exception id.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","riskexceptions",":riskExceptionId"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"Integer, optional. The submerchant id
\n","type":"text/plain"},"key":"submerchantid","value":null},{"description":{"content":"Integer, optional. The batch id
\n","type":"text/plain"},"key":"batchId","value":null},{"description":{"content":"Boolean, optional. If true, the response does not contain transaction data
\n","type":"text/plain"},"key":"summaryOnly","value":null}],"variable":[{"id":"545ba8c7-20bf-4569-bd82-6fe9a2863e47","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"aef4d37e-7233-4197-b820-898c6a97e3ce","description":{"content":"Integer, requried. The risk exception id
\n","type":"text/plain"},"type":"string","value":"","key":"riskExceptionId"}]}},"response":[{"id":"cb3e052f-f212-44fb-bb51-6be20d16c0e8","name":"View Exception Reports by Risk Exception Id","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key value","type":"text"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/riskexceptions/:riskExceptionId","host":["{{BaseURL}}"],"path":["api",":tenantId","riskexceptions",":riskExceptionId"],"variable":[{"key":"tenantId","value":"","description":"String, required. The unique id for the tenant"},{"key":"riskExceptionId","value":"","description":"Integer, requried. The risk exception id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-05-31T18:57:22.322Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n]"}],"_postman_id":"a26a3c05-4510-4fee-b3bc-98c6d6e2a2f1"},{"name":"View Exception Report Summaries","id":"6616bf05-52d3-4df2-b04b-7595c1247602","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","type":"text","value":""},{"description":"The authentication key value
\n","key":"x-AuthenticationKeyValue","type":"text","value":""}],"url":"{{BaseURL}}/api/:tenantId/riskexceptions/submerchantbatchexceptionsummaries?submerchantId&batchId&summaryOnly¤tPage=&pageSize=","description":"Use this method to view a paginated summary of risk exception reports.
\n","urlObject":{"path":["api",":tenantId","riskexceptions","submerchantbatchexceptionsummaries"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"Integer, optional. The submerchant id
\n","type":"text/plain"},"key":"submerchantId","value":null},{"description":{"content":"Integer, optional. The batch id
\n","type":"text/plain"},"key":"batchId","value":null},{"description":{"content":"Boolean, optional. If true, the response does not contain transaction data
\n","type":"text/plain"},"key":"summaryOnly","value":null},{"description":{"content":"Integer, optional. The current page of risk exceptions from the request
\n","type":"text/plain"},"key":"currentPage","value":""},{"description":{"content":"Integer, optional. The number of risk exceptions on that page
\n","type":"text/plain"},"key":"pageSize","value":""}],"variable":[{"id":"c54bdec2-700d-4daa-bb2e-fc66958235e5","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"da77be80-f3c1-4a8d-8206-b12d4eb82d21","name":"View Exception Report Summaries","originalRequest":{"method":"GET","header":[{"description":"The authentication key","key":"x-AuthenticationKeyId","type":"text","value":""},{"description":"The authentication key value","key":"x-AuthenticationKeyValue","type":"text","value":""}],"url":{"raw":"{{BaseURL}}/api/:tenantId/riskexceptions/submerchantbatchexceptionsummaries","host":["{{BaseURL}}"],"path":["api",":tenantId","riskexceptions","submerchantbatchexceptionsummaries"],"variable":[{"description":"String, required. The unique id for the tenant","key":"tenantId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"batchId\": \"string\",\r\n \"submerchant\": {\r\n \"networkFundingSettings\": [\r\n {\r\n \"network\": \"Unknown\",\r\n \"appliesToAllNetworks\": true,\r\n \"status\": \"New\",\r\n \"statusLabel\": \"string\"\r\n }\r\n ],\r\n \"id\": 0,\r\n \"legalEntityName\": \"string\",\r\n \"dbaName\": \"string\",\r\n \"businessType\": \"string\",\r\n \"contactPhone\": \"string\",\r\n \"backgroundCheckResults\": \"string\",\r\n \"feeProfile\": {\r\n \"id\": 0,\r\n \"type\": \"FlatRate\",\r\n \"discountRate\": 0,\r\n \"transactionFee\": 0,\r\n \"monthlyFee\": 0,\r\n \"visaMastercardRate\": 0,\r\n \"visaMastercardFee\": 0,\r\n \"discoverFee\": 0,\r\n \"discoverRate\": 0,\r\n \"amexRate\": 0,\r\n \"amexFee\": 0,\r\n \"chargebackFee\": 0,\r\n \"gatewayFee\": 0,\r\n \"batchFee\": 0,\r\n \"returnFee\": 0,\r\n \"feeBilling\": \"Monthly\",\r\n \"amexStatus\": \"Conveyed\",\r\n \"chargePayfacFeeOnRefunds\": true\r\n },\r\n \"achFees\": [\r\n {\r\n \"type\": \"Discount\",\r\n \"transactionFee\": 0,\r\n \"representmentFee\": 0,\r\n \"returnFee\": 0\r\n }\r\n ],\r\n \"locations\": [\r\n null\r\n ],\r\n \"merchantIdentifiers\": {\r\n \"additionalProp1\": \"string\",\r\n \"additionalProp2\": \"string\",\r\n \"additionalProp3\": \"string\"\r\n },\r\n \"accountStatus\": \"Active\",\r\n \"createdDate\": \"2019-06-07T16:27:17.026Z\",\r\n \"createdBy\": \"string\",\r\n \"modifiedDate\": \"2019-06-07T16:27:17.026Z\",\r\n \"modifiedBy\": \"string\",\r\n \"taxIdNumber\": \"string\",\r\n \"businessAddressId\": 0,\r\n \"businessAddress\": {\r\n \"line1\": \"string\",\r\n \"line2\": \"string\",\r\n \"city\": \"string\",\r\n \"countryRegion\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\"\r\n },\r\n \"useDifferentMailingAddress\": true,\r\n \"mailingAddressId\": 0,\r\n \"mailingAddress\": {\r\n \"line1\": \"string\",\r\n \"line2\": \"string\",\r\n \"city\": \"string\",\r\n \"countryRegion\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\"\r\n },\r\n \"timeZone\": \"string\",\r\n \"websiteAddress\": \"string\",\r\n \"principalFirstName\": \"string\",\r\n \"principalMiddleName\": \"string\",\r\n \"principalLastName\": \"string\",\r\n \"principalAddressId\": 0,\r\n \"principalAddress\": {\r\n \"line1\": \"string\",\r\n \"line2\": \"string\",\r\n \"city\": \"string\",\r\n \"countryRegion\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\"\r\n },\r\n \"bankAddressId\": 0,\r\n \"bankAddress\": {\r\n \"line1\": \"string\",\r\n \"line2\": \"string\",\r\n \"city\": \"string\",\r\n \"countryRegion\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\"\r\n },\r\n \"principalPhone\": \"string\",\r\n \"annualCreditCardSalesVolume\": 0,\r\n \"hasAcceptedCreditCards\": true,\r\n \"bankAccount\": \"string\",\r\n \"bankRouting\": \"string\",\r\n \"merchantCategoryCode\": \"string\",\r\n \"principalEmail\": \"string\",\r\n \"terminals\": [\r\n {\r\n \"id\": 0,\r\n \"terminalId\": \"string\"\r\n }\r\n ],\r\n \"users\": [\r\n {\r\n \"id\": 0,\r\n \"userRole\": \"Submerchant\",\r\n \"name\": \"string\",\r\n \"emailAddress\": \"string\",\r\n \"createdDate\": \"2019-06-07T16:27:17.027Z\",\r\n \"createdBy\": \"string\",\r\n \"modifiedBy\": \"string\",\r\n \"modifiedDate\": \"2019-06-07T16:27:17.027Z\",\r\n \"lastLoginDate\": \"2019-06-07T16:27:17.027Z\",\r\n \"status\": \"Active\",\r\n \"submerchantIds\": [\r\n 0\r\n ]\r\n }\r\n ]\r\n },\r\n \"status\": \"New\",\r\n \"numberOfBatchExceptions\": 0,\r\n \"numberOfTransactionExceptions\": 0,\r\n \"numberOfTransactions\": 0,\r\n \"numberOfAuthorizations\": 0,\r\n \"batchDate\": \"2019-06-07T16:27:17.027Z\",\r\n \"exceptionTotalAmount\": 0,\r\n \"keyedPercentage\": 0,\r\n \"declinedPercentage\": 0,\r\n \"refundCount\": 0,\r\n \"refundPercentage\": 0,\r\n \"fallBackcount\": 0,\r\n \"fallbackPercentage\": 0,\r\n \"foreignCardPercentage\": 0,\r\n \"chargebackAmount\": 0,\r\n \"chargebackPercentage\": 0,\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-06-07T16:27:17.027Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ],\r\n \"batchExceptions\": [\r\n {\r\n \"id\": 0,\r\n \"exceptionType\": \"string\"\r\n }\r\n ],\r\n \"transactionExceptions\": [\r\n {\r\n \"id\": 0,\r\n \"arn\": \"string\",\r\n \"batchId\": 0,\r\n \"submerchantId\": 0,\r\n \"transactionAmount\": 0,\r\n \"status\": \"New\",\r\n \"transactionDate\": \"2019-06-07T16:27:17.027Z\",\r\n \"notes\": [\r\n {\r\n \"id\": 0,\r\n \"message\": \"string\",\r\n \"createdDate\": \"2019-06-07T16:27:17.027Z\",\r\n \"type\": \"NoteInternal\",\r\n \"createdBy\": \"string\"\r\n }\r\n ],\r\n \"cardLastFour\": \"string\",\r\n \"approvalCode\": \"string\",\r\n \"declined\": true,\r\n \"transactionType\": \"Deposit\",\r\n \"exceptions\": [\r\n {\r\n \"id\": 0,\r\n \"exceptionType\": \"string\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"totalRequestedDataCount\": 0,\r\n \"currentPage\": 0,\r\n \"pageSize\": 0,\r\n \"totalPages\": 0\r\n}"}],"_postman_id":"6616bf05-52d3-4df2-b04b-7595c1247602"},{"name":"View a Single Submerchant Batch Risk Exception Summary","id":"0072b8b0-625e-4d6d-bcd6-d0de7e3e0e03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseURL}}/api/:tenantId/riskexceptions/submerchantbatchexceptionsummary/:submerchantId/:batchId?summaryOnly","description":"Use this method to retrieve a single submerchant batch's risk exception.
\n","urlObject":{"path":["api",":tenantId","riskexceptions","submerchantbatchexceptionsummary",":submerchantId",":batchId"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"Boolean, optional. If true, the response does not contain transaction data
\n","type":"text/plain"},"key":"summaryOnly","value":null}],"variable":[{"id":"067f085e-816f-4ab7-8d0d-36d68bdf6ad3","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"e631a8c8-6dd1-4fc5-9ac7-d878c275f66c","description":{"content":"Integer, required. The submerchant's unique id
\n","type":"text/plain"},"type":"string","value":"","key":"submerchantId"},{"id":"b750f291-7aec-43e2-90e6-cf38ab38f60c","description":{"content":"Integer, required. The batch's unique id
\n","type":"text/plain"},"type":"string","value":"","key":"batchId"}]}},"response":[{"id":"20b70fa3-ab25-4b01-b273-df4b1b9cee7b","name":"View a Single Submerchant Batch Risk Exception Summary - With Summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/riskexceptions/submerchantbatchexceptionsummary/:submerchantId/:batchId?summaryOnly=true","host":["{{BaseURL}}"],"path":["api",":tenantId","riskexceptions","submerchantbatchexceptionsummary",":submerchantId",":batchId"],"query":[{"key":"summaryOnly","value":"true","description":"Boolean, optional. If true, the response does not contain transaction data"}],"variable":[{"key":"tenantId","value":"","description":"String, required. The unique id for the tenant"},{"key":"submerchantId","value":"","description":"Integer, required. The submerchant's unique id"},{"key":"batchId","value":"","description":"Integer, required. The batch's unique id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"batchId\": \"string\",\n \"submerchant\": {\n \"networkFundingSettings\": [\n {\n \"network\": \"Unknown\",\n \"appliesToAllNetworks\": true,\n \"status\": \"New\",\n \"statusLabel\": \"string\"\n }\n ],\n \"id\": 0,\n \"legalEntityName\": \"string\",\n \"dbaName\": \"string\",\n \"businessType\": \"string\",\n \"contactPhone\": \"string\",\n \"backgroundCheckResults\": \"string\",\n \"feeProfile\": {\n \"id\": 0,\n \"type\": \"FlatRate\",\n \"discountRate\": 0,\n \"transactionFee\": 0,\n \"monthlyFee\": 0,\n \"visaMastercardRate\": 0,\n \"visaMastercardFee\": 0,\n \"discoverFee\": 0,\n \"discoverRate\": 0,\n \"amexRate\": 0,\n \"amexFee\": 0,\n \"chargebackFee\": 0,\n \"gatewayFee\": 0,\n \"batchFee\": 0,\n \"returnFee\": 0,\n \"feeBilling\": \"Monthly\",\n \"amexStatus\": \"Conveyed\",\n \"chargePayfacFeeOnRefunds\": true\n },\n \"achFees\": [\n {\n \"type\": \"Discount\",\n \"transactionFee\": 0,\n \"representmentFee\": 0,\n \"returnFee\": 0\n }\n ],\n \"locations\": [\n null\n ],\n \"merchantIdentifiers\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"accountStatus\": \"Active\",\n \"createdDate\": \"2019-06-07T17:42:43.430Z\",\n \"createdBy\": \"string\",\n \"modifiedDate\": \"2019-06-07T17:42:43.430Z\",\n \"modifiedBy\": \"string\",\n \"taxIdNumber\": \"string\",\n \"businessAddressId\": 0,\n \"businessAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"countryRegion\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\"\n },\n \"useDifferentMailingAddress\": true,\n \"mailingAddressId\": 0,\n \"mailingAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"countryRegion\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\"\n },\n \"timeZone\": \"string\",\n \"websiteAddress\": \"string\",\n \"principalFirstName\": \"string\",\n \"principalMiddleName\": \"string\",\n \"principalLastName\": \"string\",\n \"principalAddressId\": 0,\n \"principalAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"countryRegion\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\"\n },\n \"bankAddressId\": 0,\n \"bankAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"countryRegion\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\"\n },\n \"principalPhone\": \"string\",\n \"annualCreditCardSalesVolume\": 0,\n \"hasAcceptedCreditCards\": true,\n \"bankAccount\": \"string\",\n \"bankRouting\": \"string\",\n \"merchantCategoryCode\": \"string\",\n \"principalEmail\": \"string\",\n \"terminals\": [\n {\n \"id\": 0,\n \"terminalId\": \"string\"\n }\n ],\n \"users\": [\n {\n \"id\": 0,\n \"userRole\": \"Submerchant\",\n \"name\": \"string\",\n \"emailAddress\": \"string\",\n \"createdDate\": \"2019-06-07T17:42:43.430Z\",\n \"createdBy\": \"string\",\n \"modifiedBy\": \"string\",\n \"modifiedDate\": \"2019-06-07T17:42:43.430Z\",\n \"lastLoginDate\": \"2019-06-07T17:42:43.430Z\",\n \"status\": \"Active\",\n \"submerchantIds\": [\n 0\n ]\n }\n ]\n },\n \"status\": \"New\",\n \"numberOfBatchExceptions\": 0,\n \"numberOfTransactionExceptions\": 0,\n \"numberOfTransactions\": 0,\n \"numberOfAuthorizations\": 0,\n \"batchDate\": \"2019-06-07T17:42:43.430Z\",\n \"exceptionTotalAmount\": 0,\n \"keyedPercentage\": 0,\n \"declinedPercentage\": 0,\n \"refundCount\": 0,\n \"refundPercentage\": 0,\n \"fallBackcount\": 0,\n \"fallbackPercentage\": 0,\n \"foreignCardPercentage\": 0,\n \"chargebackAmount\": 0,\n \"chargebackPercentage\": 0,\n \"notes\": [\n {\n \"id\": 0,\n \"message\": \"string\",\n \"createdDate\": \"2019-06-07T17:42:43.430Z\",\n \"type\": \"NoteInternal\",\n \"createdBy\": \"string\"\n }\n ],\n \"batchExceptions\": [\n {\n \"id\": 0,\n \"exceptionType\": \"string\"\n }\n ],\n \"transactionExceptions\": [\n {\n \"id\": 0,\n \"arn\": \"string\",\n \"batchId\": 0,\n \"submerchantId\": 0,\n \"transactionAmount\": 0,\n \"status\": \"New\",\n \"transactionDate\": \"2019-06-07T17:42:43.430Z\",\n \"notes\": [\n {\n \"id\": 0,\n \"message\": \"string\",\n \"createdDate\": \"2019-06-07T17:42:43.430Z\",\n \"type\": \"NoteInternal\",\n \"createdBy\": \"string\"\n }\n ],\n \"cardLastFour\": \"string\",\n \"approvalCode\": \"string\",\n \"declined\": true,\n \"transactionType\": \"Deposit\",\n \"exceptions\": [\n {\n \"id\": 0,\n \"exceptionType\": \"string\"\n }\n ]\n }\n ]\n}"},{"id":"45b89b92-4f0f-42c2-b964-c1e0071291c1","name":"View a Single Submerchant Batch Risk Exception Summary - Without Summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/riskexceptions/submerchantbatchexceptionsummary/:submerchantId/:batchId?summaryOnly=false","host":["{{BaseURL}}"],"path":["api",":tenantId","riskexceptions","submerchantbatchexceptionsummary",":submerchantId",":batchId"],"query":[{"key":"summaryOnly","value":"false","description":"Boolean, optional. If true, the response does not contain transaction data"}],"variable":[{"key":"tenantId","value":"","description":"String, required. The unique id for the tenant"},{"key":"submerchantId","value":"","description":"Integer, required. The submerchant's unique id"},{"key":"batchId","value":"","description":"Integer, required. The batch's unique id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"batchId\": \"string\",\n \"submerchant\": {\n \"networkFundingSettings\": [\n {\n \"network\": \"Unknown\",\n \"appliesToAllNetworks\": true,\n \"status\": \"New\",\n \"statusLabel\": \"string\"\n }\n ],\n \"id\": 0,\n \"legalEntityName\": \"string\",\n \"dbaName\": \"string\",\n \"businessType\": \"string\",\n \"contactPhone\": \"string\",\n \"backgroundCheckResults\": \"string\",\n \"feeProfile\": {\n \"id\": 0,\n \"type\": \"FlatRate\",\n \"discountRate\": 0,\n \"transactionFee\": 0,\n \"monthlyFee\": 0,\n \"visaMastercardRate\": 0,\n \"visaMastercardFee\": 0,\n \"discoverFee\": 0,\n \"discoverRate\": 0,\n \"amexRate\": 0,\n \"amexFee\": 0,\n \"chargebackFee\": 0,\n \"gatewayFee\": 0,\n \"batchFee\": 0,\n \"returnFee\": 0,\n \"feeBilling\": \"Monthly\",\n \"amexStatus\": \"Conveyed\",\n \"chargePayfacFeeOnRefunds\": true\n },\n \"achFees\": [\n {\n \"type\": \"Discount\",\n \"transactionFee\": 0,\n \"representmentFee\": 0,\n \"returnFee\": 0\n }\n ],\n \"locations\": [\n null\n ],\n \"merchantIdentifiers\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n },\n \"accountStatus\": \"Active\",\n \"createdDate\": \"2019-06-07T17:42:43.430Z\",\n \"createdBy\": \"string\",\n \"modifiedDate\": \"2019-06-07T17:42:43.430Z\",\n \"modifiedBy\": \"string\",\n \"taxIdNumber\": \"string\",\n \"businessAddressId\": 0,\n \"businessAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"countryRegion\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\"\n },\n \"useDifferentMailingAddress\": true,\n \"mailingAddressId\": 0,\n \"mailingAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"countryRegion\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\"\n },\n \"timeZone\": \"string\",\n \"websiteAddress\": \"string\",\n \"principalFirstName\": \"string\",\n \"principalMiddleName\": \"string\",\n \"principalLastName\": \"string\",\n \"principalAddressId\": 0,\n \"principalAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"countryRegion\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\"\n },\n \"bankAddressId\": 0,\n \"bankAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"countryRegion\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\"\n },\n \"principalPhone\": \"string\",\n \"annualCreditCardSalesVolume\": 0,\n \"hasAcceptedCreditCards\": true,\n \"bankAccount\": \"string\",\n \"bankRouting\": \"string\",\n \"merchantCategoryCode\": \"string\",\n \"principalEmail\": \"string\",\n \"terminals\": [\n {\n \"id\": 0,\n \"terminalId\": \"string\"\n }\n ],\n \"users\": [\n {\n \"id\": 0,\n \"userRole\": \"Submerchant\",\n \"name\": \"string\",\n \"emailAddress\": \"string\",\n \"createdDate\": \"2019-06-07T17:42:43.430Z\",\n \"createdBy\": \"string\",\n \"modifiedBy\": \"string\",\n \"modifiedDate\": \"2019-06-07T17:42:43.430Z\",\n \"lastLoginDate\": \"2019-06-07T17:42:43.430Z\",\n \"status\": \"Active\",\n \"submerchantIds\": [\n 0\n ]\n }\n ]\n },\n \"status\": \"New\",\n \"numberOfBatchExceptions\": 0,\n \"numberOfTransactionExceptions\": 0,\n \"numberOfTransactions\": 0,\n \"numberOfAuthorizations\": 0,\n \"batchDate\": \"2019-06-07T17:42:43.430Z\",\n \"exceptionTotalAmount\": 0,\n \"keyedPercentage\": 0,\n \"declinedPercentage\": 0,\n \"refundCount\": 0,\n \"refundPercentage\": 0,\n \"fallBackcount\": 0,\n \"fallbackPercentage\": 0,\n \"foreignCardPercentage\": 0,\n \"chargebackAmount\": 0,\n \"chargebackPercentage\": 0,\n \"notes\": [\n {\n \"id\": 0,\n \"message\": \"string\",\n \"createdDate\": \"2019-06-07T17:42:43.430Z\",\n \"type\": \"NoteInternal\",\n \"createdBy\": \"string\"\n }\n ],\n \"batchExceptions\": [\n {\n \"id\": 0,\n \"exceptionType\": \"string\"\n }\n ]\n}"}],"_postman_id":"0072b8b0-625e-4d6d-bcd6-d0de7e3e0e03"},{"name":"Create/Update an Exception Report","id":"9a0b392d-5649-4b3d-bf05-b925b5b1b0b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key value
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"displayName\": \"Transaction Over Maximum\",\r\n \"description\": \"A ticket is over the maximum when any one sale amount in any one batch exceeds the average or maximum amount approved for that submerchant as defined in the submerchant’s profile.\",\r\n \"isPayfac\": true,\r\n \"activateDate\": \"2019-04-29\",\r\n \"exceptionLogicId\": \"TransactionOverMaximum\",\r\n \"thresholdValue\": \"600\"\r\n}"},"url":"{{BaseURL}}/api/:tenant/riskexceptions/definitions","description":"Use this method to create a new exception report, or update an existing exception report.
\nTo update an existing record, use the existing submerchantId in the body.
Schema
\n","urlObject":{"path":["api",":tenant","riskexceptions","definitions"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"a5e12829-d897-4a4e-978d-53e0a73c975a","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"}]}},"response":[{"id":"06ef814a-b447-4ea1-aecc-7abd5a23cb21","name":"Create/Update an Exception Report","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"displayName\": \"Transaction Over Maximum\",\r\n \"description\": \"A ticket is over the maximum when any one sale amount in any one batch exceeds the average or maximum amount approved for that submerchant as defined in the submerchant’s profile.\",\r\n \"isPayfac\": true,\r\n \"activateDate\": \"2019-04-29\",\r\n \"exceptionLogicId\": \"TransactionOverMaximum\",\r\n \"thresholdValue\": \"600\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenant/riskexceptions/definitions","host":["{{BaseURL}}"],"path":["api",":tenant","riskexceptions","definitions"],"variable":[{"key":"tenant","value":"","description":"String, required. The unique id for the tenant"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"commandFingerprint\": \"ab3d29ba-672c-4da4-8033-d71c9fa8abe8\",\n \"status\": 0,\n \"createTime\": \"2019-05-10T21:31:16.7454144+00:00\",\n \"endTime\": null,\n \"error\": null,\n \"message\": null\n}"}],"_postman_id":"9a0b392d-5649-4b3d-bf05-b925b5b1b0b2"}],"id":"675602fd-3387-462a-911f-12b02f49b0eb","event":[{"listen":"prerequest","script":{"id":"48d39fd8-77c2-460b-ac74-de1705e494e5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"56d22557-b354-43c2-a3b0-a0771bd0f8ba","type":"text/javascript","exec":[""]}}],"_postman_id":"675602fd-3387-462a-911f-12b02f49b0eb","description":""},{"name":"Reconciliation Report","item":[{"name":"Reconciliation Report - Single Day","id":"9be70527-684b-4e12-ac03-193277f429d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/reconciliation/report?date=MM/DD/YYYY","description":"Use this to run the reconciliation report for all submerchants for a specific day.
\n","urlObject":{"path":["api",":tenantId","reconciliation","report"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"The date you need to pull the report for. Can separate using / or -
\n","type":"text/plain"},"key":"date","value":"MM/DD/YYYY"}],"variable":[{"id":"c55cd066-e9cd-4c3c-8374-e7c3a68d5667","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"f32f4257-2c81-42f4-aa86-106ea8af25a3","name":"Reconciliation Report Request","originalRequest":{"method":"GET","header":[{"key":"AuthenticationKey","value":"{{AuthenticationToken}}","disabled":false}],"url":{"raw":"{{BaseURL}}/api/Tenant1/reconciliation/report?date=04/23/2018","host":["{{BaseURL}}"],"path":["api","Tenant1","reconciliation","report"],"query":[{"key":"date","value":"04/23/2018","description":"The date you need to pull the report for. Formatting is MM/DD/YYYY. Required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Type","value":"text/csv","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 22:08:24 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"content-disposition","value":"attachment;filename=20180423ReconciliationReport.csv","name":"content-disposition","description":"An opportunity to raise a \"File Download\" dialogue box for a known MIME type"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"devfundingapi.azurewebsites.net","path":"/","secure":false,"value":"66a1bfe162ac16ed53bae398c7e8a736f694ec7e0cbfdbabdcea80720809d04c","key":"ARRAffinity"}],"responseTime":null,"body":"{\r\n \"reconciliationDate\": \"2018-08-13T18:22:41.032Z\",\r\n \"grossDeposit\": 0,\r\n \"chargebacks\": 0,\r\n \"refunds\": 0,\r\n \"achRejects\": 0,\r\n \"interchangePassThrough\": 0,\r\n \"processorFees\": 0,\r\n \"totalFundsReceived\": 0,\r\n \"fundingToSubmerchant\": 0,\r\n \"fundingDelays\": 0,\r\n \"addedToOperating\": 0,\r\n \"heldToday\": 0,\r\n \"otherDeposits\": 0,\r\n \"discountCharged\": 0,\r\n \"transactionFeeCharged\": 0,\r\n \"otherFeeCharged\": 0,\r\n \"previousBalance\": 0,\r\n \"totalFundsOnHold\": 0,\r\n \"totalFundsReleasingToday\": 0,\r\n \"settlementAccountBalance\": 0,\r\n \"submerchantDeposits\": [\r\n {\r\n \"name\": \"string\",\r\n \"batchTotal\": 0,\r\n \"sumOfTransactions\": 0,\r\n \"chargeBacks\": 0,\r\n \"refunds\": 0,\r\n \"sumOfTransactionFees\": 0,\r\n \"otherFees\": 0\r\n }\r\n ]\r\n}"}],"_postman_id":"9be70527-684b-4e12-ac03-193277f429d4"},{"name":"Reconciliation Report - Single Day","id":"85e38026-7379-4bf5-80e3-9a4dc219dd18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/reconciliation/:date","description":"Use this method to view results of the reconciliation report for a single day.
\n","urlObject":{"path":["api",":tenantId","reconciliation",":date"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"37b1867a-2468-4de4-8f78-ad62ac39d37c","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"490ebf98-f200-4389-bc11-087ff3a58ec7","description":{"content":"The date you need to pull the report for. Can separate using only -
\n","type":"text/plain"},"type":"string","value":"MM-DD-YYYY","key":"date"}]}},"response":[{"id":"7b4fca01-c521-4f88-9b8f-e5e5bc8395bc","name":"Reconciliation Report - Single Day","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\n \"reconciliationDate\": \"2018-08-13T00:00:00\",\n \"grossDeposit\": 0,\n \"chargebacks\": 0,\n \"refunds\": 0,\n \"achRejects\": 0,\n \"interchangePassThrough\": 0,\n \"processorFees\": 0,\n \"totalFundsReceived\": 0,\n \"fundingToSubmerchant\": 0,\n \"fundingDelays\": 0,\n \"addedToOperating\": 0,\n \"heldToday\": 0,\n \"otherDeposits\": 0,\n \"discountCharged\": 0,\n \"transactionFeeCharged\": 0,\n \"otherFeeCharged\": 0,\n \"previousBalance\": 0.0,\n \"totalFundsOnHold\": 0.0,\n \"totalFundsReleasingToday\": 0,\n \"settlementAccountBalance\": 0.0,\n \"submerchantDeposits\": []\n}"}],"_postman_id":"85e38026-7379-4bf5-80e3-9a4dc219dd18"},{"name":"Reconciliation Report - Multiple Days","id":"eaef2a26-0597-4c9c-8698-e311c52c6115","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/reconciliation/reports?startDate=MMDDYYYY&endDate=MMDDYYYY","description":"Use this request to run the reconciliation report for multiple days.
\n","urlObject":{"path":["api",":tenantId","reconciliation","reports"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"The start date of the report results
\n","type":"text/plain"},"key":"startDate","value":"MMDDYYYY"},{"description":{"content":"The end date of the report results
\n","type":"text/plain"},"key":"endDate","value":"MMDDYYYY"}],"variable":[{"id":"97beca54-8971-423e-9d12-49414af3deb1","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"cba61f32-cb2f-4966-bf91-ea2327d3fd6c","name":"Reconciliation Report - Multiple Days","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/reconciliation/reports?startDate=MMDDYYYY&endDate=MMDDYYYY","host":["{{BaseURL}}"],"path":["api",":tenantId","reconciliation","reports"],"query":[{"key":"startDate","value":"MMDDYYYY","description":"The start date of the report results"},{"key":"endDate","value":"MMDDYYYY","description":"The end date of the report results"}],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"reconciliationDate\": \"2018-08-13T17:23:39.475Z\",\r\n \"grossDeposit\": 0,\r\n \"chargebacks\": 0,\r\n \"refunds\": 0,\r\n \"achRejects\": 0,\r\n \"interchangePassThrough\": 0,\r\n \"processorFees\": 0,\r\n \"totalFundsReceived\": 0,\r\n \"fundingToSubmerchant\": 0,\r\n \"fundingDelays\": 0,\r\n \"addedToOperating\": 0,\r\n \"heldToday\": 0,\r\n \"otherDeposits\": 0,\r\n \"discountCharged\": 0,\r\n \"transactionFeeCharged\": 0,\r\n \"otherFeeCharged\": 0,\r\n \"previousBalance\": 0,\r\n \"totalFundsOnHold\": 0,\r\n \"totalFundsReleasingToday\": 0,\r\n \"settlementAccountBalance\": 0,\r\n \"submerchantDeposits\": [\r\n {\r\n \"name\": \"string\",\r\n \"batchTotal\": 0,\r\n \"sumOfTransactions\": 0,\r\n \"chargeBacks\": 0,\r\n \"refunds\": 0,\r\n \"sumOfTransactionFees\": 0,\r\n \"otherFees\": 0\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"eaef2a26-0597-4c9c-8698-e311c52c6115"}],"id":"113ec6f2-2ebc-4477-932b-f8e3b6c3bbeb","description":"The Reconciliation Report provides a daily look at the settlement overview and submerchant deposits. Use the following methods to run the reconciliation report.
\nThe report details include:
\nSettlement Overview
\nSubmerchant Deposits
\nThe authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/Reports/submerchantfees?reportStartDate=MMDDYYYY&reportEndDate=MMDDYYYY","urlObject":{"path":["api",":tenantId","Reports","submerchantfees"],"host":["{{BaseURL}}"],"query":[{"key":"reportStartDate","value":"MMDDYYYY"},{"key":"reportEndDate","value":"MMDDYYYY"}],"variable":[{"id":"a06e2163-2970-440a-ae42-e1af779d2bb3","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"c16c651d-3193-4d5b-a3d2-5d102b276192","name":"Submerchant Fee Report","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/Reports/submerchantfees?reportStartDate=MMDDYYYY&reportEndDate=MMDDYYYY","host":["{{BaseURL}}"],"path":["api",":tenantId","Reports","submerchantfees"],"query":[{"key":"reportStartDate","value":"MMDDYYYY"},{"key":"reportEndDate","value":"MMDDYYYY"}],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"reportStartDate\": \"2018-08-13T19:13:34.625Z\",\r\n \"reportEndDate\": \"2018-08-13T19:13:34.625Z\",\r\n \"submerchants\": [\r\n {\r\n \"submerchant\": {\r\n \"id\": 0,\r\n \"legalEntityName\": \"string\",\r\n \"dbaName\": \"string\",\r\n \"businessType\": \"string\",\r\n \"contactPhone\": \"string\",\r\n \"backgroundCheckResults\": \"string\",\r\n \"feeProfile\": {\r\n \"id\": 0,\r\n \"type\": \"FlatRate\",\r\n \"discountRate\": 0,\r\n \"transactionFee\": 0,\r\n \"monthlyFee\": 0,\r\n \"visaMastercardRate\": 0,\r\n \"visaMastercardFee\": 0,\r\n \"discoverFee\": 0,\r\n \"discoverRate\": 0,\r\n \"amexRate\": 0,\r\n \"amexFee\": 0,\r\n \"chargebackFee\": 0,\r\n \"gatewayFee\": 0,\r\n \"batchFee\": 0,\r\n \"feeBilling\": \"Monthly\"\r\n },\r\n \"achFees\": [\r\n {\r\n \"type\": \"Discount\",\r\n \"transactionFee\": 0,\r\n \"representmentFee\": 0,\r\n \"returnFee\": 0\r\n }\r\n ],\r\n \"locations\": [\r\n null\r\n ],\r\n \"merchantIdentifiers\": {\r\n \"additionalProp1\": \"string\",\r\n \"additionalProp2\": \"string\",\r\n \"additionalProp3\": \"string\"\r\n },\r\n \"accountStatus\": \"Active\",\r\n \"createdDate\": \"2018-08-13T19:13:34.625Z\",\r\n \"createdBy\": \"string\",\r\n \"modifiedDate\": \"2018-08-13T19:13:34.625Z\",\r\n \"modifiedBy\": \"string\",\r\n \"taxIdNumber\": \"string\",\r\n \"businessAddressId\": 0,\r\n \"businessAddress\": {\r\n \"line1\": \"string\",\r\n \"line2\": \"string\",\r\n \"city\": \"string\",\r\n \"countryRegion\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\"\r\n },\r\n \"useDifferentMailingAddress\": true,\r\n \"mailingAddressId\": 0,\r\n \"mailingAddress\": {\r\n \"line1\": \"string\",\r\n \"line2\": \"string\",\r\n \"city\": \"string\",\r\n \"countryRegion\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\"\r\n },\r\n \"timeZone\": \"string\",\r\n \"websiteAddress\": \"string\",\r\n \"principalFirstName\": \"string\",\r\n \"principalMiddleName\": \"string\",\r\n \"principalLastName\": \"string\",\r\n \"principalAddressId\": 0,\r\n \"principalAddress\": {\r\n \"line1\": \"string\",\r\n \"line2\": \"string\",\r\n \"city\": \"string\",\r\n \"countryRegion\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\"\r\n },\r\n \"bankAddressId\": 0,\r\n \"bankAddress\": {\r\n \"line1\": \"string\",\r\n \"line2\": \"string\",\r\n \"city\": \"string\",\r\n \"countryRegion\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\"\r\n },\r\n \"principalPhone\": \"string\",\r\n \"annualCreditCardSalesVolume\": 0,\r\n \"hasAcceptedCreditCards\": true,\r\n \"bankAccount\": \"string\",\r\n \"bankRouting\": \"string\",\r\n \"merchantCategoryCode\": \"string\",\r\n \"principalEmail\": \"string\",\r\n \"terminals\": [\r\n {\r\n \"id\": 0,\r\n \"terminalId\": \"string\"\r\n }\r\n ],\r\n \"users\": [\r\n {\r\n \"id\": 0,\r\n \"userRole\": \"Submerchant\",\r\n \"name\": \"string\",\r\n \"emailAddress\": \"string\",\r\n \"createdDate\": \"2018-08-13T19:13:34.625Z\",\r\n \"createdBy\": \"string\",\r\n \"modifiedBy\": \"string\",\r\n \"modifiedDate\": \"2018-08-13T19:13:34.625Z\",\r\n \"lastLoginDate\": \"2018-08-13T19:13:34.625Z\",\r\n \"status\": \"Active\",\r\n \"submerchantIds\": [\r\n 0\r\n ]\r\n }\r\n ]\r\n },\r\n \"fees\": [\r\n {\r\n \"network\": \"Unknown\",\r\n \"transactionCount\": 0,\r\n \"refundCount\": 0,\r\n \"feeTotal\": 0,\r\n \"transactionTotal\": 0,\r\n \"refundTotal\": 0,\r\n \"refundFeeTotal\": 0\r\n }\r\n ],\r\n \"networkFeesTotal\": 0,\r\n \"payfacFeesTotal\": 0,\r\n \"transactionFeesTotal\": 0,\r\n \"batchFeesTotal\": 0,\r\n \"monthlyFeesTotal\": 0,\r\n \"chargebackFeesTotal\": 0,\r\n \"gatewayFeesTotal\": 0,\r\n \"otherFeesTotal\": 0\r\n }\r\n ]\r\n}"}],"_postman_id":"c73209be-46ed-4562-a46e-19f0c471580e"}],"id":"1852903f-7012-4088-9129-a371fa1a6fba","_postman_id":"1852903f-7012-4088-9129-a371fa1a6fba","description":""}],"id":"b0cab3a4-a9c6-4423-a163-124fb2c87f66","_postman_id":"b0cab3a4-a9c6-4423-a163-124fb2c87f66","description":""},{"name":"Settings","item":[{"name":"Chargeback Notifiations","item":[{"name":"Review All Chargeback Notifications","id":"b943a30f-1ff3-4a6d-a8bd-3b6ab85ff26f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications","description":"Use this method to review all chargeback notifications.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","Settings","chargebacks","notifications"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"4b2fc8b1-552e-4f44-9815-a2d1be767fef","description":{"content":"The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"String, required","key":"tenantId"}]}},"response":[{"id":"226fd3ed-8210-4fcf-b480-cb2431dc896a","name":"Review All Chargeback Notifications","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications","host":["{{BaseURL}}"],"path":["api",":tenantId","Settings","chargebacks","notifications"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 0,\r\n \"subjectLine\": \"string\",\r\n \"emailHtml\": \"string\",\r\n \"sendOnDay\": 0,\r\n \"timeToSend\": \"2018-08-03T22:32:49.328Z\"\r\n }\r\n]"}],"_postman_id":"b943a30f-1ff3-4a6d-a8bd-3b6ab85ff26f"},{"name":"Review a Chargeback Notification","id":"32f40185-a78e-4d65-8ac1-b48aaf7e74d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications/:id","description":"Use this method to review information about a single chargeback notification.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","Settings","chargebacks","notifications",":id"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"3f426148-71d2-4966-944b-dace59b962a0","description":{"content":"The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"String, required","key":"tenantId"},{"id":"c7fb8635-7496-4d52-9cf9-08264331a02c","description":{"content":"The unique id of the chargeback notification
\n","type":"text/plain"},"type":"string","value":"Integer, required","key":"id"}]}},"response":[{"id":"e8935796-f21b-493c-a748-b44e5ae26361","name":"Review a Chargeback Notification","originalRequest":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"url":{"raw":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications/:id","host":["{{BaseURL}}"],"path":["api",":tenantId","Settings","chargebacks","notifications",":id"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"id","value":"Integer, required","description":"The unique id of the chargeback notification"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 0,\r\n \"subjectLine\": \"string\",\r\n \"emailHtml\": \"string\",\r\n \"sendOnDay\": 0,\r\n \"timeToSend\": \"2018-08-03T22:35:52.067Z\"\r\n}"}],"_postman_id":"32f40185-a78e-4d65-8ac1-b48aaf7e74d4"},{"name":"Create a Chargeback Notification","id":"92e3a268-3d02-46e5-ab74-ad91d878a555","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication value
\n"}],"body":{"mode":"raw","raw":"{\r\n \"subjectLine\": \"string\",\r\n \"emailHtml\": \"string\",\r\n \"sendOnDay\": 0,\r\n \"timeToSend\": \"2018-08-03T21:49:29.021Z\"\r\n}"},"url":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications","description":"Use this method to create a new chargeback notification.
\nSchema
\n","urlObject":{"path":["api",":tenantId","Settings","chargebacks","notifications"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"4393e5b3-81f5-40f9-acdb-7c2b786764b0","description":{"content":"The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"String, required","key":"tenantId"}]}},"response":[{"id":"a530ece3-34b2-46ac-8281-56f3f74f422b","name":"Create a Chargeback Notification","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication value"}],"body":{"mode":"raw","raw":"{\r\n \"subjectLine\": \"string\",\r\n \"emailHtml\": \"string\",\r\n \"sendOnDay\": 0,\r\n \"timeToSend\": \"2018-08-03T21:49:29.021Z\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications","host":["{{BaseURL}}"],"path":["api",":tenantId","Settings","chargebacks","notifications"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-03T22:35:01.788Z\",\r\n \"endTime\": \"2018-08-03T22:35:01.788Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"92e3a268-3d02-46e5-ab74-ad91d878a555"},{"name":"Update a Chargeback Notification","id":"8b526fa7-d9c4-4d8e-8398-01f5e930a11a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"{\r\n \"subjectLine\": \"string\",\r\n \"emailHtml\": \"string\",\r\n \"sendOnDay\": 0,\r\n \"timeToSend\": \"2018-08-03T21:54:58.925Z\"\r\n}"},"url":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications/:id","description":"Use this method to update a chargeback notification.
\nSchema
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","Settings","chargebacks","notifications",":id"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"546c0e28-505d-4db9-85cd-1e200ee6f04a","description":{"content":"The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"String, required","key":"tenantId"},{"id":"330feec9-c51a-41e5-88f9-52f3580fa2a8","description":{"content":"The unique id of the chargeback notification
\n","type":"text/plain"},"type":"string","value":"Integer, required","key":"id"}]}},"response":[{"id":"a2f8887e-2146-4582-b849-30f0b5b3c979","name":"Review a Chargeback Notification Copy","originalRequest":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"raw","raw":"{\r\n \"subjectLine\": \"string\",\r\n \"emailHtml\": \"string\",\r\n \"sendOnDay\": 0,\r\n \"timeToSend\": \"2018-08-03T21:54:58.925Z\"\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications/:id","host":["{{BaseURL}}"],"path":["api",":tenantId","Settings","chargebacks","notifications",":id"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"id","value":"Integer, required","description":"The unique id of the chargeback notification"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-03T22:36:15.380Z\",\r\n \"endTime\": \"2018-08-03T22:36:15.380Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"8b526fa7-d9c4-4d8e-8398-01f5e930a11a"},{"name":"Delete a Chargeback Notification","id":"32c7a467-5a12-4e7f-a150-6a561740ff6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications/:id","description":"Use this method to delete a chargeback notification.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","Settings","chargebacks","notifications",":id"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"87934161-e1de-4834-882e-ce56efa8abc2","description":{"content":"The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"String, required","key":"tenantId"},{"id":"85c9d182-29fa-4f5a-87f5-9dd0a9a1a897","description":{"content":"The unique id of the chargeback id
\n","type":"text/plain"},"type":"string","value":"Integer, required","key":"id"}]}},"response":[{"id":"26b69ff7-5482-44a3-8754-b25e67180835","name":"Delete a Chargeback Notification","originalRequest":{"method":"DELETE","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/Settings/chargebacks/notifications/:id","host":["{{BaseURL}}"],"path":["api",":tenantId","Settings","chargebacks","notifications",":id"],"variable":[{"key":"tenantId","value":"String, required","description":"The unique id of the tenant"},{"key":"id","value":"Integer, required","description":"The unique id of the chargeback id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2018-08-03T22:37:18.225Z\",\r\n \"endTime\": \"2018-08-03T22:37:18.225Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"32c7a467-5a12-4e7f-a150-6a561740ff6f"}],"id":"9024780c-40a1-44d4-a1cc-430840fd16ff","description":"When a new chargeback posts in the Backoffice application, the submerchant can be notified via email. You can customize the email subject line, email body, the day that the notification is received after it posts, and the time the notification is sent.
\n","event":[{"listen":"prerequest","script":{"id":"a37864cb-afb8-4282-90a7-b1a88371dfe8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a3ba2efc-7122-4036-a29a-844fda96e101","type":"text/javascript","exec":[""]}}],"_postman_id":"9024780c-40a1-44d4-a1cc-430840fd16ff"}],"id":"cb653546-2ef5-4b95-9250-fac8039bca4a","_postman_id":"cb653546-2ef5-4b95-9250-fac8039bca4a","description":""},{"name":"User Roles","item":[{"name":"Create or Modify Users","item":[{"name":"Change User Role","id":"d125caf0-b7b8-45d3-9f45-fc7d2f77a1c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/user/:identifier/role/:newRole?changedBy=","description":"Use this to change a user's role.
\n","urlObject":{"path":["api",":tenantId","user",":identifier","role",":newRole"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"The username of who changed the role
\n","type":"text/plain"},"key":"changedBy","value":""}],"variable":[{"id":"724533c3-96f3-47bd-a0a3-377acfedac0b","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"ec04bd79-f832-4a59-8280-5bd789ba8805","description":{"content":"String, required. The unique identifier of the user, such as name or email address
\n","type":"text/plain"},"type":"string","value":"","key":"identifier"},{"id":"a9b3c5fb-cf58-476f-a1c1-99a4ae008013","description":{"content":"Integer, required. The role id
\n","type":"text/plain"},"type":"string","value":"","key":"newRole"}]}},"response":[{"id":"f2a2dc0f-be13-4767-b917-14b776902805","name":"Change User Role","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/user/:identifier/role/:newRole","host":["{{BaseURL}}"],"path":["api",":tenantId","user",":identifier","role",":newRole"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"identifier","value":"janedoe@example.com"},{"key":"newRole","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"d125caf0-b7b8-45d3-9f45-fc7d2f77a1c5"},{"name":"Change User Name","id":"c1ba76e9-b6a1-412b-89d0-d609e9766b9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/user/:identifier/name/:newName?changedBy","description":"If a user has gone through a name change, use this to update their name.
\n","urlObject":{"path":["api",":tenantId","user",":identifier","name",":newName"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"The username of who changed the name
\n","type":"text/plain"},"key":"changedBy","value":null}],"variable":[{"id":"6bd04d9a-3301-4f93-bc28-23f88e3aa4f2","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"727b4ea5-801c-458e-a005-02bc95ddd3f5","description":{"content":"String, required. The unique identifier of the user, such as name or email address
\n","type":"text/plain"},"type":"string","value":"","key":"identifier"},{"id":"d7975cd4-1dc3-4eb8-860a-b6a72ea7318a","description":{"content":"String, required. The user's new name
\n","type":"text/plain"},"type":"string","value":"","key":"newName"}]}},"response":[{"id":"4b6cf29b-0036-40c1-bc21-c74b170119b3","name":"Change User Name","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/user/:identifier/name/:newName","host":["{{BaseURL}}"],"path":["api",":tenantId","user",":identifier","name",":newName"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"identifier","value":"janedoe@example.com"},{"key":"newName","value":"Jane A Doe"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"c1ba76e9-b6a1-412b-89d0-d609e9766b9e"},{"name":"Create User","id":"bad8567a-d905-4ebc-8919-15bd6b8d6cf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"raw","raw":"{\n \"UserRole\": 0,\n \"Name\":\"Jane Doe\",\n \"EmailAddress\":\"janedoe@example.com\",\n \"CreatedBy\":\"systemadministrator@example.com\"\n}"},"url":"{{BaseURL}}/api/:tenant/user","description":"Use this to create a user. If you are creating a submerchant, enter the submerchantId into the body that the user should be associated to.
\nResponse Schema
\n","urlObject":{"path":["api",":tenant","user"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"507946b9-1397-4306-8a6f-740942b71b1e","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenant"}]}},"response":[{"id":"a3903d5e-fe71-4541-95f4-c77ec38b2b0c","name":"Create User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UserRole\": 0,\n \"Name\":\"Test User\",\n \"EmailAddress\":\"test@test.com\",\n \"CreatedBy\":\"Admin\"\n}"},"url":{"raw":"{{BaseURL}}/api/:tenant/user","host":["{{BaseURL}}"],"path":["api",":tenant","user"],"variable":[{"key":"tenant","value":"Tenant1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"bad8567a-d905-4ebc-8919-15bd6b8d6cf3"}],"id":"ea0ba77a-93f7-4e3d-bb1a-97a3ca143661","description":"Use the below methods to create users, modify a user's role, or change a user's name.
\n","event":[{"listen":"prerequest","script":{"id":"8a0fc88a-c084-4771-addd-6bfa6ec1f6f6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"30217add-0193-4a1a-939b-21598bf5184e","type":"text/javascript","exec":[""]}}],"_postman_id":"ea0ba77a-93f7-4e3d-bb1a-97a3ca143661"},{"name":"Deactivate or Reactivate Users","item":[{"name":"Reactivate User","id":"f66408ff-daab-4132-be38-752d8fa587d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/user/:identifier/reactivate?changedBy","description":"Use this to reactive an inactive user.
\n","urlObject":{"path":["api",":tenantId","user",":identifier","reactivate"],"host":["{{BaseURL}}"],"query":[{"description":{"content":"The user who reactivated the user
\n","type":"text/plain"},"key":"changedBy","value":null}],"variable":[{"id":"49fca6e5-d5c7-4f21-8b9a-1b5337b1677d","description":{"content":"String, required. The unique id of the client
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"a241d327-022b-45f0-8f92-107a41e527e2","description":{"content":"String, required. The unique identifier of the user, such as name or email address
\n","type":"text/plain"},"type":"string","value":"","key":"identifier"}]}},"response":[{"id":"6be6862a-e8e1-4bdd-81a2-a4ff253044ad","name":"Reactivate User","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/user/:identifier/reactivate","host":["{{BaseURL}}"],"path":["api",":tenantId","user",":identifier","reactivate"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"identifier","value":"janedoe@example.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"f66408ff-daab-4132-be38-752d8fa587d7"},{"name":"Deactivate User","id":"3e7c763a-d94d-4c56-a2c0-6c67d4dd861d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseURL}}/api/:tenantId/user/:identifier","description":"Use this to deactivate a user so they can no longer log in to the Backoffice application.
\n","urlObject":{"path":["api",":tenantId","user",":identifier"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"a64734d8-5d23-4a74-b05a-970a026c7c27","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"47c6fe49-9cd5-4347-a385-5b30dd09a9f0","description":{"content":"String, required. The unique identifier of the user, such as name or email address
\n","type":"text/plain"},"type":"string","value":"","key":"identifier"}]}},"response":[{"id":"abc28750-f2be-49bf-9de2-e36c065c449e","name":"Disable User","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{BaseURL}}/api/:tenantId/user/:identifier","host":["{{BaseURL}}"],"path":["api",":tenantId","user",":identifier"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"identifier","value":"janedoe@example.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"3e7c763a-d94d-4c56-a2c0-6c67d4dd861d"}],"id":"732d19f8-075a-443c-a569-3e8bc793f024","description":"Use these methods to deactivate or reactivate users.
\n","event":[{"listen":"prerequest","script":{"id":"361f740b-7e13-4fe7-ac31-a9804aea18ff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2ccec924-9ddb-41cd-8bf9-4a3c9b008a83","type":"text/javascript","exec":[""]}}],"_postman_id":"732d19f8-075a-443c-a569-3e8bc793f024"},{"name":"View User Information","item":[{"name":"View All Users","id":"af040a6e-aae7-46ec-83a6-9caccd2ec1aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/user","description":"Use this request to see all users within your tenant.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","user"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"e2390086-c2a2-48bf-8765-356b49004356","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"6ef6196f-ec78-4038-b60b-a33413d479d2","name":"View All Users","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/user","host":["{{BaseURL}}"],"path":["api",":tenantId","user"],"variable":[{"key":"tenantId","value":"Tenant1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 1,\r\n \"userRole\": 1,\r\n \"name\": \"Jane Doe\",\r\n \"emailAddress\": \"janedoe@example.com\",\r\n \"createdDate\": \"2018-01-01T23:32:09.473Z\",\r\n \"createdBy\": \"systemadmin@example.com\",\r\n \"modifiedBy\": \"systemadmin@example.com\",\r\n \"modifiedDate\": \"2018-05-01T23:32:09.473Z\",\r\n \"lastLoginDate\": \"2018-05-01T23:32:09.473Z\",\r\n \"status\": 0\r\n },\r\n {\r\n \"id\": 2,\r\n \"userRole\": 0,\r\n \"name\": \"John Doe\",\r\n \"emailAddress\": \"johndoe@example.com\",\r\n \"createdDate\": \"2018-03-25T04:29:13.4096604+00:00\",\r\n \"createdBy\": \"systemadmin@example.com\",\r\n \"modifiedBy\": \"janedoe@example.com\",\r\n \"modifiedDate\": \"2018-04-10T19:31:06.1262901+00:00\",\r\n \"lastLoginDate\": null,\r\n \"status\": 0\r\n },\r\n]"}],"_postman_id":"af040a6e-aae7-46ec-83a6-9caccd2ec1aa"},{"name":"View All Tenant Names That User Has Access To","id":"58fcc40c-33c9-4375-8b95-cc1e520ba49f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKey","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/user/:emailAddress/tenants","description":"Payment facilitator users or other users may need access to more than one tenant. Use this to see which tenants a single user has access to.
\n","urlObject":{"path":["api",":tenantId","user",":emailAddress","tenants"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"c035c906-d914-4339-8503-578f06bd7b0d","description":{"content":"String, required. The unique id for the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"6d5d580b-dd6f-469a-a665-50967faccfba","description":{"content":"String, required. The user's email address
\n","type":"text/plain"},"type":"string","value":"","key":"emailAddress"}]}},"response":[{"id":"34b494fb-69b9-4f26-b5db-7ddea110f591","name":"Find All Tenants That User Has Access To","originalRequest":{"method":"GET","header":[{"key":"AuthenticationKey","value":"{{AuthenticationToken}}","disabled":false}],"url":{"raw":"{{BaseURL}}/api/:tenantId/user/:emailAddress/tenants","host":["{{BaseURL}}"],"path":["api",":tenantId","user",":emailAddress","tenants"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"emailAddress","value":"janedoe@example.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 22:05:02 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"devfundingapi.azurewebsites.net","path":"/","secure":false,"value":"66a1bfe162ac16ed53bae398c7e8a736f694ec7e0cbfdbabdcea80720809d04c","key":"ARRAffinity"}],"responseTime":null,"body":"[\n \"Tenant 1\",\n \"Tenant 2\",\n \"Tenant 3\"\n]"}],"_postman_id":"58fcc40c-33c9-4375-8b95-cc1e520ba49f"},{"name":"View Specfic User","id":"7b72446a-756e-4337-bb7b-900921cd8aa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/user/:identifier","description":"Use this to view details of specific user based off an identifier, such as an email address.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantId","user",":identifier"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"dc06f6e6-fe91-4541-999d-0c614b7bd46b","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"cc095907-2cbe-4e99-84b2-2089dc7df27d","description":{"content":"String, required. The unique identifier of the user, such as name or email address
\n","type":"text/plain"},"type":"string","value":"","key":"identifier"}]}},"response":[{"id":"5fef940b-8ca6-4164-a621-3091759543b2","name":"Get Specfic User","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/user/:identifier","host":["{{BaseURL}}"],"path":["api",":tenantId","user",":identifier"],"variable":[{"key":"tenantId","value":"Tenant1"},{"key":"identifier","value":"janedoe@example.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{ \r\n \"id\": 1,\r\n \"userRole\": 1,\r\n \"name\": \"Jane Doe\",\r\n \"emailAddress\": \"janedoe@example.com\",\r\n \"createdDate\": \"2018-01-01T23:32:09.473Z\",\r\n \"createdBy\": \"systemadmin@example.com\",\r\n \"modifiedBy\": \"systemadmin@example.com\",\r\n \"modifiedDate\": \"2018-05-01T23:32:09.473Z\",\r\n \"lastLoginDate\": \"2018-05-01T23:32:09.473Z\",\r\n \"status\": 0\r\n}"}],"_postman_id":"7b72446a-756e-4337-bb7b-900921cd8aa2"}],"id":"297ccb18-69d2-42eb-8022-a1618449c29a","description":"These methods pull back information for single or multiple users.
\n","event":[{"listen":"prerequest","script":{"id":"cf7e4780-4c83-4fe9-af92-d9fbf86b5802","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2843c9f5-abff-481f-919e-7e54905c1a6f","type":"text/javascript","exec":[""]}}],"_postman_id":"297ccb18-69d2-42eb-8022-a1618449c29a"}],"id":"c6388303-f1d5-4b7e-bfb9-489f642a0ac0","description":"Seven types of user roles are supported in the BackOffice application:
\nThe authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n","type":"text"}],"url":"{{BaseURL}}/api/:tenantId/webhooks","description":"Use this method to get back all webhooks in your tenant.
\n","urlObject":{"path":["api",":tenantId","webhooks"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"5d2ef54b-477b-4cfb-aa7b-8fbe554733c5","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[],"_postman_id":"36561e36-ed1b-4363-9aca-91b4dced09fa"},{"name":"View a Single Webhook","id":"af8c674f-ef4c-4c96-a2bc-1a37ce9825ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","type":"text","value":""},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n","type":"text"}],"url":"{{BaseURL}}/api/:tenantId/webhooks/:subscriptionId","description":"Use this method to return information on a specific webhook.
\n","urlObject":{"path":["api",":tenantId","webhooks",":subscriptionId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"d3d2c235-cdd6-41be-969e-fca6f40683f1","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"52b5c843-406f-46b1-ac99-7fd396e8b739","description":{"content":"String, required. The unique id of the webhook subscription
\n","type":"text/plain"},"type":"string","value":"","key":"subscriptionId"}]}},"response":[],"_postman_id":"af8c674f-ef4c-4c96-a2bc-1a37ce9825ef"},{"name":"Update a Webhook","id":"7c18cade-2c70-4b0f-90a3-502f9e0130cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"description":"The authentication key
\n","key":"x-AuthenticationKeyId","type":"text","value":""},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"TransactionsImported\",\r\n \"destinationURL\": \"string\",\r\n \"authenticationMethod\": {\r\n \"method\": \"None\",\r\n \"username\": \"string\",\r\n \"password\": \"string\",\r\n \"sharedSecret\": \"string\"\r\n }\r\n}"},"url":"{{BaseURL}}/api/:tenantId/webhooks/:subscriptionId","description":"Use this method to return information on a specific webhook.
\n","urlObject":{"path":["api",":tenantId","webhooks",":subscriptionId"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"b7870f19-f052-4bdc-bffb-97d7f967bf02","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"44118a26-6d68-409e-9bb1-a2cdb3230c86","description":{"content":"String, required. The unique id of the webhook subscription
\n","type":"text/plain"},"type":"string","value":"","key":"subscriptionId"}]}},"response":[{"id":"9e116dac-4bbf-4e2a-9fd1-0704b5722b22","name":"Update a Webhook","originalRequest":{"method":"PUT","header":[{"key":"AuthenticationKey","type":"text","value":"{{AuthenticationToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"TransactionsImported\",\r\n \"destinationURL\": \"string\",\r\n \"authenticationMethod\": {\r\n \"method\": \"None\",\r\n \"username\": \"string\",\r\n \"password\": \"string\",\r\n \"sharedSecret\": \"string\"\r\n }\r\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantId/webhooks/:subscriptionId","host":["{{BaseURL}}"],"path":["api",":tenantId","webhooks",":subscriptionId"],"variable":[{"description":"The unique id of the tenant","key":"tenantId","value":"String, required"},{"description":"The unique id of the webhook subscription","key":"subscriptionId","value":"String, required"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2019-01-18T18:34:48.134Z\",\r\n \"endTime\": \"2019-01-18T18:34:48.134Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"7c18cade-2c70-4b0f-90a3-502f9e0130cf"},{"name":"Create a Webhook","id":"d8c8ffb1-b67d-4f58-a6aa-604327424ac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n","type":"text"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"TransactionsImported\",\r\n \"destinationURL\": \"string\",\r\n \"authenticationMethod\": {\r\n \"method\": \"None\",\r\n \"username\": \"string\",\r\n \"password\": \"string\",\r\n \"sharedSecret\": \"string\"\r\n }\r\n}"},"url":"{{BaseURL}}/api/:tenantid/webhooks","description":"Use this method to create a webhook.
\nResponse Schema
\n","urlObject":{"path":["api",":tenantid","webhooks"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"3f6b4c9b-5d4a-4c9c-b1aa-0b1b0a95c8cc","description":{"content":"String, required. The unique id of the tenant
\n","type":"text/plain"},"type":"string","value":"","key":"tenantid"}]}},"response":[{"id":"a142c44b-2bd9-4036-94ea-76cbae86f414","name":"Create a Webhook","originalRequest":{"method":"GET","header":[{"key":"AuthenticationKey","value":"{{AuthenticationToken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"Type\": 1,\n\t\"DestinationURL\": \"https://webhooks.com\",\n\t\"AuthenticationMethod\":{\n\t\t\"Method\": 1,\n\t\t\"SharedSecret\" : \"abc123\"\n\t}\n}"},"url":{"raw":"{{BaseURL}}/api/:tenantid/webhooks","host":["{{BaseURL}}"],"path":["api",":tenantid","webhooks"],"variable":[{"key":"tenantid","value":"String, required","description":"The unique id of the tenant"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": \"Processing\",\r\n \"createTime\": \"2019-01-18T18:30:58.028Z\",\r\n \"endTime\": \"2019-01-18T18:30:58.028Z\",\r\n \"error\": \"string\",\r\n \"message\": \"string\"\r\n}"}],"_postman_id":"d8c8ffb1-b67d-4f58-a6aa-604327424ac6"}],"id":"3fca6b5b-b203-4c31-bfa5-454c5d2de0c5","description":"You can add, view, and update webhooks using the API.
\n","event":[{"listen":"prerequest","script":{"id":"d2362582-20f6-4210-b62c-34450212e0a1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"94c3ef80-093f-48a8-9712-fc227478b593","type":"text/javascript","exec":[""]}}],"_postman_id":"3fca6b5b-b203-4c31-bfa5-454c5d2de0c5"},{"name":"Command Fingerprint","item":[{"name":"Command Fingerpint","id":"68796a03-6adf-4808-8cc3-007c486cbdeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-AuthenticationKeyId","value":"","description":"The authentication key
\n"},{"key":"x-AuthenticationKeyValue","value":"","description":"The authentication key secret
\n"}],"url":"{{BaseURL}}/api/:tenantId/commands/:commandFingerprint","urlObject":{"path":["api",":tenantId","commands",":commandFingerprint"],"host":["{{BaseURL}}"],"query":[],"variable":[{"id":"42295fe5-b2b0-4c8f-82ea-3b301ff1bafb","description":{"content":"String, required. The tenant's unique id
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"},{"id":"4a092663-8f87-4aff-98a9-8fea45a19cd1","description":{"content":"String, required. The command fingerprint
\n","type":"text/plain"},"type":"string","value":"","key":"commandFingerprint"}]}},"response":[{"id":"d4332448-d6d0-4102-bf7d-dca9d3a9c9c9","name":"Command","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api/:tenantId/commands/:commandFingerprint","host":["{{BaseURL}}"],"path":["api",":tenantId","commands",":commandFingerprint"],"variable":[{"key":"tenantId","value":"Tenant1","description":"The unique id of the tenant"},{"key":"commandFingerprint","value":"XXX","description":"The command fingerprint"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"commandFingerprint\": \"string\",\r\n \"status\": 0\r\n}"}],"_postman_id":"68796a03-6adf-4808-8cc3-007c486cbdeb"}],"id":"ad2b420c-f00a-44cd-8007-633f5acfc067","description":"Once a GET or POST request is executed, it's published asyncronously. To see the result of the execution, run this command with the commandfingerprint to see the results.
Response Schema
\n","event":[{"listen":"prerequest","script":{"id":"da8da63e-20c4-466d-bb24-34399f7ae782","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"977d4b38-8d58-46de-8787-ef5c2ca5b853","type":"text/javascript","exec":[""]}}],"_postman_id":"ad2b420c-f00a-44cd-8007-633f5acfc067"}],"id":"cbf1f0a7-2c34-4711-8b5b-e9414a9b04c0","event":[{"listen":"prerequest","script":{"id":"652e6040-7aba-4230-b345-970241961843","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f05f64c6-4545-4a2c-a482-af01f2bdba2d","type":"text/javascript","exec":[""]}}],"_postman_id":"cbf1f0a7-2c34-4711-8b5b-e9414a9b04c0","description":""}],"event":[{"listen":"prerequest","script":{"id":"b4f07310-8db3-482e-81ef-c43932464a43","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3c228425-261b-49fa-b23d-dfe01c6878e0","type":"text/javascript","exec":[""]}}],"variable":[{"key":"{{BaseURL}}","value":"{{BaseURL}}"}]}