{"info":{"_postman_id":"dbf5f9a8-4252-42e9-819b-84e624902ef1","name":"Chargezoom Merchant API","description":"

Authentication and Usage Overview

Chargezoom provides a API secret key to each Merchant Account and it can be used to create the access token which will be required in all request(s) as a token key in form data.

Steps to create Secret Key:

1. Login to Chargezoom Merchant Dashboard.

2. Click on the Configuration > \"API\" link in the left navigation bar.

3. There is an option to create the API secret key using \"Add New\" button. When Add New button is clicked then it will ask for the Name and Domain. Please enter any valid name and the merchant subdomain url.

4. Use \"API Key Production\" secret as API secretKey in all the API(s).

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5978132","collectionId":"dbf5f9a8-4252-42e9-819b-84e624902ef1","publishedId":"UzQuPQmv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-08-24T17:51:13.000Z"},"item":[{"name":"Authentication","item":[{"name":"API Login","event":[{"listen":"prerequest","script":{"id":"0c60f76a-90b4-4804-b9f5-3d7850a5af34","exec":[""],"type":"text/javascript"}}],"id":"87fcb8d5-ba9b-4d6b-a685-3fabb65896c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/authentication/token/create","description":"

Generate access token.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

","urlObject":{"path":["authentication","token","create"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"bef8422f-d1b0-41e2-bdbe-54c0f57f6663","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","description":"**Required** || **String**"}],"body":{"mode":"formdata","formdata":[]},"url":"{{v2-url}}/authentication/token/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Mar 2022 09:20:25 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"321"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDcyNDk2MjUsImNoayI6NDc4MDkwNjA3LCJzdGFydCI6MTY0NzI0OTYyNSwiZXhwaXJlIjoxNjQ3MjU2ODI1LCJ1c2VybmFtZSI6Im5hcEBjenRlc3Rlci5jb20iLCJtaWQiOiIyIiwicm9sZSI6Im1lcmNoYW50In0.0nXYQMdR8G1nKUfGseWV8cbJOxsIKrLPNp_CXJ1LO8Q\",\n \"message\": \"Token generated successfully.\"\n}"},{"id":"b1d6ffc0-d89e-4feb-8ee6-c91d0ae2c3bc","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","description":"**Required** || **String**"}],"body":{"mode":"formdata","formdata":[]},"url":"{{v2-url}}/authentication/token/create"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Mar 2022 09:21:13 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"43"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 401,\n \"message\": \"Invalid secret key\"\n}"}],"_postman_id":"87fcb8d5-ba9b-4d6b-a685-3fabb65896c2"},{"name":"Refresh Token","id":"8114119e-3823-4687-bdb3-ad5a0e88f751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/authentication/token/refresh","description":"

Refresh existing access token. (Note: must be done within two hours of existing token's creation.)

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["authentication","token","refresh"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"20890301-c04e-46cf-8b9f-445338f07728","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","description":"**Required** || **String**"},{"key":"token","value":"{{v2-token}}","type":"text","description":"**Required** || **String**"}],"url":"{{v2-url}}/authentication/token/refresh"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Mar 2022 09:23:16 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"323"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDcyNDk3OTYsImNoayI6NjcyMjgzOTQ2LCJzdGFydCI6MTY0NzI0OTc5NiwiZXhwaXJlIjoxNjQ3MjU2OTk2LCJ1c2VybmFtZSI6Im5hcEBjenRlc3Rlci5jb20iLCJtaWQiOiIyIiwicm9sZSI6Im1lcmNoYW50In0.CBzeO33TmwG_Ajpq3gOWpfiRm7jpvXpH9SoWGBWJgys\",\n \"message\": \"Token regenerated successfully.\"\n}"},{"id":"773f8a3d-a3a0-45a1-a4ed-1a647012e35e","name":"Error","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","description":"**Required** || **String**"},{"key":"token","value":"{{v2-token}}","type":"text","description":"**Required** || **String**"}],"url":"{{v2-url}}/authentication/token/refresh"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Mar 2022 09:23:44 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"48"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"message\": \"Access token is invalid\"\n}"}],"_postman_id":"8114119e-3823-4687-bdb3-ad5a0e88f751"},{"name":"Get Login User Profile Data","id":"30a950a6-bd00-4043-ade7-a3997bf9cf0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/authentication/profile","description":"

Retrieve Merchant/User Login profile information.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["authentication","profile"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"31fb563d-2906-4abd-b437-215a492c8995","name":"Success","originalRequest":{"method":"GET","header":[{"description":"**Required** || **String**","key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text","description":"**Required** || **String**"}],"url":"{{v2-url}}/authentication/profile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Mar 2022 09:25:24 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"198"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"data\": {\n \"merchID\": \"2\",\n \"firstName\": \"NAP\",\n \"lastName\": \"Local\",\n \"merchantEmail\": \"nap@cztester.com\",\n \"companyName\": \"NAP Local\",\n \"resellerID\": \"1\",\n \"agentID\": \"0\"\n },\n \"message\": \"Merchant profile data\"\n}"},{"id":"6f424d39-1b06-427e-9a7b-b7409a5bbc99","name":"Error","originalRequest":{"method":"GET","header":[{"description":"**Required** || **String**","key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text","description":"**Required** || **String**"}],"url":"{{v2-url}}/authentication/profile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 07:12:09 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22df0277b4f7e80be3e74fea07611d4a44%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614323529%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Db7c992dc3945377915786827c2e65b0300ccf168; expires=Fri, 26-Feb-2021 09:12:09 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"46"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 403,\n \"message\": \"Token or Key Invalid.\"\n}"}],"_postman_id":"30a950a6-bd00-4043-ade7-a3997bf9cf0c"}],"id":"635a6432-4d4c-49fd-b65d-d41e55455a6b","_postman_id":"635a6432-4d4c-49fd-b65d-d41e55455a6b","description":""},{"name":"Payment Gateways","item":[{"name":"Get All Gateway Type List","id":"85957c3b-0faa-4429-9e1d-c4faf07ba379","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/gateway/type/list","description":"

Retrieves all supported Payment Gateways.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["gateway","type","list"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"61c126a7-7767-489b-87e7-1970ba648551","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"","type":"text","description":"**Required** || **String**"},{"key":"token","value":"","type":"text","description":"**Required** || **String**"}],"url":"{{v2-url}}/gateway/type/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway list\",\n \"data\": [\n {\n \"gatewayTypeID\": \"1\",\n \"gatewayName\": \"NMI\",\n \"gatewayUniqueId\": \"NMI_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"nmiUserName\",\n \"nmiPassword\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\",\n \"ACH\"\n ]\n },\n {\n \"gatewayTypeID\": \"2\",\n \"gatewayName\": \"Authorize.net\",\n \"gatewayUniqueId\": \"AUTHORIZE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"authorizeApiKey\",\n \"authorizeTransactionKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\",\n \"ACH\"\n ]\n },\n {\n \"gatewayTypeID\": \"3\",\n \"gatewayName\": \"PayTrace\",\n \"gatewayUniqueId\": \"PAYTRACE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"payTraceUserName\",\n \"payTracePassword\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\",\n \"ACH\"\n ]\n },\n {\n \"gatewayTypeID\": \"4\",\n \"gatewayName\": \"PayPal\",\n \"gatewayUniqueId\": \"PAYPAL_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"paypalApiUserName\",\n \"paypalApiPassword\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"5\",\n \"gatewayName\": \"Stripe\",\n \"gatewayUniqueId\": \"STRIPE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"stripePublishableKey\",\n \"stripeSecretApiKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"6\",\n \"gatewayName\": \"USAePay\",\n \"gatewayUniqueId\": \"USAEPAY_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"UsaePayTransactionKey\",\n \"UsaePayPin\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"7\",\n \"gatewayName\": \"Heartland\",\n \"gatewayUniqueId\": \"HEARTLAND_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"heartlandPublicKey\",\n \"heartlandSecretKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"8\",\n \"gatewayName\": \"CyberSource\",\n \"gatewayUniqueId\": \"CYBERSOURCE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"cyberMerchantId\",\n \"cyberAPIKeyID\",\n \"cyberSecretKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"9\",\n \"gatewayName\": \"Chargezoom\",\n \"gatewayUniqueId\": \"CHARGEZOOM_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"chargezoomUserName\",\n \"chargezoomPassword\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"10\",\n \"gatewayName\": \"iTransact\",\n \"gatewayUniqueId\": \"ITRANSACT_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"itransactUserName\",\n \"itransactApiKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"11\",\n \"gatewayName\": \"FluidPay\",\n \"gatewayUniqueId\": \"FLUIDPAY_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"fluidPayApiKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"12\",\n \"gatewayName\": \"TSYS\",\n \"gatewayUniqueId\": \"TSYS_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"tsysApiUserId\",\n \"tsysApiPassword\",\n \"tsysGatewayMerchantId\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"13\",\n \"gatewayName\": \"BASYS iQ Pro\",\n \"gatewayUniqueId\": \"BASYS_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"basysApiKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"14\",\n \"gatewayName\": \"CardPointe\",\n \"gatewayUniqueId\": \"CARDPOINTE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"basysApiKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"15\",\n \"gatewayName\": \"PayArc Payment\",\n \"gatewayUniqueId\": \"PAYARC_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"payarcSecretKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"16\",\n \"gatewayName\": \"EPX\",\n \"gatewayUniqueId\": \"EPX_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"payarcSecretKey\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"18\",\n \"gatewayName\": \"Intuit\",\n \"gatewayUniqueId\": \"INTUIT_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"intuitClientId\",\n \"intuitClientSecret\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"19\",\n \"gatewayName\": \"Tilled\",\n \"gatewayUniqueId\": \"TILLED_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"intuitClientId\",\n \"intuitClientSecret\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n },\n {\n \"gatewayTypeID\": \"20\",\n \"gatewayName\": \"Square Payment\",\n \"gatewayUniqueId\": \"SQUARE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"intuitClientId\",\n \"intuitClientSecret\"\n ],\n \"supportedPaymentMethods\": [\n \"Credit Card\"\n ]\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"85957c3b-0faa-4429-9e1d-c4faf07ba379"},{"name":"Get All Merchant Gateway Data","id":"49935827-39a7-4060-a9b8-758ee14e8592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/gateway/all","description":"

Retrieves a list of Payment Gateways added.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["gateway","all"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"bbb8da0a-3308-43db-9d5c-7a57fba5e755","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"","description":"**Required** || **String**"},{"key":"token","value":"","type":"text"}],"url":"{{v2-url}}/gateway/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:03:53 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%229e8f570cd0a2d83a71643d9c8ae17cdb%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614603833%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dae884bc1f04f2b203bda5d216106bc78336cf429; expires=Mon, 01-Mar-2021 15:03:53 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"4276"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway list\",\n \"data\": [\n {\n \"gatewayID\": \"155\",\n \"gatewayFriendlyName\": \"NMI\",\n \"gatewayUsername\": \"demo\",\n \"gatewayPassword\": \"password\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"1\",\n \"gatewayMerchantID\": \"NMI-101\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"270\",\n \"gatewayFriendlyName\": \"Auth\",\n \"gatewayUsername\": \"9mCupr2vP86\",\n \"gatewayPassword\": \"6Nx749d7X8mHVbuT\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"2\",\n \"gatewayMerchantID\": \"AUTH-101\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"295\",\n \"gatewayFriendlyName\": \"Heartland\",\n \"gatewayUsername\": \"pkapi_cert_5Q0PznE0W5WPiIMbGd\",\n \"gatewayPassword\": \"skapi_cert_MdYrAgAeomEAM07AAe7vnrMnbePwCFgAcse3_zt85A\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": null,\n \"gatewayType\": \"7\",\n \"gatewayMerchantID\": \"Heart -101\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"296\",\n \"gatewayFriendlyName\": \"Stripe\",\n \"gatewayUsername\": \"pk_test_UrXwlvLTKk3bTaqcxDcVjcHp00Gb4NaeQv\",\n \"gatewayPassword\": \"sk_test_calONasRDNejxhn3s7juHpyw00PxpANJet\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": null,\n \"gatewayType\": \"5\",\n \"gatewayMerchantID\": \"STRIPE-101\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n },\n {\n \"gatewayID\": \"297\",\n \"gatewayFriendlyName\": \"PayTrace\",\n \"gatewayUsername\": \"mohit.dexbytes@gmail.com\",\n \"gatewayPassword\": \"Pay@1234\",\n \"gatewaySignature\": \"992d5deChZom\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"3\",\n \"gatewayMerchantID\": \"PAYTRACE-101\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"298\",\n \"gatewayFriendlyName\": \"Paypal\",\n \"gatewayUsername\": \"confluentid_api1.gmail.com\",\n \"gatewayPassword\": \"LZDPAYMAKYQCWTZV\",\n \"gatewaySignature\": \"AFcWxV21C7fd0v3bYYYRCpSSRl31ArjQshwrQKbH.rdy27-eUdLj3k.c\",\n \"extra_field_1\": null,\n \"gatewayType\": \"4\",\n \"gatewayMerchantID\": \"PAYPAL-101\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"299\",\n \"gatewayFriendlyName\": \"Cyber Gateway\",\n \"gatewayUsername\": \"chargezoom\",\n \"gatewayPassword\": \"f36495ee-7209-435d-a5d6-7c4e8f21038f\",\n \"gatewaySignature\": \"pWBDi4MPQLgVx1rS7ynI6EVxQiZjhQwtgkYDIQ6zoi4=\",\n \"extra_field_1\": null,\n \"gatewayType\": \"8\",\n \"gatewayMerchantID\": \"MCyber ID\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"320\",\n \"gatewayFriendlyName\": \"czu\",\n \"gatewayUsername\": \"chargezoomdemo\",\n \"gatewayPassword\": \"Alpha*123NMI\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": null,\n \"gatewayType\": \"9\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"335\",\n \"gatewayFriendlyName\": \"NEW USA\",\n \"gatewayUsername\": \"_fUz898UBxsm7SxwmAwOI7u861JHXAdm\",\n \"gatewayPassword\": \"123456\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": null,\n \"gatewayType\": \"6\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n },\n {\n \"gatewayID\": \"337\",\n \"gatewayFriendlyName\": \"Paytrace New MKG\",\n \"gatewayUsername\": \"mohit.dexbytes@gmail.com\",\n \"gatewayPassword\": \"Pay@1234\",\n \"gatewaySignature\": \"992d5deChZom\",\n \"extra_field_1\": null,\n \"gatewayType\": \"3\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"344\",\n \"gatewayFriendlyName\": \"iTransact\",\n \"gatewayUsername\": \"chargezoom_sandbox_acct_falywa\",\n \"gatewayPassword\": \"laltyspiquazothy\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": null,\n \"gatewayType\": \"10\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"357\",\n \"gatewayFriendlyName\": \"FluidPay\",\n \"gatewayUsername\": \"api_1iqSDFx00HvRqDumzF6lY3FcWRC\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": null,\n \"gatewayType\": \"11\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"424\",\n \"gatewayFriendlyName\": \"TSYS\",\n \"gatewayUsername\": \"TA5608128\",\n \"gatewayPassword\": \"Payments123*\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"12\",\n \"gatewayMerchantID\": \"887000003195\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n },\n {\n \"gatewayID\": \"446\",\n \"gatewayFriendlyName\": \"Paytrace Live Devt Team\",\n \"gatewayUsername\": \"devteam@chargezoom.com\",\n \"gatewayPassword\": \"Eck0-=PT!\",\n \"gatewaySignature\": \"992d5deChZom\",\n \"extra_field_1\": null,\n \"gatewayType\": \"3\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"488\",\n \"gatewayFriendlyName\": \"Mike Paytrace\",\n \"gatewayUsername\": \"devteampro@cztester.com\",\n \"gatewayPassword\": \"Eck0-=cz*\",\n \"gatewaySignature\": \"992d5deChZom\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"3\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n },\n {\n \"gatewayID\": \"497\",\n \"gatewayFriendlyName\": \"Basys\",\n \"gatewayUsername\": \"api_1iqSDFx00HvRqDumzF6lY3FcWRC\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"13\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"503\",\n \"gatewayFriendlyName\": \"EPX\",\n \"gatewayUsername\": \"9001\",\n \"gatewayPassword\": \"900611\",\n \"gatewaySignature\": \"1\",\n \"extra_field_1\": \"5\",\n \"gatewayType\": \"16\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n {\n \"gatewayID\": \"506\",\n \"gatewayFriendlyName\": \"NMI API\",\n \"gatewayUsername\": \"demo\",\n \"gatewayPassword\": \"password\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": null,\n \"gatewayType\": \"1\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"1\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"49935827-39a7-4060-a9b8-758ee14e8592"},{"name":"Get Single Gateway Data","id":"ec49bfaf-9e4d-454d-8365-d8b926313cf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/gateway/","description":"

Retrieves Merchant Gateway details by the Merchant Gateway ID

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["gateway",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"28e8a2f9-c90c-419e-83d9-a8efc061e6f3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/gateway/{{v2-gatewayId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 12:20:18 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"255"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Gateway list\",\n \"data\": {\n \"gatewayID\": \"155\",\n \"gatewayFriendlyName\": \"NMI\",\n \"gatewayUsername\": \"demo\",\n \"gatewayPassword\": \"password\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"1\",\n \"gatewayMerchantID\": \"NMI-101\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n },\n \"code\": 200\n}"}],"_postman_id":"ec49bfaf-9e4d-454d-8365-d8b926313cf3"},{"name":"Add Merchant Gateway","id":"53c1abf0-c1d9-4489-8078-aff08582ee70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{v2-url}}/gateway/create","description":"

Add a new gateway.

Each gateway accepts different request parameters. Request Parameters can be found below.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

NMI Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
nmiUserName	NMI_USER_NAME	Yes	String	-	-
nmiPassword	NMI_USER_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

Authorize Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
authorizeApiKey	AUTHORIZE_API_KEY	Yes	String	-	-
authorizeTransactionKey	AUTHORIZE_TRANSACTION_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

Paytrace Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
payTraceUserName	PAYTRACE_USER_NAME	Yes	String	-	-
payTracePassword	PAYTRACE_USER_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

Paypal Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
paypalApiUserName	PAYTRACE_USER_NAME	Yes	String	-	-
paypalApiPassword	PAYPAL_USER_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

Stripe Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
stripePublishableKey	STRIPE_PUBLISHABLE_KEY	Yes	String	-	-
stripeSecretApiKey	STRIPE_SECRET_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

USAePay Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
UsaePayTransactionKey	USAEPAY_TRANSACTION_KEY	Yes	String	-	-
UsaePayPin	USAEPAY_PIN	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

Heartland Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
heartlandPublicKey	HEARTLAND_PUBLIC_KEY	Yes	String	-	-
heartlandSecretKey	HEARTLAND_SECRET_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

CyberSource Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
cyberMerchantId	CYBERSOURCE_MERCHANT_ID	Yes	String	-	-
cyberAPIKeyID	CYBERSOURCE_API_KEY_ID	Yes	String	-	-
cyberSecretKey	CYBERSOURCE_SECRET_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

Chargezoom Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
chargezoomUserName	CHARGEZOOM_USER_NAME	Yes	String	-	-
chargezoomPassword	CHARGEZOOM_USER_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

iTRANSACT Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
itransactUserName	ITRANSACT_USER_NAME	Yes	String	-	-
itransactApiKey	ITRANSACT_API_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

FluidPay Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
fluidPayApiKey	FLUIDPAY_API_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

TSYS Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
tsysApiUserId	TSYS_API_USER_ID	Yes	String	-	-
tsysApiPassword	TSYS_API_PASSWORD	Yes	String	-	-
tsysGatewayMerchantId	TSYS_GATEWAY_MERCHANT_ID	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

CardPointe Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
siteVariable	SITE_VARIABLE	Yes	String	-	-
cardpointeUsername	CP_USER_NAME	Yes	String	-	-
cardpointePassword	CP_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

PayArc Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
payarcSecretKey	PAYARC_SECRET_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

EPX Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
EPXCustNBR	EPX_CUST_NBR	Yes	String	-	-
EPXMerchNBR	EPX_MERCH_NBR	Yes	String	-	-
EPXDBANBR	EPX_DBA_NBR	Yes	String	-	-
EPXterminal	EPX_TERMINAL	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

Maverick Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Set Gateway as Default	No	String	N	[Y,N]
maverickAccessToken	MAVERICK_ACCESS_TOKEN	Yes	String	-	-
maverickTerminalId	MAVERICK_TERMINAL_ID	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

","urlObject":{"path":["gateway","create"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"ade498e2-bdd6-4988-af72-80ad7c7623ac","name":"Request - NMI_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"nmiUserName","value":"","type":"text","description":"**NMI User Name** || **String** || **Required for NMI**"},{"key":"nmiPassword","value":"","type":"text","description":"**NMI User Password** || **String** || **Required for NMI**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 06:26:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"308"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"1\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"1\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"5195a171-7586-4936-bfab-3a8fcb058636","name":"Request - AUTHORIZE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"authorizeApiKey","value":"","type":"text","description":"**Authorize API Key** || **String** || **Required for Authorize**"},{"key":"authorizeTransactionKey","value":"","type":"text","description":"**Authorize Transaction Key** || **String** || **Required for Authorize**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 09:37:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"301"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"2\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"2\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"30ee5ff2-0f73-422d-a999-dcc92686b9a7","name":"Request - PAYTRACE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"payTraceUserName","value":"","type":"text","description":"**Paytrace User Name** || **String** || **Required for Paytrace**"},{"key":"payTracePassword","value":"","type":"text","description":"**Paytrace Password** || **String** || **Required for Paytrace**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 09:46:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"305"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"3\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"3\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"31939014-e306-4105-b952-68e14645ee14","name":"Request - PAYPAL_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"paypalApiUserName","value":"","type":"text","description":"**Paypal Api UserName** || **String** || **Required for Paypal**"},{"key":"paypalApiPassword","value":"","type":"text","description":"**Paypal Api Password** || **String** || **Required for Paypal**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"N","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 09:51:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"305"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"4\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"4\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n }\n },\n \"code\": 200\n}"},{"id":"e0972dd7-5fc2-4687-98ff-8a15e4dd4e4f","name":"Request - STRIPE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"stripePublishableKey","value":"","type":"text","description":"**Stripe Publishable Key** || **String** || **Required for Stripe**"},{"key":"stripeSecretApiKey","value":"","type":"text","description":"**Stripe Secret Key** || **String** || **Required for Stripe**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"N","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 09:55:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"305"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"5\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"5\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n }\n },\n \"code\": 200\n}"},{"id":"73aefac6-0b31-4526-b229-66978611b38b","name":"Request - USAEPAY_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"UsaePayTransactionKey","value":"","type":"text","description":"**Usaepay Transaction Key** || **String** || **Required for Usaepay**"},{"key":"UsaePayPin","value":"","type":"text","description":"**Usaepay Pin** || **String** || **Required for Usaepay**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"N","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 10:16:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"304"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"6\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"6\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n }\n },\n \"code\": 200\n}"},{"id":"7125c7df-283b-421b-b3d9-f4b5b74ddfe8","name":"Request - HEARTLAND_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"heartlandPublicKey","value":"","type":"text","description":"**Heartland Public Key** || **String** || **Required for Heartland**"},{"key":"heartlandSecretKey","value":"","type":"text","description":"**Heartland Secret Key** || **String** || **Required for Heartland**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 10:21:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"304"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"7\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"7\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n }\n },\n \"code\": 200\n}"},{"id":"b32cf730-89ce-4a6c-96a7-7b3dc1faafb8","name":"Request - CYBERSOURCE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"cyberMerchantId","value":"","description":"**CyberSource Public Key** || **String** || **Required for CyberSource**","type":"text"},{"key":"cyberAPIKeyID","value":"","type":"text","description":"**CyberSource API Key ID** || **String** || **Required for CyberSource**"},{"key":"cyberSecretKey","value":"","type":"text","description":"**CyberSource Secret Key** || **String** || **Required for CyberSource**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"N","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 10:26:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"306"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"8\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"8\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n }\n },\n \"code\": 200\n}"},{"id":"079f55cb-0759-47c2-a391-fb88a3522b9a","name":"Request - CHARGEZOOM_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"chargezoomUserName","value":"","description":"**Chargezoom User Name** || **String** || **Required for Chargezoom**","type":"text"},{"key":"chargezoomPassword","value":"","type":"text","description":"**Chargezoom User Password** || **String** || **Required for Chargezoom**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 10:44:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"304"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"9\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"9\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"b01378de-05f2-4803-8092-5cd139874350","name":"Request - ITRANSACT_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"itransactUserName","value":"","description":"**iTransact User Name** || **String** || **Required for iTransact**","type":"text"},{"key":"itransactApiKey","value":"","type":"text","description":"**iTransact API Key** || **String** || **Required for iTransact**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 10:52:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"305"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"10\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"10\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"cb7eca5f-60d7-4b1e-9cd4-0e40e4e4e7e2","name":"Request - FLUIDPAY_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"fluidPayApiKey","value":"","description":"**FluidPay API Key** || **String** || **Required for FluidPay**","type":"text"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 10:55:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"297"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"11\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"11\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"d29aa0cc-0cfc-4396-b18b-6528daf74ece","name":"Request - TSYS_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"tsysApiUserId","value":"","description":"**TSYS API User ID** || **String** || **Required for TSYS**","type":"text"},{"key":"tsysApiPassword","value":"","description":"**TSYS API Password** || **String** || **Required for TSYS**","type":"text"},{"key":"tsysGatewayMerchantId","value":"","description":"**TSYS Gateway Merchant ID** || **String** || **Required for TSYS**","type":"text"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 11:01:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"307"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"12\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"12\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"8e488748-d0d3-4548-9837-f5037bc02d62","name":"Request - BASYS_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"basysApiKey","value":"","description":"**BASYS iQ Pro API Key** || **String** || **Required for BASYS iQ Pro**","type":"text"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 11:06:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"297"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"13\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"13\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"febb9466-65f3-453b-8a09-e5fae173deae","name":"Request - CARDPOINTE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"siteVariable","value":"","type":"text","description":"**Cardpointe Site Variable** || **String** || **Required for Cardpointe**"},{"key":"cardpointeUsername","value":"","description":"**Cardpointe Username** || **String** || **Required for Cardpointe**","type":"text"},{"key":"cardpointePassword","value":"","description":"**Cardpointe Password** || **String** || **Required for Cardpointe**","type":"text"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 11:13:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"310"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"14\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"14\",\n \"gatewayMerchantID\": null,\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"57e3d70b-1522-422f-adfb-dc5234c690f5","name":"Request - PAYARC_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"payarcSecretKey","value":"","type":"text","description":"**PayArc Secret Key** || **String** || **Required for PayArc**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 11:17:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"296"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"15\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"15\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"0\"\n }\n },\n \"code\": 200\n}"},{"id":"ee2a1749-278e-4ddf-8024-32c3a6034cc0","name":"Request - EPX_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"EPXCustNBR","value":"","type":"text","description":"**EPX Cust NBR** || **String** || **Required for EPX**"},{"key":"EPXMerchNBR","value":"","type":"text","description":"**EPX Merch NBR** || **String** || **Required for EPX**"},{"key":"EPXDBANBR","value":"","type":"text","description":"**EPX DBA NBR** || **String** || **Required for EPX**"},{"key":"EPXterminal","value":"","type":"text","description":"**EPX Terminal** || **String** || **Required for EPX**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 11:22:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"297"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"16\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"16\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"},{"id":"94be22d1-3ece-40d5-923f-1057f4d97538","name":"Request - MAVERICK_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","type":"text","description":"**Gateway Unique ID** || **String** || **Required**"},{"key":"friendlyName","value":"","type":"text","description":"**Gateway Friendly Name** || **String** || **Required**"},{"key":"maverickAccessToken","value":"","type":"text","description":"**Maverick Access Token** || **String** || **Required for Maverick**"},{"key":"maverickTerminalId","value":"","type":"text","description":"**Maverick Terminal Id** || **String** || **Required for Maverick**"},{"key":"setAsDefault","value":"N","type":"text","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**"},{"key":"isCC","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"},{"key":"isACH","value":"Y","type":"text","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**"}]},"url":"{{v2-url}}/gateway/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 11:25:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"301"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully\",\n \"data\": {\n \"gatewayId\": {\n \"gatewayID\": \"17\",\n \"gatewayFriendlyName\": \"\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"extra_field_1\": \"\",\n \"gatewayType\": \"17\",\n \"gatewayMerchantID\": \"\",\n \"defaultGateway\": \"0\",\n \"isCC\": \"1\",\n \"isACH\": \"1\"\n }\n },\n \"code\": 200\n}"}],"_postman_id":"53c1abf0-c1d9-4489-8078-aff08582ee70"},{"name":"Edit Merchant Gateway","id":"79685ce8-3f3e-4853-a7e7-fc16e048efee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/gateway/edit","description":"

Modify a merchant gateway. Each gateway requires a unique dataset sent in the request. Refer to below for an example of each dataset.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

NMI Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
nmiUserName	NMI_USER_NAME	Yes	String	-	-
nmiPassword	NMI_USER_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

Authorize Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
authorizeApiKey	AUTHORIZE_API_KEY	Yes	String	-	-
authorizeTransactionKey	AUTHORIZE_TRANSACTION_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

Paytrace Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
payTraceUserName	PAYTRACE_USER_NAME	Yes	String	-	-
payTracePassword	PAYTRACE_USER_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

Paypal Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
paypalApiUserName	PAYTRACE_USER_NAME	Yes	String	-	-
paypalApiPassword	PAYPAL_USER_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

Stripe Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
stripePublishableKey	STRIPE_PUBLISHABLE_KEY	Yes	String	-	-
stripeSecretApiKey	STRIPE_SECRET_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

USAePay Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
UsaePayTransactionKey	USAEPAY_TRANSACTION_KEY	Yes	String	-	-
UsaePayPin	USAEPAY_PIN	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

Heartland Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId**	Gateway ID	Yes	String	-	-
friendlyName**	Friendly Name	Yes	String	-	-
setAsDefault**	Friendly Name	No	String	N	[Y,N]
heartlandPublicKey**	HEARTLAND_PUBLIC_KEY	Yes	String	-	-
heartlandSecretKey**	HEARTLAND_SECRET_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

CyberSource Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
cyberMerchantId	CYBERSOURCE_MERCHANT_ID	Yes	String	-	-
cyberAPIKeyID	CYBERSOURCE_API_KEY_ID	Yes	String	-	-
cyberSecretKey	CYBERSOURCE_SECRET_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

Chargezoom Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId**	Gateway ID	Yes	String	-	-
friendlyName**	Friendly Name	Yes	String	-	-
setAsDefault**	Friendly Name	No	String	N	[Y,N]
chargezoomUserName	CHARGEZOOM_USER_NAME	Yes	String	-	-
chargezoomPassword	CHARGEZOOM_USER_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

iTRANSACT Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
itransactUserName	ITRANSACT_USER_NAME	Yes	String	-	-
itransactApiKey	ITRANSACT_API_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

FluidPay Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
fluidPayApiKey	FLUIDPAY_API_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

TSYS Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
tsysApiUserId	TSYS_API_USER_ID	Yes	String	-	-
tsysApiPassword	TSYS_API_PASSWORD	Yes	String	-	-
tsysGatewayMerchantId	TSYS_GATEWAY_MERCHANT_ID	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

CardPointe Gateway Request Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
siteVariable	SITE_VARIABLE	Yes	String	-	-
cardpointeUsername	CP_USER_NAME	Yes	String	-	-
cardpointePassword	CP_PASSWORD	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

PayArc Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
payarcSecretKey	PAYARC_SECRET_KEY	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[N]

EPX Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
EPXCustNBR	EPX_CUST_NBR	Yes	String	-	-
EPXMerchNBR	EPX_MERCH_NBR	Yes	String	-	-
EPXDBANBR	EPX_DBA_NBR	Yes	String	-	-
EPXterminal	EPX_TERMINAL	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

Maverick Gateway Request Params

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
gatewayIdentifier	GATEWAY_UNIQUE_ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
friendlyName	Friendly Name	Yes	String	-	-
setAsDefault	Friendly Name	No	String	N	[Y,N]
maverickAccessToken	MAVERICK_ACCESS_TOKEN	Yes	String	-	-
maverickTerminalId	MAVERICK_TERMINAL_ID	Yes	String	-	-
isCC	Is Credit Card Accepted	Yes	String	Y	[Y,N]
isACH	Is ACH Accepted	Yes	String	N	[Y,N]

","urlObject":{"path":["gateway","edit"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"e5eedb6c-2156-44fc-9730-1b08c1784ec5","name":"Request - NMI_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"nmiUserName","value":"","description":"**NMI User Name** || **String** || **Required for NMI**","type":"text"},{"key":"nmiPassword","value":"","description":"**NMI User Password** || **String** || **Required for NMI**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"1\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"1\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"1d3220e4-9ef1-4711-a8ae-140f8798fab4","name":"Request - AUTHORIZE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"authorizeApiKey","value":"","description":"**Authorize API Key** || **String** || **Required for Authorize**","type":"text"},{"key":"authorizeTransactionKey","value":"","description":"**Authorize Transaction Key** || **String** || **Required for Authorize**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"2\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"2\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"ecc95cad-2925-4cff-b5b9-3460e1b815cf","name":"Request - PAYTRACE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"payTraceUserName","value":"","description":"**Paytrace User Name** || **String** || **Required for Paytrace**","type":"text"},{"key":"payTracePassword","value":"","description":"**Paytrace User Password** || **String** || **Required for Paytrace**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"3\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"3\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"b7e8b5e6-46bf-4609-b837-33895657c3a7","name":"Request - PAYPAL_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"paypalApiUserName","value":"","description":"**Paypal User Name** || **String** || **Required for Paypal**","type":"text"},{"key":"paypalApiPassword","value":"","description":"**Paypal User Password** || **String** || **Required for Paypal**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ N ]** || **Default [ N ] || **","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"4\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"4\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"0\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"6305a440-a30f-47e4-b2b2-610c5f72dd91","name":"Request - STRIPE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"stripePublishableKey","value":"","description":"**Stripe Publishable Key** || **String** || **Required for Stripe**","type":"text"},{"key":"stripeSecretApiKey","value":"","description":"**Stripe Secret Api Key** || **String** || **Required for Stripe**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ N ]** || **Default [ N ] || **","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"5\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"5\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"0\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"c7a2a51d-de23-4a83-b0ca-d0e3e1bac278","name":"Request - USAEPAY_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"UsaePayTransactionKey","value":"","description":"**USAePay Transaction Key** || **String** || **Required for USAePay**","type":"text"},{"key":"UsaePayPin","value":"","description":"**USAePay Pin** || **String** || **Required for USAePay**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ N ]** || **Default [ N ] || **","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"6\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"6\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"0\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"61ea1466-7b53-4361-9462-78ff07c436f7","name":"Request - HEARTLAND_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"heartlandPublicKey","value":"","description":"**Heartland Public Key** || **String** || **Required for Heartland**","type":"text"},{"key":"heartlandSecretKey","value":"","description":"**Heartland Secret Key** || **String** || **Required for Heartland**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ] || **","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"7\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"7\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"0\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"b9050df2-392b-47df-a58e-fcfd30583426","name":"Request - CYBERSOURCE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"cyberMerchantId","value":"","description":"**CyberSource Public Key** || **String** || **Required for CyberSource**","type":"text"},{"key":"cyberAPIKeyID","value":"","description":"**CyberSource API Key ID** || **String** || **Required for CyberSource**","type":"text"},{"key":"cyberSecretKey","value":"","description":"**CyberSource Secret Key** || **String** || **Required for CyberSource**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ N ]** || **Default [ N ] || **","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"8\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"8\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"0\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"53db990d-08c5-425e-bc49-eebcbf4112b6","name":"Request - CHARGEZOOM_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"chargezoomUserName","value":"","description":"**Chargezoom User Name** || **String** || **Required for Chargezoom**","type":"text"},{"key":"chargezoomPassword","value":"","description":"**Chargezoom User Password** || **String** || **Required for Chargezoom**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"9\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"9\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"b631c4d0-de34-4122-a63d-e4e2cb13ec13","name":"Request - ITRANSACT_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"itransactUserName","value":"","description":"**iTransact User Name** || **String** || **Required for iTransact**","type":"text"},{"key":"itransactApiKey","value":"","description":"**iTransact API Key** || **String** || **Required for iTransact**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"10\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"10\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"806da59d-6a63-40f2-8af4-d84083be3dcd","name":"Request - FLUIDPAY_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"fluidPayApiKey","value":"","description":"**FluidPay API Key** || **String** || **Required for FluidPay**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"11\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"11\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"e0c5c7a3-2841-49f7-9f50-418c3c84805b","name":"Request - TSYS_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"tsysApiUserId","value":"","description":"**TSYS API User ID** || **String** || **Required for TSYS**","type":"text"},{"key":"tsysApiPassword","value":"","description":"**TSYS API Password** || **String** || **Required for TSYS**","type":"text"},{"key":"tsysGatewayMerchantId","value":"","description":"**TSYS Gateway Merchant ID** || **String** || **Required for TSYS**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"12\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"12\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"c8839d98-cea1-4bad-8c44-e8fd58881bc0","name":"Request - BASYS_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"basysApiKey","value":"","description":"**BASYS iQ Pro API Key** || **String** || **Required for BASYS iQ Pro**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"13\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"13\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"438fc633-3f01-4df4-a956-f6bd21baf4f8","name":"Request - CARDPOINTE_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"siteVariable","value":"","description":"**Cardpointe Site Variable** || **String** || **Required for Cardpointe**","type":"text"},{"key":"cardpointeUsername","value":"","description":"**Cardpointe Username** || **String** || **Required for Cardpointe**","type":"text"},{"key":"cardpointePassword","value":"","description":"**Cardpointe Password** || **String** || **Required for Cardpointe**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"14\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"14\",\r\n \"gatewayMerchantID\": null,\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"de1a9c19-9622-4869-b007-bcdceb6a3548","name":"Request - PAYARC_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"payarcSecretKey","value":"","description":"**PayArc Secret Key** || **String** || **Required for PayArc**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"N","description":"**Required** || **String** || **Aceepted Values [ N ]** || **Default [ N ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"15\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"15\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"0\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"13b1e064-d1a3-4716-bbde-3843bca25dd6","name":"Request - EPX_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"EPXCustNBR","value":"","description":"**EPX Cust NBR** || **String** || **Required for EPX**","type":"text"},{"key":"EPXMerchNBR","value":"","description":"**EPX Merch NBR** || **String** || **Required for EPX**","type":"text"},{"key":"EPXDBANBR","value":"","description":"**EPX DBA NBR** || **String** || **Required for EPX**","type":"text"},{"key":"EPXterminal","value":"","description":"**EPX Terminal** || **String** || **Required for EPX**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"N","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"16\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"16\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"},{"id":"f58ca91e-f60b-4955-8505-43568e9d870b","name":"Request - MAVERICK_GATEWAY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"gatewayIdentifier","value":"","description":"**Gateway Unique ID** || **String** || **Required**","type":"text"},{"key":"friendlyName","value":"","description":"**Gateway Friendly Name** || **String** || **Required**","type":"text"},{"key":"gatewayId","value":"","description":"**Gateway ID** || **Required** || **Integer**","type":"text"},{"key":"maverickAccessToken","value":"","description":"**Maverick Access Token** || **String** || **Required for Maverick**","type":"text"},{"key":"maverickTerminalId","value":"","description":"**Maverick Terminal Id** || **String** || **Required for Maverick**","type":"text"},{"key":"setAsDefault","value":"N","description":"**Optional** || **String** || **Aceepted Values [ Y, N ]**","type":"text"},{"key":"isCC","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"},{"key":"isACH","value":"Y","description":"**Required** || **String** || **Aceepted Values [ Y, N ]** || **Default [ Y ]**","type":"text"}]},"url":"{{v2-url}}/gateway/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Mar 2022 11:32:00 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2782"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Gateway updated successfully\",\r\n \"data\": {\r\n \"gatewayId\": {\r\n \"gatewayID\": \"17\",\r\n \"gatewayFriendlyName\": \"\",\r\n \"gatewayUsername\": \"\",\r\n \"gatewayPassword\": \"\",\r\n \"gatewaySignature\": \"\",\r\n \"extra_field_1\": \"\",\r\n \"gatewayType\": \"17\",\r\n \"gatewayMerchantID\": \"\",\r\n \"defaultGateway\": \"0\",\r\n \"isCC\": \"1\",\r\n \"isACH\": \"1\"\r\n }\r\n },\r\n \"code\": 200\r\n}"}],"_postman_id":"79685ce8-3f3e-4853-a7e7-fc16e048efee"}],"id":"c94c32bf-1da7-44e8-b2d3-bef9e8edda67","_postman_id":"c94c32bf-1da7-44e8-b2d3-bef9e8edda67","description":""},{"name":"General Settings","item":[{"name":"Create Payment Term","id":"0a704fab-4078-4ac5-bf00-0cdab9cc5e82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/settings/payment_term/create","description":"

Create a payment term.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
termName	Display name for term.	Yes	String	-	Unique
termDays	Number of days in the term.	Yes	Int	-	-
setAsDefault	Set Default	Yes	String	N	[Y,N]

","urlObject":{"path":["settings","payment_term","create"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"ec89f3c9-022b-4cfa-ac37-822c0ae42d78","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":""},{"key":"token","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"termName","value":"NET-12","description":"required","type":"text"},{"key":"termDays","value":"12","description":"required","type":"text"},{"key":"setAsDefault","value":"N","description":"Y or N (Default Y)","type":"text"}]},"url":"{{v2-url}}/settings/payment_term/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 10:50:09 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"133"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Payment Term Created Successfully\",\n \"data\": {\n \"termID\": 654,\n \"termName\": \"NET-12\",\n \"termDays\": \"12\",\n \"setAsDefault\": 0\n },\n \"code\": 200\n}"},{"id":"601af2f4-3f2c-49c4-a51b-abce984578c4","name":"Error - Payment Term already exists","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"termName","value":"NET-12","description":"required","type":"text"},{"key":"termDays","value":"12","description":"required","type":"text"},{"key":"setAsDefault","value":"N","description":"Y or N (Default Y)","type":"text"}]},"url":"{{v2-url}}/settings/payment_term/create"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 10:50:27 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"63"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": null,\n \"message\": \"Payment Term Already Exist\",\n \"code\": 422\n}"}],"_postman_id":"0a704fab-4078-4ac5-bf00-0cdab9cc5e82"},{"name":"Edit Payment Term","id":"bfc8cb1b-2d02-44f7-b7fd-53969a745504","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/settings/payment_term/edit","description":"

Edit a Payment Term.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
termID	Term ID	Yes	Int	-	-
termName	Change the term name	Yes	String	-	-
termDays	Change the term days	Yes	Int	-	-
setAsDefault	Set as default term	Yes	String	N	[Y,N]

","urlObject":{"path":["settings","payment_term","edit"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"586ab478-3739-4148-ba5c-d3b48ac5aa93","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":""},{"key":"token","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"termName","value":"TERM_NAME","description":"required","type":"text"},{"key":"termDays","value":"12","description":"required","type":"text"},{"key":"termId","value":"2109","description":"required","type":"text"}]},"url":"{{v2-url}}/settings/payment_term/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:31:27 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"142"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment Term Updated Successfully\",\n \"data\": {\n \"termID\": \"126\",\n \"termName\": \"Due on Receipt\",\n \"termDays\": \"0\",\n \"setAsDefault\": 0\n },\n \"code\": 200\n}"},{"id":"3ee62470-b55f-491d-b399-4b74d76f37fd","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":""},{"key":"token","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"termName","value":"Test11","type":"text"},{"key":"termDays","value":"30","type":"text"},{"key":"termId","value":"20471","type":"text"}]},"url":"{{v2-url}}/settings/payment_term/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:08:39 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%228e5b79712fc615030bdfd6660a2527ed%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604119%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Df021609e63021174f7bda73981c244b7a981880b; expires=Mon, 01-Mar-2021 15:08:39 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"61"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment Term Already Exist\",\n \"data\": \"\",\n \"code\": 403\n}"}],"_postman_id":"bfc8cb1b-2d02-44f7-b7fd-53969a745504"},{"name":"Get Payment Terms","id":"1ac7ee1d-0d81-4a61-bd77-f5ab625c2646","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/settings/payment_term/all","description":"

Retrieve all payment terms available for the merchant.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["settings","payment_term","all"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"77302431-b253-4098-b81b-db98d3a2ca4a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/settings/payment_term/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:21:46 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"421"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Payment Term Details\",\n \"data\": [\n {\n \"termID\": \"126\",\n \"termName\": \"Due on Receipt\",\n \"termDays\": \"0\",\n \"setAsDefault\": \"0\"\n },\n {\n \"termID\": \"127\",\n \"termName\": \"Net 10\",\n \"termDays\": \"10\",\n \"setAsDefault\": \"0\"\n },\n {\n \"termID\": \"128\",\n \"termName\": \"Net 15\",\n \"termDays\": \"15\",\n \"setAsDefault\": \"0\"\n },\n {\n \"termID\": \"129\",\n \"termName\": \"Net 30\",\n \"termDays\": \"30\",\n \"setAsDefault\": \"0\"\n },\n {\n \"termID\": \"654\",\n \"termName\": \"NET-12\",\n \"termDays\": \"12\",\n \"setAsDefault\": \"0\"\n }\n ],\n \"code\": 200\n}"},{"id":"0ce0e076-eea7-4bc4-b3c0-edc9293549f9","name":"Success - No Data","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/settings/payment_term/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:22:21 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"55"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Payment Term Details\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"1ac7ee1d-0d81-4a61-bd77-f5ab625c2646"},{"name":"Get Invoice Prefix","id":"d6cc93b1-c257-4426-a314-2ce655545713","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/settings/invoice_prefix","description":"

Retrieve the invoice prefix & postfix for the invoice reference number.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["settings","invoice_prefix"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"ce848bda-f147-4744-9a6b-dab67caa8108","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/settings/invoice_prefix"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:41:16 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"82"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Merchant Settings\",\n \"data\": {\n \"prefix\": \"CZU\",\n \"postfix\": \"107\"\n },\n \"code\": 200\n}"},{"id":"c6a9e18b-7c41-4699-b2d9-9ed8722b6a8d","name":"Success - No Data","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/settings/invoice_prefix"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:42:47 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"54"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Merchant Settings\",\n \"data\": null,\n \"code\": 200\n}"}],"_postman_id":"d6cc93b1-c257-4426-a314-2ce655545713"},{"name":"Set Invoice Prefix Number","id":"9784a754-c15a-4e7d-88b4-e1b4f70884ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/settings/invoice_prefix/edit","description":"

Create a prefix number to generate invoices.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
prefix	Invoice Reference Number - Prefix	Yes	String	-	-
postfix	Invoice Reference Number - Postfix	Yes	String	-	-

","urlObject":{"path":["settings","invoice_prefix","edit"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"60a9c7c9-4309-4420-ba7e-921934c31368","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"prefix","value":"CZU","description":"Required","type":"text"},{"key":"postfix","value":"108","description":"Required","type":"text"}]},"url":"{{v2-url}}/settings/invoice_prefix/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:54:20 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"82"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Merchant Settings\",\n \"data\": {\n \"prefix\": \"CZU\",\n \"postfix\": \"108\"\n },\n \"code\": 200\n}"}],"_postman_id":"9784a754-c15a-4e7d-88b4-e1b4f70884ca"},{"name":"Get Customer Portal","id":"de88ae75-e91a-44d9-9dc5-b80f348b64e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/settings/customer_portal","description":"

Retrieve the merchant customer portal settings.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["settings","customer_portal"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"38dcea46-0ccd-4910-8a41-8ab8901fbccc","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/settings/customer_portal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:41:16 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"82"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Merchant Settings\",\n \"data\": {\n \"prefix\": \"CZU\",\n \"postfix\": \"107\"\n },\n \"code\": 200\n}"},{"id":"297e3e9e-7fa6-4acc-b702-62cbe8747aae","name":"Success - No Data","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/settings/customer_portal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:42:47 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"54"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Merchant Settings\",\n \"data\": null,\n \"code\": 200\n}"}],"_postman_id":"de88ae75-e91a-44d9-9dc5-b80f348b64e4"},{"name":"Customer Portal Setup","id":"b2933f73-83b5-4615-a362-1fd02cb4eb57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/settings/customer_portal/setup","description":"

Update the merchant customer portal settings.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
enablePortal	Setting to Enable/Disable Customer Portal	Yes	String	0	[ 0,1 ]
portalUrlPrefix	Customer Portal URL Prefix	Yes	String	-	-
helpText	-	No	String	-	-
termServiceURL	-	No	String	-	-
allowEditContact	This allows customer to edit the details using customer portal. ( Set 1 to allow the customer to Edit Details. )	Yes	Int	0	[ 0,1 ]
showPaymentInfo	This allow customer to show and edit the payment details using customer portal. ( Set 1 to allow the customer to Show & Edit Details. )	Yes	Int	0	[ 0,1 ]
showSubscriptions	This will list customer's subscriptions on landing page. ( Set 1 to allow the customer to Show customer subscriptions. )	Yes	Int	0	[ 0,1 ]

","urlObject":{"path":["settings","customer_portal","setup"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"ec3842a1-5534-49a5-ba45-781ea72e9a4f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"enablePortal","value":"1","description":"1=>yes, 0=>No","type":"text"},{"key":"portalUrlPrefix","value":"dashboard","description":"1=>yes, 0=>No","type":"text"},{"key":"helpText","value":"","description":"1=>yes, 0=>No","type":"text"},{"key":"allowEditContact","value":"0","description":"Term & Service URL","type":"text"},{"key":"showPaymentInfo","value":"0","type":"text"},{"key":"showSubscriptions","value":"0","type":"text"},{"key":"termServiceURL","value":"https://merchantsite.com/terms.html","type":"text"}]},"url":"{{v2-url}}/settings/customer_portal/setup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:12:54 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2262f0461472815d54f70a9c23fb7f7d31%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604374%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Db0287830eddcde400de834b9d7714ea2f3469531; expires=Mon, 01-Mar-2021 15:12:54 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"71"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"enablePortal\": \"1\",\n \"portalUrlPrefix\": \"dashboard\",\n \"helpText\": \"\",\n \"allowEditContact\": \"0\",\n \"showPaymentInfo\": \"0\",\n \"showSubscriptions\": \"0\",\n \"termServiceURL\": \"https://merchantsite.com/terms.html\",\n \"portalURL\": \"https://demos.payportal.com/customer/\"\n },\n \"message\": \"Merchant Settings\",\n \"code\": 200\n}"}],"_postman_id":"b2933f73-83b5-4615-a362-1fd02cb4eb57"},{"name":"Tax List","id":"f3ce6082-c6f7-4c21-8483-f173cdbea5d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/settings/taxes","description":"

Retrieve list of available taxes for the merchant.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["settings","taxes"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"a6f17d5e-9780-4d1f-89b5-80f420c30f97","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/settings/taxes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 13:08:47 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"479"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Merchant Settings\",\n \"data\": [\n {\n \"taxID\": \"4\",\n \"friendlyName\": \"Arizona\",\n \"taxRate\": \"18\",\n \"taxStatus\": \"1\"\n },\n {\n \"taxID\": \"5\",\n \"friendlyName\": \"Arizona State DEPT\",\n \"taxRate\": \"2.5\",\n \"taxStatus\": \"1\"\n },\n {\n \"taxID\": \"2\",\n \"friendlyName\": \"California\",\n \"taxRate\": \"8\",\n \"taxStatus\": \"1\"\n },\n {\n \"taxID\": \"6\",\n \"friendlyName\": \"IST\",\n \"taxRate\": \"2.5\",\n \"taxStatus\": \"1\"\n },\n {\n \"taxID\": \"7\",\n \"friendlyName\": \"SID\",\n \"taxRate\": \"2.3\",\n \"taxStatus\": \"1\"\n },\n {\n \"taxID\": \"3\",\n \"friendlyName\": \"Tucson\",\n \"taxRate\": \"9.1\",\n \"taxStatus\": \"1\"\n }\n ],\n \"code\": 200\n}"},{"id":"8c482f71-7199-4f40-bc62-81a4f1da2fd4","name":"Success - No Data","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/Settings/getInvoicePrefix"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:42:47 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"54"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Merchant Settings\",\n \"data\": null,\n \"code\": 200\n}"}],"_postman_id":"f3ce6082-c6f7-4c21-8483-f173cdbea5d1"}],"id":"c481644b-71ea-4df2-b902-117e49ed2b9f","_postman_id":"c481644b-71ea-4df2-b902-117e49ed2b9f","description":""},{"name":"Customer","item":[{"name":"Create Customer","id":"ac21382d-9ae3-4314-8982-01cac563c134","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/customer/create","description":"

Create a new customer.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Key	Description	Required	Type	Default Value	Restricted Values
customerFullName	Customer Full Name	Yes	String	-	-
customerCompanyName	Customer Company Name	No	String	-	-
customerFirstName	Customer First Name	No	String	-	-
customerLastName	Customer Last Name	No	String	-	-
customerContact	Customer Contact Number	No	String	-	-
customerEmail	Customer Email Address	No	String	-	-
bAddress1	Customer Business Address Line1	No	String	-	-
bAddress2	Customer Business Address Line2	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
sAddress1	Customer Shipping Address Line 1	No	String	-	-
sAddress2	Customer Shipping Address Line 2	No	String	-	-
sCity	Customer Shipping Address City	No	String	-	-
sState	Customer Shipping Address State/Province	No	String	-	-
sZipcode	Customer Shipping Address ZipCode	No	String	-	-
sCountry	Customer Shipping Address Country	No	String	-	-

","urlObject":{"path":["customer","create"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"72d1ddf0-8002-439b-846f-154955f72cc2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerCompanyName","value":"John Doe LLC","type":"text"},{"key":"customerFullName","value":"John Doe","type":"text"},{"key":"customerFirstName","value":"John","type":"text"},{"key":"customerLastName","value":"Doe","type":"text"},{"key":"customerContact","value":"(123)-456-7890","type":"text"},{"key":"customerEmail","value":"john.doe@cztester.com","type":"text"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"}]},"url":"{{v2-url}}/customer/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Mar 2022 14:03:36 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"333"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer details successfully saved\",\n \"data\": {\n \"customerId\": \"103\",\n \"customerFirstName\": \"John\",\n \"customerLastName\": \"Doe\",\n \"customerCompanyName\": \"John Doe LLC\",\n \"customerFullName\": \"John Doe LLC\",\n \"customerContact\": \"(123)-456-7890\",\n \"customerEmail\": \"john.doe@cztester.com\",\n \"customerActiveStatus\": 1,\n \"customerCreatedAt\": \"2022-03-28 09:03:42\"\n },\n \"code\": 200\n}"},{"id":"90537cf5-4a09-4dfc-8f4b-0127b7f6ac0b","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerCompanyName","value":"John Doe LLC","type":"text"},{"key":"customerFullName","value":"John Doe","type":"text","disabled":true},{"key":"customerFirstName","value":"John","type":"text"},{"key":"customerLastName","value":"Doe","type":"text"},{"key":"customerContact","value":"(123)-456-7890","type":"text"},{"key":"customerEmail","value":"john.doe@cztester.com","type":"text"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"}]},"url":"{{v2-url}}/customer/create"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Mar 2022 14:04:42 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"114"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"customerFullName\": \"The Customer Full Name field is required.\"\n },\n \"message\": \"Validation Errors\",\n \"code\": 422\n}"}],"_postman_id":"ac21382d-9ae3-4314-8982-01cac563c134"},{"name":"Edit Customer","id":"c4e55857-c45a-460b-a670-1cd8a40222fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/customer/edit/","description":"

Update a customer information.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Key	Description	Required	Type	Default Value	Restricted Values
customerFullName	Customer Full Name	Yes	String	-	-
customerCompanyName	Customer Company Name	No	String	-	-
customerFirstName	Customer First Name	No	String	-	-
customerLastName	Customer Last Name	No	String	-	-
customerContact	Customer Contact Number	No	String	-	-
customerEmail	Customer Email Address	No	String	-	-
bAddress1	Customer Business Address Line1	No	String	-	-
bAddress2	Customer Business Address Line2	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
sAddress1	Customer Shipping Address Line 1	No	String	-	-
sAddress2	Customer Shipping Address Line 2	No	String	-	-
sCity	Customer Shipping Address City	No	String	-	-
sState	Customer Shipping Address State/Province	No	String	-	-
sZipcode	Customer Shipping Address ZipCode	No	String	-	-
sCountry	Customer Shipping Address Country	No	String	-	-

","urlObject":{"path":["customer","edit",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"c06ff124-d668-48dd-8e4b-f35d213945ea","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerCompanyName","value":"Amys Bird Sanctuary","type":"text"},{"key":"customerFullName","value":"Amys Bird Sanctuary","description":"Required","type":"text"},{"key":"customerFirstName","value":"Amy","type":"text"},{"key":"customerLastName","value":"Lauterbach","type":"text"},{"key":"customerContact","value":"","type":"text"},{"key":"customerEmail","value":"john.doe@cztester.com","type":"text","disabled":true},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"}]},"url":"{{v2-url}}/customer/edit/{{v2-customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Mar 2022 14:53:07 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"562"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer details successfully saved\",\n \"data\": {\n \"customerId\": \"1\",\n \"customerFirstName\": \"Amy\",\n \"customerLastName\": \"Lauterbach\",\n \"customerCompanyName\": \"Amys Bird Sanctuary\",\n \"customerFullName\": \"Amys Bird Sanctuary\",\n \"customerContact\": \"(650) 555-3311\",\n \"customerEmail\": \"john.doe@cztester.com\",\n \"customerActiveStatus\": 1,\n \"customerCreatedAt\": \"2020-08-12 18:48:43\",\n \"sAddress1\": \"4581 Finch St.\",\n \"sCity\": \"Bayshore\",\n \"sState\": \"CA\",\n \"sZipcode\": \"94326\",\n \"sCountry\": \"US\",\n \"bAddress1\": \"4581 Finch St.\",\n \"bAddress2\": \"\",\n \"bCity\": \"Bayshore\",\n \"bState\": \"CA\",\n \"bZipcode\": \"94326\",\n \"bCountry\": \"US\"\n },\n \"code\": 200\n}"},{"id":"4d704b57-3ae5-4379-be4f-437ec2546f2b","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerCompanyName","value":"John Doe LLC","type":"text"},{"key":"customerFullName","value":"0969 Ocean View Road","type":"text"},{"key":"customerFirstName","value":"Amy","type":"text"},{"key":"customerLastName","value":"Lauterbach","type":"text"},{"key":"customerContact","value":"","type":"text"},{"key":"customerEmail","value":"john.doe@cztester.com","type":"text"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"}]},"url":"{{v2-url}}/Customer/edit/{{v2-customerId}}"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Mar 2022 14:51:38 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"120"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"message\": \"The Customer Full Name already exists. Please enter a different Customer Full Name.\",\n \"code\": 422\n}"}],"_postman_id":"c4e55857-c45a-460b-a670-1cd8a40222fe"},{"name":"Get All Customer Data","id":"e7addb39-f10e-4d8b-934f-a14051772327","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/customer/get_customer_data","description":"

Retrieve a list of customers.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
page	Page Number (Starting - 0)	No	Int	0	-
limit	Listing Limit Count	No	Int	100	-
search	Filter Customer by [ customerFirstName, customerLastName, customerCompanyName, customerFullName, customerEmail ]	No	String	-	-

","urlObject":{"path":["customer","get_customer_data"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"4b439626-0c55-48b4-8195-2829d0fd0e14","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{v2-url}}/customer/get_customer_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Mar 2022 12:28:31 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"568"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Detail\",\n \"data\": [\n {\n \"customerId\": \"1\",\n \"customerFirstName\": \"Amy\",\n \"customerLastName\": \"Lauterbach\",\n \"customerCompanyName\": \"Amys Bird Sanctuary\",\n \"customerFullName\": \"Amys Bird SanctuaryMo\",\n \"customerContact\": \"(650) 555-3311\",\n \"customerEmail\": \"birds@mailinator.com\",\n \"customerActiveStatus\": \"true\",\n \"customerCreatedAt\": \"2020-08-12 18:48:43\",\n \"sAddress1\": \"4581 Finch St.\",\n \"sCity\": \"Bayshore\",\n \"sState\": \"CA\",\n \"sZipcode\": \"94326\",\n \"sCountry\": \"US\",\n \"bAddress1\": \"4581 Finch St.\",\n \"bAddress2\": \"\",\n \"bCity\": \"Bayshore\",\n \"bState\": \"CA\",\n \"bZipcode\": \"94326\",\n \"bCountry\": \"US\"\n }\n ],\n \"code\": 200\n}"},{"id":"e3dd05b4-ade1-482a-97aa-233b4169dea4","name":"Success - Pagination","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"page","value":"0","description":"Page Count ( Default - 0 )\nAccept only digits (0,1,2 etc)","type":"text"},{"key":"limit","value":"100","description":"Limit Count ( Default - 0 )\nAccept only digits (0,1,2 etc)","type":"text"},{"key":"search","value":"","description":"Optional","type":"text"}]},"url":"{{v2-url}}/customer/get_customer_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Mar 2022 12:26:07 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"568"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Detail\",\n \"data\": [\n {\n \"customerId\": \"1\",\n \"customerFirstName\": \"Amy\",\n \"customerLastName\": \"Lauterbach\",\n \"customerCompanyName\": \"Amys Bird Sanctuary\",\n \"customerFullName\": \"Amys Bird SanctuaryMo\",\n \"customerContact\": \"(650) 555-3311\",\n \"customerEmail\": \"birds@mailinator.com\",\n \"customerActiveStatus\": \"true\",\n \"customerCreatedAt\": \"2020-08-12 18:48:43\",\n \"sAddress1\": \"4581 Finch St.\",\n \"sCity\": \"Bayshore\",\n \"sState\": \"CA\",\n \"sZipcode\": \"94326\",\n \"sCountry\": \"US\",\n \"bAddress1\": \"4581 Finch St.\",\n \"bAddress2\": \"\",\n \"bCity\": \"Bayshore\",\n \"bState\": \"CA\",\n \"bZipcode\": \"94326\",\n \"bCountry\": \"US\"\n }\n ],\n \"code\": 200\n}"},{"id":"3381c09d-a6de-4a5d-86ac-60ca6d1364d8","name":"Error - No Data","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"page","value":"0","description":"Page Count ( Default - 0 )\nAccept only digits (0,1,2 etc)","type":"text"},{"key":"limit","value":"1","description":"Limit Count ( Default - 0 )\nAccept only digits (0,1,2 etc)","type":"text"},{"key":"search","value":"","description":"Optional","type":"text"}]},"url":"{{v2-url}}/customer/get_customer_data"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Mar 2022 12:31:04 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"50"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No data found\",\n \"data\": null,\n \"code\": 400\n}"},{"id":"af084a96-608d-4a4b-9b2d-91530c304452","name":"Error - Page | Limit Invalid Value","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"page","value":"-2","description":"Page Count ( Default - 0 )\nAccept only digits (0,1,2 etc)","type":"text"},{"key":"limit","value":"-5","description":"Limit Count ( Default - 0 )\nAccept only digits (0,1,2 etc)","type":"text"},{"key":"search","value":"amy","description":"Optional","type":"text","disabled":true}]},"url":"{{v2-url}}/customer/get_customer_data"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Mar 2022 12:31:49 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"153"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"page\": \"The Page field must only contain digits.\",\n \"limit\": \"The Limit field must only contain digits.\"\n },\n \"message\": \"Validation Errors\",\n \"code\": 422\n}"}],"_postman_id":"e7addb39-f10e-4d8b-934f-a14051772327"},{"name":"Get Single Customer Details","id":"3b1e5c6b-1966-4420-86c0-506e571a5f4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/customer/","description":"

Retrieve a specific customers information

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["customer",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"b1f42bb7-f57c-46fe-9f87-2f91f09849cf","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/customer/{{v2-customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Mar 2022 10:50:48 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"566"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Detail\",\n \"data\": {\n \"customerId\": \"1\",\n \"customerFirstName\": \"Amy\",\n \"customerLastName\": \"Lauterbach\",\n \"customerCompanyName\": \"Amys Bird Sanctuary\",\n \"customerFullName\": \"Amys Bird SanctuaryMo\",\n \"customerContact\": \"(650) 555-3311\",\n \"customerEmail\": \"birds@mailinator.com\",\n \"customerActiveStatus\": \"true\",\n \"customerCreatedAt\": \"2020-08-12 18:48:43\",\n \"sAddress1\": \"4581 Finch St.\",\n \"sCity\": \"Bayshore\",\n \"sState\": \"CA\",\n \"sZipcode\": \"94326\",\n \"sCountry\": \"US\",\n \"bAddress1\": \"4581 Finch St.\",\n \"bAddress2\": \"\",\n \"bCity\": \"Bayshore\",\n \"bState\": \"CA\",\n \"bZipcode\": \"94326\",\n \"bCountry\": \"US\"\n },\n \"code\": 200\n}"},{"id":"58cd8317-662f-41c5-9f73-1142853ee422","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/customer/{{v2-customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:13:38 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%221483a5e65e5b0ea2f49834c9a2ccdeb7%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597218%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dec1b88fffb885bf14b87269aad3132dedacc7120; expires=Mon, 01-Mar-2021 13:13:38 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"50"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No data found\",\n \"data\": null,\n \"code\": 400\n}"}],"_postman_id":"3b1e5c6b-1966-4420-86c0-506e571a5f4c"},{"name":"Activate / Deactivate Customer","id":"e57c9af3-02c8-4015-b296-2e048b060cce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/customer/status/","description":"

Activate or Deactivate a customer status.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
customerActiveStatus	Customer Active Status (Set 1 to Activate the customer)	No	Int	0	[ 0,1 ]

","urlObject":{"path":["customer","status",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"390b8728-cb75-4de2-8211-de2c179f677d","name":"Activate Success","originalRequest":{"method":"POST","header":[{"key":"secret_key","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerActiveStatus","value":"1","description":"Required: Accepted Values\n0 => Deactivate\n1 => Actiavte","type":"text"}]},"url":"{{v2-url}}/customer/status/{{v2-customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:21:42 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%229e48ca6ad910be4f54ab919cb51f6836%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597702%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dd259663ccc992749c96a920dc78b65d8ba348143; expires=Mon, 01-Mar-2021 13:21:42 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"729"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Detail\",\n \"data\": {\n \"customerId\": \"83\",\n \"customerFirstName\": \"Chargezoom\",\n \"customerLastName\": \"Test\",\n \"customerCompanyName\": \"Chargezoom Test\",\n \"customerFullName\": \"Chargezoom Test\",\n \"customerContact\": \"\",\n \"customerEmail\": \"chargezoom.test@cztester.com\",\n \"customerActiveStatus\": \"1\",\n \"customerCreatedAt\": \"2021-09-07 01:35:47\",\n \"sAddress1\": \"10 Street\",\n \"sAddress2\": \"\",\n \"sCity\": \"Tucson\",\n \"sState\": \"CA\",\n \"sZipcode\": \"85023\",\n \"sCountry\": \"USA\",\n \"bAddress1\": \"10 Street\",\n \"bAddress2\": \"\",\n \"bCity\": \"Tucson\",\n \"bState\": \"CA\",\n \"bZipcode\": \"85023\",\n \"bCountry\": \"USA\"\n },\n \"code\": 200\n}"},{"id":"23fcdbd6-5b68-4a03-82fe-b041eecdbe81","name":"Deactivate Success","originalRequest":{"method":"POST","header":[{"key":"secret_key","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerActiveStatus","value":"0","description":"Required: Accepted Values\n0 => Deactivate\n1 => Actiavte","type":"text"}]},"url":"{{v2-url}}/customer/status/{{v2-customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:22:18 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22f53cbf3adeed544da8b22aded62e9705%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597738%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Df8b2096f702ffaec33f7cecdddd102d3340f93c7; expires=Mon, 01-Mar-2021 13:22:18 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"730"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Detail\",\n \"data\": {\n \"customerId\": \"83\",\n \"customerFirstName\": \"Chargezoom\",\n \"customerLastName\": \"Test\",\n \"customerCompanyName\": \"Chargezoom Test\",\n \"customerFullName\": \"Chargezoom Test (deleted)\",\n \"customerContact\": \"\",\n \"customerEmail\": \"chargezoom.test@cztester.com\",\n \"customerActiveStatus\": \"0\",\n \"customerCreatedAt\": \"2021-09-07 01:35:47\",\n \"sAddress1\": \"10 Street\",\n \"sAddress2\": \"\",\n \"sCity\": \"Tucson\",\n \"sState\": \"CA\",\n \"sZipcode\": \"85023\",\n \"sCountry\": \"USA\",\n \"bAddress1\": \"10 Street\",\n \"bAddress2\": \"\",\n \"bCity\": \"Tucson\",\n \"bState\": \"CA\",\n \"bZipcode\": \"85023\",\n \"bCountry\": \"USA\"\n },\n \"code\": 200\n}"},{"id":"7418260e-f388-49ff-b59b-35a79a00cc20","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secret_key","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerActiveStatus","value":"Deactivate","description":"Required: Accepted Values\n0 => Deactivate\n1 => Actiavte","type":"text"}]},"url":"{{v2-url}}/customer/status/{{v2-customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:22:46 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22f343edffcf815889e997f427a068387e%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597766%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dac351858ab8872e392d00d213402f60d89ae04ca; expires=Mon, 01-Mar-2021 13:22:46 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"58"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"customerActiveStatus\": \"Invalid request. Custome Active Status accepts only 0,1\"\n },\n \"message\": \"Validation Errors\",\n \"code\": 422\n}"}],"_postman_id":"e57c9af3-02c8-4015-b296-2e048b060cce"},{"name":"Create Payment Method","id":"dcf9d819-6432-4e91-be19-0d90d8a72911","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/customer/card/create","description":"

Create an ACH or Card payment method for a customer.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
defaultCard	Flag to set credit card default	Yes	Int	0	[0,1]
paymentMethod	Payment Method Type ( 1 for Credit Card & 2 for ACH)	Yes	Int	-	[1,2]
customerId	Customer ID	Yes	String	-	-
bAddress1	Customer Business Address Line1	No	String	-	-
bAddress2	Customer Business Address Line2	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
bPhone	Customer Business Phone	No	String	-	-

Payment Method : 1 ( Credit Card )

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
cardNumber	Customer Credit Card Number	Yes	String	-	-
cardCvv	Customer Credit Card CVV	No	String	-	-
expMonth	Customer Credit Card Expiry Month	Yes	String	-	-
expYear	Customer Credit Card Expiry Year	Yes	String	-	-

Payment Method : 2 ( ACH )

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
eaccountName	Customer ACH Account Holder Name	Yes	String	-	-
eaccountNumber	Customer ACH Account Number	Yes	String	-	-
erouteNumber	Customer ACH Account Routing Number	Yes	String	-	-
eaccountType	Customer ACH Account Type	Yes	String	-	[checking,saving]
eaccountHolderType	Customer ACH Account Holder Type	Yes	String	-	[business,personal]

","urlObject":{"path":["customer","card","create"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"8fb2a60e-2f90-40d2-bd7e-4cdf248f0b3b","name":"Create ACH","originalRequest":{"method":"POST","header":[{"description":"required","key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"paymentMethod","value":"2","description":"required","type":"text"},{"key":"customerId","value":"1","description":"required","type":"text"},{"key":"eaccountName","value":"John Doe","description":"required (if paymentMethod is 2)","type":"text"},{"key":"eaccountNumber","value":"123123123","description":"required (if paymentMethod is 2)","type":"text"},{"key":"erouteNumber","value":"123123123","description":"required (if paymentMethod is 2)","type":"text"},{"key":"eaccountType","value":"checking","description":"Value: checking/saving","type":"text"},{"key":"eaccountHolderType","value":"business","description":"Value: business/personal","type":"text"},{"key":"bAddress1","value":"87026","type":"text"},{"key":"bAddress2","value":"US","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"TX","type":"text"},{"key":"bCountry","value":"United States","type":"text"},{"key":"bPhone","value":"8745859654","type":"text"},{"key":"bZipcode","value":"54781","type":"text"},{"key":"defaultCard","value":"0","description":"required ( 1 || 0 )","type":"text"}]},"url":"{{v2-url}}/customer/card/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Mar 2022 10:43:07 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"81"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment Term Created Successfully\",\n \"data\": {\n \"cardId\": 1244\n },\n \"code\": 200\n}"},{"id":"22c9ee92-988a-413a-8c3b-fbf6cb9a79c1","name":"Create Customer Card - Credit Card","originalRequest":{"method":"POST","header":[{"description":"required","key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"paymentMethod","value":"1","description":"required (Put the value )","type":"text"},{"key":"customerId","value":"1","type":"text"},{"key":"cardNumber","value":"4111111111111111","description":"required (if paymentMethod is 1)","type":"text"},{"key":"cardCvv","value":"1234","type":"text"},{"key":"expMonth","value":"03","description":"required (if paymentMethod is 1)","type":"text"},{"key":"expYear","value":"2025","description":"required (if paymentMethod is 1)","type":"text"},{"key":"bAddress1","value":"87026","type":"text"},{"key":"bAddress2","value":"US","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"TX","type":"text"},{"key":"bCountry","value":"United States","type":"text"},{"key":"bPhone","value":"8745859654","type":"text"},{"key":"bZipcode","value":"54781","type":"text"},{"key":"defaultCard","value":"1","description":"required ( 1 || 0 )","type":"text"}]},"url":"{{v2-url}}/customer/card/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Mar 2022 10:49:57 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"80"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment Term Created Successfully\",\n \"data\": {\n \"cardId\": 622\n },\n \"code\": 200\n}"}],"_postman_id":"dcf9d819-6432-4e91-be19-0d90d8a72911"},{"name":"Edit Payment Method","id":"50d9a05d-ac80-44c9-9835-563e355883db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/customer/card/edit","description":"

Update Credit Card/ACH details for the customer.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Key	Description	Required	Type	Default Value	Restricted Values
cardId	Card ID	Yes	String	-	-
defaultCard	Flag to set credit card default	Yes	Int	0	[0,1]
paymentMethod**	Payment Method Type ( 1 for Credit Card & 2 for ACH)	Yes	Int	-	[1,2]
customerId	Customer ID	Yes	String	-	-
bAddress1	Customer Business Address Line1	No	String	-	-
bAddress2	Customer Business Address Line2	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
bPhone	Customer Business Phone	No	String	-	-

Payment Method : 1 ( Credit Card )

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
cardNumber	Customer Credit Card Number	Yes	String	-	-
cardCvv	Customer Credit Card CVV	No	String	-	-
expMonth	Customer Credit Card Expiry Month	Yes	String	-	-
expYear	Customer Credit Card Expiry Year	Yes	String	-	-

Payment Method : 2 ( ACH )

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
eaccountName	Customer ACH Account Holder Name	Yes	String	-	-
eaccountNumber	Customer ACH Account Number	Yes	String	-	-
erouteNumber	Customer ACH Account Routing Number	Yes	String	-	-
eaccountType	Customer ACH Account Type	Yes	String	-	[checking,saving]
eaccountHolderType	Customer ACH Account Holder Type	Yes	String	-	[business,personal]

","urlObject":{"path":["customer","card","edit"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"4384c82c-4069-40eb-8820-6a939e6781b0","name":"Edit Customer Card - Credit Card","originalRequest":{"method":"POST","header":[{"description":"required","key":"secretKey","value":"{{v2-token}}"},{"key":"token","value":"{{v2-secretKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"paymentMethod","value":"1","description":"required (Put the value )","type":"text"},{"key":"cardId","value":"622","description":"required","type":"text"},{"key":"customerId","value":"1","type":"text"},{"key":"cardNumber","value":"4111111111111111","description":"required (if paymentMethod is 1)","type":"text"},{"key":"cardCvv","value":"1234","type":"text"},{"key":"expMonth","value":"03","description":"required (if paymentMethod is 1)","type":"text"},{"key":"expYear","value":"2025","description":"required (if paymentMethod is 1)","type":"text"},{"key":"bAddress1","value":"87026","type":"text"},{"key":"bAddress2","value":"US","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"TX","type":"text"},{"key":"bCountry","value":"United States","type":"text"},{"key":"bPhone","value":"8745859654","type":"text"},{"key":"bZipcode","value":"54781","type":"text"},{"key":"defaultCard","value":"1","description":"required ( 1 || 0 )","type":"text"}]},"url":"{{v2-url}}/customer/card/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Mar 2022 10:49:57 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"80"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment Term Created Successfully\",\n \"data\": {\n \"cardId\": 622\n },\n \"code\": 200\n}"},{"id":"69ca01f5-d8f3-4219-a828-8c3a8e86b7fa","name":"Edit Customer Card - ACH","originalRequest":{"method":"POST","header":[{"description":"required","key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"paymentMethod","value":"2","description":"required (Put the value )","type":"text"},{"key":"customerId","value":"1","description":"required","type":"text"},{"key":"eaccountName","value":"John Doe","description":"required (if paymentMethod is 2)","type":"text"},{"key":"eaccountNumber","value":"123123123","description":"required (if paymentMethod is 2)","type":"text"},{"key":"erouteNumber","value":"123123123","description":"required (if paymentMethod is 2)","type":"text"},{"key":"eaccountType","value":"checking","description":"Value: checking/saving","type":"text"},{"key":"eaccountHolderType","value":"business","description":"Value: business/personal","type":"text"},{"key":"bAddress1","value":"87026","type":"text"},{"key":"bAddress2","value":"US","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"TX","type":"text"},{"key":"bCountry","value":"United States","type":"text"},{"key":"bPhone","value":"8745859654","type":"text"},{"key":"bZipcode","value":"54781","type":"text"},{"key":"defaultCard","value":"0","description":"required ( 1 || 0 )","type":"text"}]},"url":"{{v2-url}}/customer/card/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Mar 2022 12:37:17 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"78"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Card details saved Successfully\",\n \"data\": {\n \"cardId\": 622\n },\n \"code\": 200\n}"}],"_postman_id":"50d9a05d-ac80-44c9-9835-563e355883db"},{"name":"Get Payment Methods","id":"b345b065-8f98-4aa5-a494-2b6324915222","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/customer/card/","description":"

Retreive a customers Credit Card/ACH information using customerID.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["customer","card",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"4ed869a5-001c-4bd9-869e-42d75391659a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/customer/card/{{v2-customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:26:08 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2241a3439f59e3fbde2325cf86d1d12731%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597968%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D6bf786a0b44aaf85038d5db4b484e0fbbaf96c7e; expires=Mon, 01-Mar-2021 13:26:08 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"889"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Card details fetched successfully.\",\n \"data\": [\n {\n \"cardId\": \"622\",\n \"cardFriendlyName\": \"Echeck - 3124\",\n \"cardNumber\": \"\",\n \"expMonth\": \"0\",\n \"expYear\": \"0\",\n \"eaccountNumber\": \"123123124\",\n \"erouteNumber\": \"123123123\",\n \"eaccountName\": \"John Doe\",\n \"eaccountType\": \"checking\",\n \"eaccountHolderType\": \"business\",\n \"bAddress1\": \"\",\n \"bAddress2\": \"\",\n \"bCity\": \"Dallas\",\n \"bState\": \"TX\",\n \"bZipcode\": \"54781\",\n \"bCountry\": \"United States\",\n \"userContact\": \"\"\n },\n {\n \"cardId\": \"1016\",\n \"cardFriendlyName\": \"Echeck - 3456\",\n \"cardNumber\": \"\",\n \"expMonth\": \"0\",\n \"expYear\": \"0\",\n \"eaccountNumber\": \"123456\",\n \"erouteNumber\": \"325070760\",\n \"eaccountName\": \"John Doe\",\n \"eaccountType\": \"checking\",\n \"eaccountHolderType\": \"business\",\n \"bAddress1\": \"4581 Finch St.\",\n \"bAddress2\": \"\",\n \"bCity\": \"Bayshore\",\n \"bState\": \"CA\",\n \"bZipcode\": \"94326\",\n \"bCountry\": \"null\",\n \"userContact\": \"\"\n },\n {\n \"cardId\": \"1066\",\n \"cardFriendlyName\": \"Echeck - 2345\",\n \"cardNumber\": \"\",\n \"expMonth\": \"0\",\n \"expYear\": \"0\",\n \"eaccountNumber\": \"12345\",\n \"erouteNumber\": \"071000013\",\n \"eaccountName\": \"John Doe\",\n \"eaccountType\": \"checking\",\n \"eaccountHolderType\": \"business\",\n \"bAddress1\": \"4581 Finch St.\",\n \"bAddress2\": \"\",\n \"bCity\": \"Bayshore\",\n \"bState\": \"CA\",\n \"bZipcode\": \"94326\",\n \"bCountry\": \"\",\n \"userContact\": \"(650) 555-3311\"\n },\n {\n \"cardId\": \"1112\",\n \"cardFriendlyName\": \"Visa - 5439\",\n \"cardNumber\": \"5439\",\n \"expMonth\": \"1\",\n \"expYear\": \"22\",\n \"eaccountNumber\": null,\n \"erouteNumber\": null,\n \"eaccountName\": null,\n \"eaccountType\": null,\n \"eaccountHolderType\": null,\n \"bAddress1\": \"4581 Finch St.\",\n \"bAddress2\": \"\",\n \"bCity\": \"Bayshore\",\n \"bState\": \"CA\",\n \"bZipcode\": \"94326\",\n \"bCountry\": \"US\",\n \"userContact\": \"(650) 555-3311\"\n },\n {\n \"cardId\": \"1244\",\n \"cardFriendlyName\": \"Echeck - 3123\",\n \"cardNumber\": \"\",\n \"expMonth\": \"0\",\n \"expYear\": \"0\",\n \"eaccountNumber\": \"123123123\",\n \"erouteNumber\": \"123123123\",\n \"eaccountName\": \"John Doe\",\n \"eaccountType\": \"checking\",\n \"eaccountHolderType\": \"business\",\n \"bAddress1\": null,\n \"bAddress2\": null,\n \"bCity\": \"Dallas\",\n \"bState\": \"TX\",\n \"bZipcode\": \"54781\",\n \"bCountry\": \"United States\",\n \"userContact\": null\n }\n ],\n \"code\": 200\n}"},{"id":"f22279f5-2e2a-4b53-ae2c-4dc7af4234e7","name":"Error","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/customer/card/{{v2-customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:26:50 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%222b7266c9964aee7154fcec49f8b7725a%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614598010%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Ddb47e123dc4e18841e004122dbeb6e95fd2c39d5; expires=Mon, 01-Mar-2021 13:26:50 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"77"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No data found\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"b345b065-8f98-4aa5-a494-2b6324915222"},{"name":"Get Single Payment Method Data","id":"3b0a4289-36ac-4a9f-8ab0-542154ce0a3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/customer/card//","description":"

Retrieve customer Credit Card/ACH details using the combination of customerID & cardID.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["customer","card","",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"5c7d88ae-5440-4365-ba4d-cf9481e03a51","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":""},{"key":"token","value":"","type":"text"}],"url":"http://localhost/payportal-api/v2/customer/card/1/{{v2-cardId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:27:55 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22259a4d383f567c9280694039252a5106%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614598075%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dde49ed91e6ea901b69508fae02c54ca97bf67007; expires=Mon, 01-Mar-2021 13:27:55 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"352"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Card details fetched successfully.\",\n \"data\": {\n \"cardId\": \"1112\",\n \"cardFriendlyName\": \"Visa - 5439\",\n \"cardNumber\": \"5439\",\n \"expMonth\": \"1\",\n \"expYear\": \"22\",\n \"eaccountNumber\": null,\n \"erouteNumber\": null,\n \"eaccountName\": null,\n \"eaccountType\": null,\n \"eaccountHolderType\": null,\n \"bAddress1\": \"4581 Finch St.\",\n \"bAddress2\": \"\",\n \"bCity\": \"Bayshore\",\n \"bState\": \"CA\",\n \"bZipcode\": \"94326\",\n \"bCountry\": \"US\",\n \"userContact\": \"(650) 555-3311\"\n },\n \"code\": 200\n}"},{"id":"874543d2-06d9-4ae9-b17b-d90678725a54","name":"Error","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/customer/card/{{v2-customerId}}/{{v2-cardId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:28:15 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22b23623fe291fa169897cdde8ed83e096%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614598095%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D1a8c5fd09916e7246bcbb1b3be169803eff082da; expires=Mon, 01-Mar-2021 13:28:15 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"50"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No data found\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"3b0a4289-36ac-4a9f-8ab0-542154ce0a3b"},{"name":"Delete Customer's Payment Method","id":"e4167434-a8ce-46c9-99ad-3496552130f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/customer/card///delete","description":"

Delete customer Credit Card/ACH details using the combination of customerID & cardID.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["customer","card","","","delete"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"3e4abb00-506a-451c-8327-e7209e36748c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":""},{"key":"token","value":"","type":"text"}],"url":"{{v2-url}}/customer/card///delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Mar 2022 13:29:19 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"71"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Card details successfully removed.\",\n \"data\": null,\n \"code\": 200\n}"},{"id":"7abeba1e-aacb-45c9-b845-9928a14b542f","name":"Error","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/customer/card///delete"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Mar 2022 13:24:41 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"104"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"message\": \"Unable to verify card details. Please check your details carefully.\",\n \"code\": 400\n}"}],"_postman_id":"e4167434-a8ce-46c9-99ad-3496552130f5"},{"name":"Create Customer Note","id":"424a4f3b-6316-44a6-8a93-ce574cff6f63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/customer/note/create","description":"

Create customer notes.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
customerId	Customer ID	Yes	String	-	-
noteText	Note Text	Yes	String	-	-

","urlObject":{"path":["customer","note","create"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"23f93f8c-4ee4-45f1-80aa-794fc7cfe711","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":""},{"key":"token","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerId","value":"1","description":"requied","type":"text"},{"key":"noteText","value":"Invoice related details as a note","description":"required","type":"text"}]},"url":"{{v2-url}}/customer/note/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:33:11 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22a6aacd75e95922286b89142163a2ec01%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614598391%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D141c1d9c038610dcf472393ac4491519526bb5dd; expires=Mon, 01-Mar-2021 13:33:11 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"68"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Private Note Created Successfully\",\n \"data\": 32,\n \"code\": 200\n}"}],"_postman_id":"424a4f3b-6316-44a6-8a93-ce574cff6f63"},{"name":"Get Customer Notes","id":"8780e54c-9a7e-4edc-8de9-3fb687eca46d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/customer/note/","description":"

Retrieve customer notes.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["customer","note",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"37f12270-00eb-45c8-aafe-115ec885d8e4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":""},{"key":"token","value":"","type":"text"}],"url":"{{v2-url}}/customer/note/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:05:00 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2205b5274387ea1b292e7fb9ab46246cad%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614600300%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D7658c27e645a71f1d2b8c1cfac1e8921bbd93ec8; expires=Mon, 01-Mar-2021 14:05:00 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"216"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Note list\",\n \"data\": [\n {\n \"noteText\": \"NOTE SAMPLE - 1\",\n \"id\": \"1\"\n },\n {\n \"noteText\": \"NOTE SAMPLE - 2\",\n \"id\": \"2\"\n }\n ],\n \"code\": 200\n}"},{"id":"b5bacd6b-e9fe-4819-9d43-6e59f4b823cc","name":"Error","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/customer/note/{{v2-customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:05:21 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22990a5c2c527dc3df1d54fb0d9ddeb158%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614600321%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dbf3ede35f53060eb53cbc27aa71f394da878a512; expires=Mon, 01-Mar-2021 14:05:21 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"50"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No data found\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"8780e54c-9a7e-4edc-8de9-3fb687eca46d"},{"name":"Delete Customer Note","id":"3bbfef50-3ce3-430d-870b-2f0a5564771e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/customer/note///delete","description":"

Delete customer notes.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["customer","note","","","delete"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"5dacc3c5-693a-4959-973b-0089449ee5e9","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":""},{"key":"token","value":"","type":"text"}],"url":"{{v2-url}}/customer/note///delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:06:24 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22aee28c93f6345ff2e88e5a8e6ba6c5e9%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614600384%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7De82da996d48954f988bf4e148f796a45e6023046; expires=Mon, 01-Mar-2021 14:06:24 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"68"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Note Deleted Successfuly\",\n \"data\": \"\",\n \"code\": 200\n}"}],"_postman_id":"3bbfef50-3ce3-430d-870b-2f0a5564771e"},{"name":"Request Customer Portal","id":"7782dbc9-a72d-4c27-82e7-14d9595f40fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/customer/portal_status/","description":"

Manage customer portal.

Activate and send customer portal link to the customer. (customerPortalStatus required to set Activate)
Resend customer portal link to the customer. (customerPortalStatus required to set Resend)
Disable customer portal link for the customer. (customerPortalStatus required to set Deactivate)

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
customerPortalStatus	Customer Portal Status	Yes	String	-	[Deactivate, Activate, Resend]

","urlObject":{"path":["customer","portal_status",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"84264a0f-af40-47dc-a7d8-6ecfce58951f","name":"Activate Success","originalRequest":{"method":"POST","header":[{"key":"secret_key","type":"text","value":""},{"key":"token","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerPortalStatus","value":"Activate","description":"**Required** || **Accepted Values [ Deactivate, Activate, Resend]**","type":"text"}]},"url":"{{v2-url}}/customer/portal_status/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:21:42 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%229e48ca6ad910be4f54ab919cb51f6836%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597702%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dd259663ccc992749c96a920dc78b65d8ba348143; expires=Mon, 01-Mar-2021 13:21:42 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"729"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Detail\",\n \"data\": {\n \"customerId\": \"83\",\n \"customerFirstName\": \"Chargezoom\",\n \"customerLastName\": \"Test\",\n \"customerCompanyName\": \"Chargezoom Test\",\n \"customerFullName\": \"Chargezoom Test\",\n \"customerContact\": \"\",\n \"customerEmail\": \"chargezoom.test@cztester.com\",\n \"customerActiveStatus\": \"1\",\n \"customerCreatedAt\": \"2021-09-07 01:35:47\",\n \"sAddress1\": \"10 Street\",\n \"sAddress2\": \"\",\n \"sCity\": \"Tucson\",\n \"sState\": \"CA\",\n \"sZipcode\": \"85023\",\n \"sCountry\": \"USA\",\n \"bAddress1\": \"10 Street\",\n \"bAddress2\": \"\",\n \"bCity\": \"Tucson\",\n \"bState\": \"CA\",\n \"bZipcode\": \"85023\",\n \"bCountry\": \"USA\"\n },\n \"code\": 200\n}"},{"id":"aa9ebce6-7f18-41be-9546-e705a10bda38","name":"Deactivate Success","originalRequest":{"method":"POST","header":[{"key":"secret_key","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerPortalStatus","value":"Deactivate","description":"**Required** || **Accepted Values [ Deactivate, Activate, Resend]**","type":"text"}]},"url":"{{v2-url}}/customer/portal_status/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:22:18 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22f53cbf3adeed544da8b22aded62e9705%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597738%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Df8b2096f702ffaec33f7cecdddd102d3340f93c7; expires=Mon, 01-Mar-2021 13:22:18 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"730"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Detail\",\n \"data\": {\n \"customerId\": \"1\",\n \"customerFirstName\": \"Amy\",\n \"customerLastName\": \"Lauterbach\",\n \"customerCompanyName\": \"Amys Bird Sanctuary\",\n \"customerFullName\": \"Amys Bird SanctuaryMo\",\n \"customerContact\": \"(650) 555-3311\",\n \"customerEmail\": \"john.doe@cztester.com\",\n \"customerActiveStatus\": 1,\n \"customerCreatedAt\": \"2020-08-12 18:48:43\",\n \"customerPortalStatus\": \"deactive\",\n \"sAddress1\": \"4581 Finch St.\",\n \"sAddress2\": \"\",\n \"sCity\": \"Bayshore\",\n \"sState\": \"CA\",\n \"sZipcode\": \"94326\",\n \"sCountry\": \"US\",\n \"bAddress1\": \"4581 Finch St.\",\n \"bAddress2\": \"\",\n \"bCity\": \"Bayshore\",\n \"bState\": \"CA\",\n \"bZipcode\": \"94326\",\n \"bCountry\": \"US\"\n },\n \"code\": 200\n}"},{"id":"caedb83e-a3a6-46df-ab8a-4a853d16396f","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secret_key","type":"text","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerPortalStatus","value":"Pending","description":"**Required** || **Accepted Values [ Deactivate, Activate, Resend]**","type":"text"}]},"url":"{{v2-url}}/Customer/updateStatus/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:22:46 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22f343edffcf815889e997f427a068387e%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597766%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dac351858ab8872e392d00d213402f60d89ae04ca; expires=Mon, 01-Mar-2021 13:22:46 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"58"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"customerPortalStatus\": \"Invalid request. Custome Portal Status accepts only Deactivate, Activate, Resend\"\n },\n \"message\": \"Validation Errors\",\n \"code\": 422\n}"}],"_postman_id":"7782dbc9-a72d-4c27-82e7-14d9595f40fc"}],"id":"b3329228-89d7-4043-a6a2-e27df406dddf","_postman_id":"b3329228-89d7-4043-a6a2-e27df406dddf","description":""},{"name":"Invoices","item":[{"name":"Pay Invoice","id":"fb4adf4d-c69a-400e-b138-1e5fe974609b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/invoice/process_payment","description":"

Process payment for the invoice using various input parameters:

Using the saved details.
Using the new credit card details.
Using the new ACH account details.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Saved Payment Details

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
invoiceId	Invoice ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
payAmount	Amount to be process for the invoice	Yes	float	-	-
paymentMethod	Payment Method Type ( 1 for Credit Card & 2 for ACH)	Yes	Int	-	[1,2]
cardID	Card ID	Yes	String	-	-

New Card & Payment Method : 1 ( Credit Card )

Key	Description	Required	Type	Default Value	Restricted Values
invoiceId	Invoice ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
payAmount	Amount to be process for the invoice	Yes	float	-	-
paymentMethod	Payment Method Type ( 1 for Credit Card & 2 for ACH)	Yes	Int	-	[1,2]
cardID	Card ID	Yes	String	new1	new1
cardNumber	Customer Credit Card Number	Yes	String	-	-
cardCvv	Customer Credit Card CVV	No	String	-	-
expMonth	Customer Credit Card Expiry Month	Yes	String	-	-
expYear	Customer Credit Card Expiry Year	Yes	String	-	-
bAddress1	Customer Business Address Line1	No	String	-	-
bAddress2	Customer Business Address Line2	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
bPhone	Customer Business Phone	No	String	-	-

New ACH & Payment Method : 2 ( ACH )

Key	Description	Required	Type	Default Value	Restricted Values
invoiceId	Invoice ID	Yes	String	-	-
gatewayId	Gateway ID	Yes	String	-	-
payAmount	Amount to be process for the invoice	Yes	float	-	-
paymentMethod	Payment Method Type ( 1 for Credit Card & 2 for ACH)	Yes	Int	-	[1,2]
cardID	Card ID	Yes	String	new1	new1
eaccountName	Customer ACH Account Holder Name	Yes	String	-	-
eaccountNumber	Customer ACH Account Number	Yes	String	-	-
erouteNumber	Customer ACH Account Routing Number	Yes	String	-	-
eaccountType	Customer ACH Account Type	Yes	String	-	[checking,saving]
eaccountHolderType	Customer ACH Account Holder Type	Yes	String	-	[business,personal]
bAddress1	Customer Business Address Line1	No	String	-	-
bAddress2	Customer Business Address Line2	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
bPhone	Customer Business Phone	No	String	-	-

","urlObject":{"path":["invoice","process_payment"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"a069df6d-1d8a-4e6e-a794-de97e235159f","name":"Successful Payment - New Credit Card","originalRequest":{"method":"POST","header":[{"description":"required","key":"secretKey","value":""},{"key":"token","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"invoiceId","value":"INV-2505848-Z9YEK4","description":"required","type":"text"},{"key":"gatewayId","value":"303","description":"required, Gateway Identification Key","type":"text"},{"key":"payAmount","value":"5.00","description":"requred","type":"text"},{"key":"paymentMethod","value":"1","description":"required (Put the value )","type":"text"},{"key":"cardId","value":"new1","description":"required (Put the value for existing card and new1 option for new card)","type":"text"},{"key":"cardNumber","value":"4111111111111111","description":"required (In case of new card)","type":"text"},{"key":"cardCvv","value":"1234","type":"text"},{"key":"expMonth","value":"02","description":"required (In case of new card)","type":"text"},{"key":"expYear","value":"2025","description":"required (In case of new card)","type":"text"},{"key":"bAddress1","value":"87026","type":"text"},{"key":"bAddress2","value":"US","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"TX","type":"text"},{"key":"bCountry","value":"United States","type":"text"},{"key":"bPhone","value":"8745859654","type":"text"},{"key":"bZipcode","value":"54781","type":"text"},{"key":"customerContact","value":"","description":"Customer Contact Number (Optional)","type":"text"}]},"url":"{{v2-url}}/invoice/process_payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Mar 2022 10:47:41 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"846"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"transactionID\": \"7068388501\",\n \"invoiceData\": {\n \"invoiceID\": \"INV-2505848-Z9YEK4\",\n \"refNumber\": \"CZs10095\",\n \"BalanceRemaining\": \"420.00\",\n \"DueDate\": \"2022-02-22\",\n \"IsPaid\": \"false\",\n \"AppliedAmount\": \"-85.00\",\n \"taxID\": \"1\",\n \"totalTax\": \"40.40\",\n \"taxRate\": \"8.00\",\n \"TimeCreated\": \"2022-02-07 07:27:28\",\n \"fullName\": \"Bhai Rahul\",\n \"firstName\": \"Rahul\",\n \"lastName\": \"Bhai\",\n \"userEmail\": \"rahul.bhai@cztester.com\",\n \"phoneNumber\": \"\",\n \"companyName\": \"Bhai Rahul\",\n \"CustomerListID\": \"CUS-5691848-D01VWE\",\n \"ship_address1\": \"10 Street\",\n \"ship_address2\": \"\",\n \"ship_city\": \"Tucson\",\n \"ship_state\": \"AZ\",\n \"ship_country\": \"US\",\n \"ship_zipcode\": \"85023\",\n \"address1\": \"10 Street\",\n \"address2\": \"\",\n \"City\": \"Tucson\",\n \"State\": \"AZ\",\n \"Country\": \"US\",\n \"zipCode\": \"85023\",\n \"invoiceItem\": [\n {\n \"itemDescription\": \" aaa \",\n \"itemQty\": \"1\",\n \"itemPrice\": \"505\",\n \"Name\": \"PP2\",\n \"itemTax\": \"0\"\n }\n ]\n }\n },\n \"message\": \"Payment Successful\",\n \"code\": 200\n}"},{"id":"0cd1336d-772a-4d46-b1de-cab66f9ca3fb","name":"Successful Payment - New ACH Details","originalRequest":{"method":"POST","header":[{"description":"required","key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"invoiceId","value":"INV-2505848-Z9YEK4","description":"required","type":"text"},{"key":"gatewayId","value":"303","description":"required, Gateway Identification Key","type":"text"},{"key":"payAmount","value":"5.00","description":"requred","type":"text"},{"key":"paymentMethod","value":"2","description":"required (Put the value )","type":"text"},{"key":"cardId","value":"new1","description":"required (Put the value for existing card and new1 option for new card)","type":"text"},{"key":"eaccountName","value":"John Doe","description":"required (if paymentMethod is 2)","type":"text"},{"key":"eaccountNumber","value":"123123123","description":"required (if paymentMethod is 2)","type":"text"},{"key":"erouteNumber","value":"123123123","description":"required (if paymentMethod is 2)","type":"text"},{"key":"eaccountType","value":"checking","description":"Value: checking/saving","type":"text"},{"key":"eaccountHolderType","value":"business","description":"Value: business/personal","type":"text"},{"key":"bAddress1","value":"87026","type":"text"},{"key":"bAddress2","value":"US","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"TX","type":"text"},{"key":"bCountry","value":"United States","type":"text"},{"key":"bPhone","value":"8745859654","type":"text"},{"key":"bZipcode","value":"54781","type":"text"},{"key":"customerContact","value":"","description":"Customer Contact Number (Optional)","type":"text"}]},"url":"{{v2-url}}/invoice/process_payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Mar 2022 11:04:39 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"847"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"transactionID\": \"7068402749\",\n \"invoiceData\": {\n \"invoiceID\": \"INV-2505848-Z9YEK4\",\n \"refNumber\": \"CZs10095\",\n \"BalanceRemaining\": \"395.00\",\n \"DueDate\": \"2022-02-22\",\n \"IsPaid\": \"false\",\n \"AppliedAmount\": \"-110.00\",\n \"taxID\": \"1\",\n \"totalTax\": \"40.40\",\n \"taxRate\": \"8.00\",\n \"TimeCreated\": \"2022-02-07 07:27:28\",\n \"fullName\": \"Bhai Rahul\",\n \"firstName\": \"Rahul\",\n \"lastName\": \"Bhai\",\n \"userEmail\": \"rahul.bhai@cztester.com\",\n \"phoneNumber\": \"\",\n \"companyName\": \"Bhai Rahul\",\n \"CustomerListID\": \"CUS-5691848-D01VWE\",\n \"ship_address1\": \"10 Street\",\n \"ship_address2\": \"\",\n \"ship_city\": \"Tucson\",\n \"ship_state\": \"AZ\",\n \"ship_country\": \"US\",\n \"ship_zipcode\": \"85023\",\n \"address1\": \"10 Street\",\n \"address2\": \"\",\n \"City\": \"Tucson\",\n \"State\": \"AZ\",\n \"Country\": \"US\",\n \"zipCode\": \"85023\",\n \"invoiceItem\": [\n {\n \"itemDescription\": \" aaa \",\n \"itemQty\": \"1\",\n \"itemPrice\": \"505\",\n \"Name\": \"PP2\",\n \"itemTax\": \"0\"\n }\n ]\n }\n },\n \"message\": \"Payment Successful\",\n \"code\": 200\n}"},{"id":"f8f1e508-33cf-4d9b-b120-d646334ad532","name":"Successful Payment - Existing Details Card/ACH","originalRequest":{"method":"POST","header":[{"description":"required","key":"secretKey","value":"{{v2-secretKey}}"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"invoiceId","value":"INV-2505848-Z9YEK4","description":"required","type":"text"},{"key":"gatewayId","value":"303","description":"required, Gateway Identification Key","type":"text"},{"key":"payAmount","value":"5.00","description":"requred","type":"text"},{"key":"paymentMethod","value":"1","description":"required (Put the value )","type":"text"},{"key":"cardId","value":"1071","description":"required (Put the value for existing card and new1 option for new card)","type":"text"}]},"url":"{{v2-url}}/invoice/process_payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Mar 2022 10:55:03 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"846"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"transactionID\": \"7068393203\",\n \"invoiceData\": {\n \"invoiceID\": \"INV-2505848-Z9YEK4\",\n \"refNumber\": \"CZs10095\",\n \"BalanceRemaining\": \"415.00\",\n \"DueDate\": \"2022-02-22\",\n \"IsPaid\": \"false\",\n \"AppliedAmount\": \"-90.00\",\n \"taxID\": \"1\",\n \"totalTax\": \"40.40\",\n \"taxRate\": \"8.00\",\n \"TimeCreated\": \"2022-02-07 07:27:28\",\n \"fullName\": \"Bhai Rahul\",\n \"firstName\": \"Rahul\",\n \"lastName\": \"Bhai\",\n \"userEmail\": \"rahul.bhai@cztester.com\",\n \"phoneNumber\": \"\",\n \"companyName\": \"Bhai Rahul\",\n \"CustomerListID\": \"CUS-5691848-D01VWE\",\n \"ship_address1\": \"10 Street\",\n \"ship_address2\": \"\",\n \"ship_city\": \"Tucson\",\n \"ship_state\": \"AZ\",\n \"ship_country\": \"US\",\n \"ship_zipcode\": \"85023\",\n \"address1\": \"10 Street\",\n \"address2\": \"\",\n \"City\": \"Tucson\",\n \"State\": \"AZ\",\n \"Country\": \"US\",\n \"zipCode\": \"85023\",\n \"invoiceItem\": [\n {\n \"itemDescription\": \" aaa \",\n \"itemQty\": \"1\",\n \"itemPrice\": \"505\",\n \"Name\": \"PP2\",\n \"itemTax\": \"0\"\n }\n ]\n }\n },\n \"message\": \"Payment Successful\",\n \"code\": 200\n}"}],"_postman_id":"fb4adf4d-c69a-400e-b138-1e5fe974609b"},{"name":"Invoice Detail","id":"73094caf-4f4d-40f3-bb29-f8746e3a6ce6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/invoice/","description":"

Retrieve invoice details.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["invoice",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"3e522042-d2c3-4b1e-8617-b5879d49e57b","name":"Invoice Detail","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"","type":"text"},{"key":"token","value":"","type":"text"}],"url":"{{v2-url}}/invoice/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Mar 2022 09:01:58 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"841"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invoiceId\": \"392\",\n \"invoiceRefrence\": \"1042\",\n \"invoiceDueDate\": \"2022-02-03\",\n \"invoiceBalance\": \"50.00\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"57.28\",\n \"invoiceTimeCreated\": \"2022-01-03 22:08:25\",\n \"invoiceTaxData\": [\n {\n \"taxId\": \"3\",\n \"taxRate\": \"9.10\",\n \"totalTax\": \"4.78\",\n \"taxName\": \"Tucson Tax\"\n }\n ],\n \"transactionData\": [\n {\n \"tnxID\": \"7068615289\",\n \"tnxAmount\": \"1.50\",\n \"tnxDate\": \"2022-03-17 06:59:29\",\n \"tnxStatus\": \"SUCCESS\",\n \"tnxCustomerId\": \"1\",\n \"tnxType\": \"sale\",\n \"tnxGatewayId\": \"155\",\n \"tnxCode\": \"100\",\n \"tnxPaymentMethod\": 1,\n \"tnxCustomDataFields\": {\n \"payment_type\": \" - \"\n },\n \"tnxReferenceMemo\": \"\",\n \"tnxUserStatus\": \"1\"\n },\n {\n \"tnxID\": \"7068617911\",\n \"tnxAmount\": \"5.78\",\n \"tnxDate\": \"2022-03-17 07:00:49\",\n \"tnxStatus\": \"SUCCESS\",\n \"tnxCustomerId\": \"1\",\n \"tnxType\": \"sale\",\n \"tnxGatewayId\": \"155\",\n \"tnxCode\": \"100\",\n \"tnxPaymentMethod\": 1,\n \"tnxCustomDataFields\": {\n \"payment_type\": \" - \"\n },\n \"tnxReferenceMemo\": \"\",\n \"tnxUserStatus\": \"1\"\n }\n ],\n \"invoiceItem\": [\n {\n \"itemLineID\": \"17834\",\n \"itemID\": \"1\",\n \"itemRefID\": \"19\",\n \"itemtotalAmount\": \"52.50\",\n \"itemQty\": \"1\",\n \"itemDescription\": null,\n \"itemPrice\": \"52.50\",\n \"itemName\": \"Bitbucket Service\",\n \"itemTaxApplied\": \"1\"\n }\n ]\n },\n \"message\": \"Invoice Detail\",\n \"code\": 200\n}"}],"_postman_id":"73094caf-4f4d-40f3-bb29-f8746e3a6ce6"},{"name":"Void Invoice","id":"eb5d10e7-c9e7-4029-8316-406cbb883e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/invoice/void/","description":"

Void an invoice.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["invoice","void",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"14775f96-d2a6-4c32-ac5a-15e1912612f4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"","type":"text"},{"key":"token","value":"","type":"text"}],"url":"{{v2-url}}/invoice/void/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 Apr 2022 11:03:53 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"818"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice voided succcessfully\",\n \"data\": {\n \"invoiceId\": \"INV-4175968-89BEQ5\",\n \"invoiceStatus\": \"Voided\",\n \"invoiceRefrence\": \"CZs10100\",\n \"invoiceDueDate\": \"2022-04-12\",\n \"invoiceBalance\": \"67.00\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"67.00\",\n \"invoiceTimeCreated\": \"2022-04-07 03:35:14\",\n \"invoiceTaxData\": null,\n \"totalTax\": \"0.00\",\n \"invoiceItem\": [\n {\n \"itemLineID\": \"8930454\",\n \"itemID\": \"PRO-548121-2I7E9O\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"37.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"18.5\",\n \"itemName\": \"PP2\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"8834702\",\n \"itemID\": \"PRO-645336-L1PGJV\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15\",\n \"itemName\": \"Support Customer \",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n \"code\": 200\n}"}],"_postman_id":"eb5d10e7-c9e7-4029-8316-406cbb883e8d"},{"name":"List All Invoices","id":"683f43b6-af5c-4677-965b-8faa30dfa9da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/invoice/all","description":"

Retrieve list of invoices.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
page	Page count starting with 0	No	Int	0	-
limit	Limit count starting with 0	No	Int	100	-
includeItems	Include Items on list result	No	Int	[ 1 ]	[ 0,1 ]
customerId	Filter: customerId	No	String	-	-
search	Filter: Search Value	No	String	-	-
invoiceStatus	Filter: Search Invoice Depends on their status	No	String	-	-

","urlObject":{"path":["invoice","all"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"01d09f97-e7b7-4649-b480-0deb7e73b70b","name":"Success - Include Items","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"","type":"text"},{"key":"token","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"includeItems","value":"1","type":"text"}]},"url":"{{v2-url}}/invoice/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 Apr 2022 11:04:59 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice List\",\n \"data\": [\n {\n \"invoiceId\": \"INV-3497242-FW6XVN\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZ10001\",\n \"invoiceDueDate\": \"2020-02-22\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-01-23 00:07:05\",\n \"invoiceTaxData\": null,\n \"totalTax\": null,\n \"invoiceItem\": [\n {\n \"itemLineID\": \"8963794\",\n \"itemID\": \"PRO-645336-L1PGJV\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"1,250.00\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"Customer Support\",\n \"itemPrice\": \"1250\",\n \"itemName\": \"Support Customer \",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n {\n \"invoiceId\": \"INV-3063902-V4PLDY\",\n \"customerId\": \"CUST-8577-PSW\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZ10002\",\n \"invoiceDueDate\": \"2020-02-11\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.50\",\n \"invoiceTotal\": \"1,250.50\",\n \"invoiceTimeCreated\": \"2020-02-11 03:02:26\",\n \"invoiceTaxData\": null,\n \"totalTax\": null,\n \"invoiceItem\": [\n {\n \"itemLineID\": \"8307970\",\n \"itemID\": \"PRO-858856-BOCNSI\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"0.00\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"PP3\",\n \"itemPrice\": \"0\",\n \"itemName\": \"PP3\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"8847325\",\n \"itemID\": \"PRO-645336-L1PGJV\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"1,250.00\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"Customer Support\",\n \"itemPrice\": \"1250\",\n \"itemName\": \"Support Customer \",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"8107711\",\n \"itemID\": \"PRO-548121-2I7E9O\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"0.50\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"PP2\",\n \"itemPrice\": \"0.5\",\n \"itemName\": \"PP2\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"5206504\",\n \"itemID\": \"PRO-855327-G24LX3\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"0.00\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"Something\",\n \"itemPrice\": \"0\",\n \"itemName\": \"Something\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n {\n \"invoiceId\": \"INV-4747957-W7TE3R\",\n \"customerId\": \"CUST-1427-NASA\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZ10003\",\n \"invoiceDueDate\": \"2020-02-11\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.50\",\n \"invoiceTotal\": \"1,250.50\",\n \"invoiceTimeCreated\": \"2020-02-11 03:03:16\",\n \"invoiceTaxData\": null,\n \"totalTax\": null,\n \"invoiceItem\": [\n {\n \"itemLineID\": \"7253795\",\n \"itemID\": \"PRO-858856-BOCNSI\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"0.00\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"PP3\",\n \"itemPrice\": \"0\",\n \"itemName\": \"PP3\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"7552402\",\n \"itemID\": \"PRO-645336-L1PGJV\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"1,250.00\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"Customer Support\",\n \"itemPrice\": \"1250\",\n \"itemName\": \"Support Customer \",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"5037685\",\n \"itemID\": \"PRO-548121-2I7E9O\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"0.50\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"PP2\",\n \"itemPrice\": \"0.5\",\n \"itemName\": \"PP2\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"7870625\",\n \"itemID\": \"PRO-855327-G24LX3\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"0.00\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"Something\",\n \"itemPrice\": \"0\",\n \"itemName\": \"Something\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n {\n \"invoiceId\": \"INV-3064655-P8IAJL\",\n \"customerId\": \"CUST-3744-FNAS\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZ10007\",\n \"invoiceDueDate\": \"2020-03-16\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.50\",\n \"invoiceTotal\": \"1,250.50\",\n \"invoiceTimeCreated\": \"2020-03-16 04:15:16\",\n \"invoiceTaxData\": null,\n \"totalTax\": null,\n \"invoiceItem\": [\n {\n \"itemLineID\": \"6422972\",\n \"itemID\": \"PRO-645336-L1PGJV\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"1,250.00\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"Customer Support\",\n \"itemPrice\": \"1250\",\n \"itemName\": \"Support Customer \",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"6989372\",\n \"itemID\": \"PRO-548121-2I7E9O\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"0.50\",\n \"itemQty\": \"1\",\n \"itemDescription\": \" aaa\",\n \"itemPrice\": \"0.5\",\n \"itemName\": \"PP2\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n }\n ],\n \"code\": 200\n}"},{"id":"15925d92-e58b-412c-99fc-e2f28c5ccf2f","name":"Success - Page/Limit","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"includeItems","value":"0","type":"text"},{"key":"page","value":"1","type":"text"},{"key":"limit","value":"10","type":"text"}]},"url":"{{v2-url}}/invoice/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 Apr 2022 11:05:55 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"2863"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice List\",\n \"data\": [\n {\n \"invoiceId\": \"INV-4514891-DJRYFO\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZ10014\",\n \"invoiceDueDate\": \"2020-08-24\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-24 05:26:45\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n },\n {\n \"invoiceId\": \"INV-3658195-NMYB0F\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZ10015\",\n \"invoiceDueDate\": \"2020-08-27\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-27 03:59:33\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n },\n {\n \"invoiceId\": \"INV-3693409-0MW1YZ\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZ10016\",\n \"invoiceDueDate\": \"2020-08-27\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-27 04:32:17\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n },\n {\n \"invoiceId\": \"INV-2955357-EX8LST\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZs10017\",\n \"invoiceDueDate\": \"2020-08-27\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-27 04:55:34\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n },\n {\n \"invoiceId\": \"INV-2117023-7ZSL9B\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZs10018\",\n \"invoiceDueDate\": \"2020-08-27\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-27 05:06:10\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n },\n {\n \"invoiceId\": \"INV-4975923-KG2BZT\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZs10019\",\n \"invoiceDueDate\": \"2020-08-27\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-27 05:11:58\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n },\n {\n \"invoiceId\": \"INV-4722954-1TDL3Z\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZs10020\",\n \"invoiceDueDate\": \"2020-08-27\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-27 05:20:36\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n },\n {\n \"invoiceId\": \"INV-4339238-HZP1AS\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZs10021\",\n \"invoiceDueDate\": \"2020-08-27\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-27 05:32:37\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n },\n {\n \"invoiceId\": \"INV-4085683-Q4ZO2D\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZs10022\",\n \"invoiceDueDate\": \"2020-08-27\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-27 05:35:39\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n },\n {\n \"invoiceId\": \"INV-2241555-N49CM3\",\n \"customerId\": \"CUST-3497-FWVN\",\n \"invoiceStatus\": \"Paid\",\n \"invoiceRefrence\": \"CZs10023\",\n \"invoiceDueDate\": \"2020-08-27\",\n \"invoiceBalance\": \"0.00\",\n \"invoiceAppliedAmount\": \"1,250.00\",\n \"invoiceTotal\": \"1,250.00\",\n \"invoiceTimeCreated\": \"2020-08-27 05:44:45\",\n \"invoiceTaxData\": null,\n \"totalTax\": null\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"683f43b6-af5c-4677-965b-8faa30dfa9da"},{"name":"Create Invoice","id":"7626a226-48cd-4d54-8c46-239ee43727dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/invoice/create","description":"

Create an invoice.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Key	Description	Required	Type	Default Value	Restricted Values
customerId	customerId	Yes	String	-	-
invoicePaytermDays	invoice Payterm Days	Yes	integer	-	-
invoiceDate	invoice Date	Yes	String	-	-
invoiceLineItem	Item Data	Yes	Array	-	-
bAddress1	Customer Business Address Line1	No	String	-	-
bAddress2	Customer Business Address Line2	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
sAddress1	Customer Shipping Address Line 1	No	String	-	-
sAddress2	Customer Shipping Address Line 2	No	String	-	-
sCity	Customer Shipping Address City	No	String	-	-
sState	Customer Shipping Address State/Province	No	String	-	-
sCountry	Customer Shipping Address Country	No	String	-	-
sZipcode	Customer Shipping Address ZipCode	No	String	-	-

","urlObject":{"path":["invoice","create"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"df05bda3-da80-4d4e-9bbb-a4818b082a8d","name":"Success - Xero Create Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"","type":"text"},{"key":"token","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerId","value":"43919195-061e-4ec9-9b65-74b636550704","type":"text"},{"key":"invoicePaytermDays","value":"30","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"375ec432-3fef-4949-ae8f-f1e8c5420630\",\"itemRate\":18.5,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":\"NONE\"},{\"itemListID\":\"edc0ce06-8794-4eee-8f6f-100f02b8a3b1\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":\"NONE\"}]","type":"text"},{"key":"taxType","value":"1","description":"0 - No Tax\n1 - Exclusive\n2 - Inclusive","type":"text"}]},"url":"{{v2-url}}/invoice/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 07:42:53 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"1112"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice created succcessfully\",\n \"data\": {\n \"invoiceId\": \"23d183ad-73b5-4662-a7d4-fed3ce93d5f4\",\n \"invoiceStatus\": \"Open\",\n \"invoiceRefrence\": \"CHZ10005\",\n \"invoiceDueDate\": \"2022-05-06\",\n \"invoiceBalance\": \"67.00\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"67.00\",\n \"invoiceTimeCreated\": \"2022-04-05 19:00:00\",\n \"invoiceTaxData\": [\n {\n \"taxId\": \"TAX001\",\n \"taxRate\": \"5.00\",\n \"taxName\": \"\"\n },\n {\n \"taxId\": \"GSTONIMPORTS\",\n \"taxRate\": \"0.00\",\n \"taxName\": \"\"\n },\n {\n \"taxId\": \"NONE\",\n \"taxRate\": \"0.00\",\n \"taxName\": \"\"\n },\n {\n \"taxId\": \"INPUT\",\n \"taxRate\": \"0.00\",\n \"taxName\": \"\"\n },\n {\n \"taxId\": \"OUTPUT\",\n \"taxRate\": \"0.00\",\n \"taxName\": \"\"\n }\n ],\n \"totalTax\": \"0.00\",\n \"transactionData\": null,\n \"invoiceItem\": [\n {\n \"itemLineID\": \"3594\",\n \"itemID\": \"fd048bc9-9fd0-44cf-b17c-ff02f8dcac0b\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15.00\",\n \"itemName\": \"PRO-2\",\n \"itemTaxApplied\": null,\n \"itemTaxType\": \"NONE\"\n },\n {\n \"itemLineID\": \"3593\",\n \"itemID\": \"5a7fe71a-4767-4d8e-95cf-7db7412f1a74\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"37.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"18.50\",\n \"itemName\": \"PRO1\",\n \"itemTaxApplied\": null,\n \"itemTaxType\": \"NONE\"\n }\n ]\n },\n \"code\": 200\n}"},{"id":"14d1399f-c10c-4169-a822-bb3e3847ddb8","name":"Success - QBO Create Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerId","value":"{{v2-customerId}}","type":"text"},{"key":"invoicePaytermDays","value":"0","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"4\",\"itemRate\":18.5,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":0},{\"itemListID\":\"3\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":0}]","type":"text"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"}]},"url":"{{v2-url}}/invoice/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 07:42:53 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"1112"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice created succcessfully\",\n \"data\": {\n \"invoiceId\": \"435\",\n \"invoiceStatus\": \"Open\",\n \"invoiceRefrence\": \"CZU10021\",\n \"invoiceDueDate\": \"2022-04-10\",\n \"invoiceBalance\": \"67.00\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"67.00\",\n \"invoiceTimeCreated\": \"2022-04-04 07:09:37\",\n \"invoiceTaxData\": null,\n \"totalTax\": \"0.00\",\n \"invoiceItem\": [\n {\n \"itemLineID\": \"17893\",\n \"itemID\": \"1\",\n \"itemRefID\": \"4\",\n \"itemtotalAmount\": \"37.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"18.50\",\n \"itemName\": \"Design\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"17894\",\n \"itemID\": \"2\",\n \"itemRefID\": \"3\",\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15.00\",\n \"itemName\": \"Concrete\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n \"code\": 200\n}"},{"id":"423daae3-2cf7-43d3-bb37-499d60acc917","name":"Success - FreshBooks Create Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerId","value":"296874","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"23023078\",\"itemRate\":18.5,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":[13981]},{\"itemListID\":\"23023078\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":[]}]","type":"text"},{"key":"invoicePaytermDays","value":"30","type":"text"},{"key":"bAddress1","value":"10 Street","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"Tucson","type":"text"},{"key":"bState","value":"CA","type":"text"},{"key":"bCountry","value":"USA","type":"text"},{"key":"bZipcode","value":"85023","type":"text"}]},"url":"{{v2-url}}/invoice/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 11:29:24 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"857"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice details saved succcessfully\",\n \"data\": {\n \"invoiceId\": \"267266\",\n \"invoiceStatus\": \"Open\",\n \"invoiceRefrence\": \"CHZ10029\",\n \"invoiceDueDate\": \"2022-05-10\",\n \"invoiceBalance\": \"68.85\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"68.85\",\n \"invoiceTimeCreated\": \"2022-04-06 00:29:29\",\n \"invoiceTaxData\": null,\n \"totalTax\": \"0.00\",\n \"invoiceItem\": [\n {\n \"itemLineID\": \"11533\",\n \"itemID\": \"1\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"37.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"18.50\",\n \"itemName\": \"S-1001\",\n \"itemTaxApplied\": null,\n \"itemTaxType\": null,\n \"itemLineTaxFreshbook\": [\n {\n \"taxName\": \"CGST\",\n \"taxRate\": \"5\"\n }\n ]\n },\n {\n \"itemLineID\": \"11534\",\n \"itemID\": \"2\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15.00\",\n \"itemName\": \"S-1001\",\n \"itemTaxApplied\": null,\n \"itemTaxType\": null,\n \"itemLineTaxFreshbook\": []\n }\n ]\n },\n \"code\": 200\n}"},{"id":"151e8597-4ab3-4571-93b6-7cbe2c47e8ae","name":"Success - QBD Create Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerId","value":"80000004-1607967052","type":"text"},{"key":"invoicePaytermDays","value":"0","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"80000005-1607967136\",\"itemRate\":18.5,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":0},{\"itemListID\":\"80000007-1607967136\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":0}]","type":"text"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"}]},"url":"{{v2-url}}/invoice/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 16:05:50 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"846"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice details saved succcessfully\",\n \"data\": {\n \"invoiceId\": \"442536\",\n \"invoiceStatus\": \"Voided\",\n \"invoiceRefrence\": \"CZU-10079\",\n \"invoiceDueDate\": \"2022-04-06\",\n \"invoiceBalance\": \"67.00\",\n \"invoiceAppliedAmount\": 0,\n \"invoiceTotal\": 67,\n \"invoiceTimeCreated\": \"2022-04-06 09:05:51\",\n \"invoiceTaxData\": null,\n \"totalTax\": \"0\",\n \"invoiceItem\": [\n {\n \"itemLineID\": \"6209338\",\n \"itemID\": \"80000005-1607967136\",\n \"itemRefID\": \"1607967136\",\n \"itemtotalAmount\": \"37.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"18.5\",\n \"itemName\": \"Radiant Translucent Powder\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"7061303\",\n \"itemID\": \"80000007-1607967136\",\n \"itemRefID\": \"1607967136\",\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15\",\n \"itemName\": \"Silken Shadow Stick\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n \"code\": 200\n}"},{"id":"b49a7856-5d73-4c1e-b5ac-946a36845510","name":"Success - NAP Create Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerId","value":"CUS-7765504-ZDWRJ2","type":"text"},{"key":"invoicePaytermDays","value":"5","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"PRO-548121-2I7E9O\",\"itemRate\":18.5,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":0},{\"itemListID\":\"PRO-645336-L1PGJV\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":0}]","type":"text"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"}]},"url":"{{v2-url}}/invoice/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 05:20:04 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"811"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice details saved succcessfully\",\n \"data\": {\n \"invoiceId\": \"810946\",\n \"invoiceStatus\": \"Open\",\n \"invoiceRefrence\": \"CZs10097\",\n \"invoiceDueDate\": \"2022-04-12\",\n \"invoiceBalance\": \"67.00\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"67.00\",\n \"invoiceTimeCreated\": \"2022-04-07 00:20:04\",\n \"invoiceTaxData\": null,\n \"totalTax\": \"0.00\",\n \"invoiceItem\": [\n {\n \"itemLineID\": \"5977798\",\n \"itemID\": \"PRO-548121-2I7E9O\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"37.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"18.5\",\n \"itemName\": \"PP2\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"8656243\",\n \"itemID\": \"PRO-645336-L1PGJV\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15\",\n \"itemName\": \"Support Customer \",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n \"code\": 200\n}"}],"_postman_id":"7626a226-48cd-4d54-8c46-239ee43727dc"},{"name":"Update Invoice","id":"a9a3bdaf-bf9f-42d3-8878-d3d14094b59c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/invoice/update","description":"

Update an invoice.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Key	Description	Required	Type	Default Value	Restricted Values
invoiceId	invoiceId	Yes	String	-	-
customerId	customerId	Yes	String	-	-
invoicePaytermDays	invoice Payterm Days	Yes	Int	-	-
invoiceDate	invoice Date	Yes	String	-	-
invoiceLineItem	Item Data	Yes	Array	-	-
bAddress1	Customer Business Address Line1	No	String	-	-
bAddress2	Customer Business Address Line2	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
sAddress1	Customer Shipping Address Line 1	No	String	-	-
sAddress2	Customer Shipping Address Line 2	No	String	-	-
sCity	Customer Shipping Address City	No	String	-	-
sState	Customer Shipping Address State/Province	No	String	-	-
sCountry	Customer Shipping Address Country	No	String	-	-
sZipcode	Customer Shipping Address ZipCode	No	String	-	-

","urlObject":{"path":["invoice","update"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"b2dea903-4ac4-4f4a-baf2-48cbbca43589","name":"Success - Xero Update Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"invoiceId","value":"23d183ad-73b5-4662-a7d4-fed3ce93d5f4","type":"text"},{"key":"customerId","value":"43919195-061e-4ec9-9b65-74b636550704","type":"text"},{"key":"invoicePaytermDays","value":"30","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"375ec432-3fef-4949-ae8f-f1e8c5420630\",\"itemRate\":1.5,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":\"NONE\"},{\"itemListID\":\"edc0ce06-8794-4eee-8f6f-100f02b8a3b1\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":\"NONE\"}]","description":"0 - No Tax\n1 - Exclusive\n2 - Inclusive","type":"text"},{"key":"taxType","value":"1","type":"text"}]},"url":"{{v2-url}}/invoice/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 07:42:53 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"1112"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice created succcessfully\",\n \"data\": {\n \"invoiceId\": \"23d183ad-73b5-4662-a7d4-fed3ce93d5f4\",\n \"invoiceStatus\": \"Open\",\n \"invoiceRefrence\": \"CHZ10005\",\n \"invoiceDueDate\": \"2022-05-06\",\n \"invoiceBalance\": \"67.00\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"67.00\",\n \"invoiceTimeCreated\": \"2022-04-05 19:00:00\",\n \"invoiceTaxData\": [\n {\n \"taxId\": \"TAX001\",\n \"taxRate\": \"5.00\",\n \"taxName\": \"\"\n },\n {\n \"taxId\": \"GSTONIMPORTS\",\n \"taxRate\": \"0.00\",\n \"taxName\": \"\"\n },\n {\n \"taxId\": \"NONE\",\n \"taxRate\": \"0.00\",\n \"taxName\": \"\"\n },\n {\n \"taxId\": \"INPUT\",\n \"taxRate\": \"0.00\",\n \"taxName\": \"\"\n },\n {\n \"taxId\": \"OUTPUT\",\n \"taxRate\": \"0.00\",\n \"taxName\": \"\"\n }\n ],\n \"totalTax\": \"0.00\",\n \"transactionData\": null,\n \"invoiceItem\": [\n {\n \"itemLineID\": \"3594\",\n \"itemID\": \"fd048bc9-9fd0-44cf-b17c-ff02f8dcac0b\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15.00\",\n \"itemName\": \"PRO-2\",\n \"itemTaxApplied\": null,\n \"itemTaxType\": \"NONE\"\n },\n {\n \"itemLineID\": \"3593\",\n \"itemID\": \"5a7fe71a-4767-4d8e-95cf-7db7412f1a74\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"37.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"18.50\",\n \"itemName\": \"PRO1\",\n \"itemTaxApplied\": null,\n \"itemTaxType\": \"NONE\"\n }\n ]\n },\n \"code\": 200\n}"},{"id":"ce1ff2f6-3921-47f0-9fee-31cac2eb200b","name":"Success - QBO Update Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"invoiceId","value":"435","type":"text"},{"key":"customerId","value":"{{v2-customerId}}","type":"text"},{"key":"invoicePaytermDays","value":"0","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"4\",\"itemRate\":8.5,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":0},{\"itemListID\":\"3\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":0}]","type":"text"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"}]},"url":"{{v2-url}}/invoice/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 07:42:53 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"1112"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice created succcessfully\",\n \"data\": {\n \"invoiceId\": \"435\",\n \"invoiceStatus\": \"Open\",\n \"invoiceRefrence\": \"CZU10021\",\n \"invoiceDueDate\": \"2022-04-10\",\n \"invoiceBalance\": \"67.00\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"67.00\",\n \"invoiceTimeCreated\": \"2022-04-04 07:09:37\",\n \"invoiceTaxData\": null,\n \"totalTax\": \"0.00\",\n \"invoiceItem\": [\n {\n \"itemLineID\": \"17893\",\n \"itemID\": \"1\",\n \"itemRefID\": \"4\",\n \"itemtotalAmount\": \"37.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"18.50\",\n \"itemName\": \"Design\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"17894\",\n \"itemID\": \"2\",\n \"itemRefID\": \"3\",\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15.00\",\n \"itemName\": \"Concrete\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n \"code\": 200\n}"},{"id":"77f37059-3038-4597-acd0-4f039c19e3c4","name":"Success - FreshBooks Create Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerId","value":"296874","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"23023078\",\"itemRate\":18.5,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":[13981]},{\"itemListID\":\"23023078\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":[]}]","type":"text"},{"key":"invoicePaytermDays","value":"30","type":"text"},{"key":"bAddress1","value":"10 Street","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"Tucson","type":"text"},{"key":"bState","value":"CA","type":"text"},{"key":"bCountry","value":"USA","type":"text"},{"key":"bZipcode","value":"85023","type":"text"}]},"url":"{{v2-url}}/invoice/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 11:29:24 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"857"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice details saved succcessfully\",\n \"data\": {\n \"invoiceId\": \"267266\",\n \"invoiceStatus\": \"Open\",\n \"invoiceRefrence\": \"CHZ10029\",\n \"invoiceDueDate\": \"2022-05-10\",\n \"invoiceBalance\": \"68.85\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"68.85\",\n \"invoiceTimeCreated\": \"2022-04-06 00:29:29\",\n \"invoiceTaxData\": null,\n \"totalTax\": \"0.00\",\n \"invoiceItem\": [\n {\n \"itemLineID\": \"11533\",\n \"itemID\": \"1\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"37.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"18.50\",\n \"itemName\": \"S-1001\",\n \"itemTaxApplied\": null,\n \"itemTaxType\": null,\n \"itemLineTaxFreshbook\": [\n {\n \"taxName\": \"CGST\",\n \"taxRate\": \"5\"\n }\n ]\n },\n {\n \"itemLineID\": \"11534\",\n \"itemID\": \"2\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15.00\",\n \"itemName\": \"S-1001\",\n \"itemTaxApplied\": null,\n \"itemTaxType\": null,\n \"itemLineTaxFreshbook\": []\n }\n ]\n },\n \"code\": 200\n}"},{"id":"03aeec60-4dc6-4602-aa14-3b9f149f6ede","name":"Success - QBD Update Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"invoiceId","value":"158388","type":"text"},{"key":"customerId","value":"80000004-1607967052","type":"text"},{"key":"invoicePaytermDays","value":"0","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"80000005-1607967136\",\"itemRate\":10.5,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":0},{\"itemListID\":\"80000007-1607967136\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":0}]","type":"text"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"}]},"url":"{{v2-url}}/invoice/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 16:05:50 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"846"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice details saved succcessfully\",\n \"data\": {\n \"invoiceId\": \"158388\",\n \"invoiceStatus\": \"Open\",\n \"invoiceRefrence\": \"CZU-10081\",\n \"invoiceDueDate\": \"2022-04-10\",\n \"invoiceBalance\": \"51.00\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"51.00\",\n \"invoiceTimeCreated\": \"2022-04-10 02:32:55\",\n \"invoiceTaxData\": null,\n \"totalTax\": \"0\",\n \"invoiceItem\": [\n {\n \"itemLineID\": \"5206382\",\n \"itemID\": \"80000007-1607967136\",\n \"itemRefID\": \"1607967136\",\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15\",\n \"itemName\": \"Silken Shadow Stick\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"7555010\",\n \"itemID\": \"80000005-1607967136\",\n \"itemRefID\": \"1607967136\",\n \"itemtotalAmount\": \"21.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"10.5\",\n \"itemName\": \"Radiant Translucent Powder\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n \"code\": 200\n}"},{"id":"903538aa-4311-4e7f-b29e-277befccf43a","name":"Success - NAP Update Invoice","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"invoiceId","value":"810946","type":"text"},{"key":"customerId","value":"CUS-7765504-ZDWRJ2","type":"text"},{"key":"invoicePaytermDays","value":"5","type":"text"},{"key":"invoiceDate","value":"2022-04-10","type":"text"},{"key":"invoiceLineItem","value":"[{\"itemListID\":\"PRO-548121-2I7E9O\",\"itemRate\":5.75,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item\",\"itemTax\":0},{\"itemListID\":\"PRO-645336-L1PGJV\",\"itemRate\":15,\"itemQuantity\":2,\"itemDescription\":\"API Invoice Item-2\",\"itemTax\":0}]","type":"text"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"sAddress1","value":"","type":"text"},{"key":"sAddress2","value":"","type":"text"},{"key":"sCity","value":"","type":"text"},{"key":"sState","value":"","type":"text"},{"key":"sCountry","value":"","type":"text"},{"key":"sZipcode","value":"","type":"text"}]},"url":"{{v2-url}}/invoice/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 05:20:04 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"811"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice details saved succcessfully\",\n \"data\": {\n \"invoiceId\": \"810946\",\n \"invoiceStatus\": \"Open\",\n \"invoiceRefrence\": \"CZs10097\",\n \"invoiceDueDate\": \"2022-04-15\",\n \"invoiceBalance\": \"41.50\",\n \"invoiceAppliedAmount\": \"0.00\",\n \"invoiceTotal\": \"41.50\",\n \"invoiceTimeCreated\": \"2022-04-10 04:02:35\",\n \"invoiceTaxData\": null,\n \"totalTax\": \"0.00\",\n \"invoiceItem\": [\n {\n \"itemLineID\": \"8574609\",\n \"itemID\": \"PRO-645336-L1PGJV\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"30.00\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item-2\",\n \"itemPrice\": \"15\",\n \"itemName\": \"Support Customer \",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n },\n {\n \"itemLineID\": \"6907781\",\n \"itemID\": \"PRO-548121-2I7E9O\",\n \"itemRefID\": null,\n \"itemtotalAmount\": \"11.50\",\n \"itemQty\": \"2\",\n \"itemDescription\": \"API Invoice Item\",\n \"itemPrice\": \"5.75\",\n \"itemName\": \"PP2\",\n \"itemTaxApplied\": \"0\",\n \"itemTaxType\": null\n }\n ]\n },\n \"code\": 200\n}"}],"_postman_id":"a9a3bdaf-bf9f-42d3-8878-d3d14094b59c"}],"id":"c654b5b9-84e6-413d-8a05-b2658be78a7a","_postman_id":"c654b5b9-84e6-413d-8a05-b2658be78a7a","description":""},{"name":"Payments","item":[{"name":"Create Sale Transaction","id":"0e54aacb-d406-46d2-8d53-5c0e6c295d1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/payments/sale","description":"

Create a sale transaction authorizing a payment.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Key	Description	Required	Type	Default Value	Restricted Values
customerId	customerId	Yes	String	-	-
paymentMethod	Payment Method Type ( 1 for Credit Card & 2 for ACH)	Yes	integer	-	[1,2]
cardId	Card unique identifier	Yes	String	new1	-
cardNumber	Card Number	Yes(if cardId not equal to \"new1\" and payment method equal to 1)	Int	-	-
cardCvv	Card CVV	Yes(if cardId not equal to \"new1\" and payment method equal to 1)	Int	-	-
expMonth	Card expire month	Yes(if cardId not equal to \"new1\" and payment method equal to 1)	Int	-	-
expYear	Card expire year	Yes(if cardId not equal to \"new1\" and payment method equal to 1)	Int	-	-
eaccountNumber	eCheck account number	Yes(if cardId not equal to \"new1\" and payment method equal to 2)	Int	-	-
erouteNumber	eCheck route number	Yes(if cardId not equal to \"new1\" and payment method equal to 2)	Int	-	-
eaccountName	eCheck account holder name	Yes(if cardId not equal to \"new1\" and payment method equal to 2)	String	-	-
eaccountType	eCheck account type	Yes(if cardId not equal to \"new1\" and payment method equal to 2)	String	-	-
eaccountHolderType	eChek account holder type	Yes(if cardId not equal to \"new1\" and payment method equal to 2)	String	-	-
payAmount	Amount to be paid	Yes	Float	-
bAddress	Customer Business Address Line	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
customerEmail	Customer Email	No	String	-	-
customerContact	Customer Contact	No	String	-	-
gatewayId	Gateway unique ID	Yes	Int	-	-
invoiceId	Invoice unique ID	No	String	-	-
poNumber	PO Number	No	Int	-	-
sendEmail	Send an email with transaction	No	Int	-	[0,1]
referenceMemo	Reference memo	No	String	-	-

","urlObject":{"path":["payments","sale"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"51733cdb-f5e6-4995-9416-d92259e3bbc1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerId","value":"{{v2-customerId}}","type":"text"},{"key":"paymentMethod","value":"","type":"text"},{"key":"cardId","value":"{{v2-cardId}}","type":"text"},{"key":"cardNumber","value":"","type":"text"},{"key":"cardCvv","value":"","type":"text"},{"key":"expMonth","value":"","type":"text"},{"key":"expYear","value":"","type":"text"},{"key":"eaccountNumber","value":"","type":"text"},{"key":"erouteNumber","value":"","type":"text"},{"key":"eaccountName","value":"","type":"text"},{"key":"eaccountType","value":"","type":"text"},{"key":"eaccountHolderType","value":"","type":"text"},{"key":"payAmount","value":"","type":"text"},{"key":"bAddress","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"customerEmail","value":"","type":"text"},{"key":"customerContact","value":"","type":"text"},{"key":"gatewayId","value":"{{v2-gatewayId}}","type":"text"},{"key":"invoiceId","value":"{{v2-invoiceID}}","type":"text"},{"key":"saveCard","value":"","type":"text"},{"key":"poNumber","value":"","type":"text"},{"key":"sendEmail","value":"","type":"text"},{"key":"referenceMemo","value":"","type":"text"}]},"url":"{{v2-url}}/payments/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 07:43:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"7406132281\",\n \"message\": \"Payment Successful\",\n \"code\": 200\n}"}],"_postman_id":"0e54aacb-d406-46d2-8d53-5c0e6c295d1d"},{"name":"Create Authorize Payment","id":"4171b645-efd8-403a-a334-65484dea7435","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/AuthSale/process_auth","description":"

Create authorization payment for a customer.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Key	Description	Required	Type	Default Value	Restricted Values
customerId	Customer unique identifier	Yes	String	-	-
cardId	Card unique identifier	Yes	String	-	-
cardNumber	Card number	Yes(if cardId not equal to \"new1\")	Int	-	-
cardCvv	Card CVV	Yes(if cardId not equal to \"new1\")	Int	-	-
expMonth	Card expire month	Yes(if cardId not equal to \"new1\")	Int	-	-
expYear	Card expire year	Yes(if cardId not equal to \"new1\")	Int	-	-
payAmount	Amount to be paid	Yes	Float	-	-
bAddress	Customer Business Address Line	No	String	-	-
bCity	Customer Business Address City	No	String	-	-
bState	Customer Business Address State/Province	No	String	-	-
bZipcode	Customer Business Address ZipCode	No	String	-	-
bCountry	Customer Business Address Country	No	String	-	-
customerEmail	Customer Email	No	String	-	-
customerContact	Customer Contact	No	String	-	-
gatewayId	Gateway unique identifier	Yes	Int	-	-
poNumber	PO Number	No	Int	-	-
sendEmail	Send an email to customer	No	Int	0	[1,0]
referenceMemo	Reference Memo	No	String	-	-

","urlObject":{"path":["AuthSale","process_auth"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"173ed142-2fa3-4e21-adf3-f6b1b44387ec","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"customerId","value":"{{v2-customerId}}","type":"text"},{"key":"cardId","value":"{{v2-cardId}}","type":"text"},{"key":"cardNumber","value":"","type":"text"},{"key":"cardCvv","value":"","type":"text"},{"key":"expMonth","value":"","type":"text"},{"key":"expYear","value":"","type":"text"},{"key":"payAmount","value":"","type":"text"},{"key":"bAddress","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"customerEmail","value":"","type":"text"},{"key":"customerContact","value":"","type":"text"},{"key":"gatewayId","value":"{{v2-gatewayId}}","type":"text"},{"key":"saveCard","value":"","type":"text"},{"key":"poNumber","value":"","type":"text"},{"key":"sendEmail","value":"","type":"text"}]},"url":"{{v2-url}}/AuthSale/process_auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 07:43:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"7406185193\",\n \"message\": \"Payment Successful\",\n \"code\": 200\n}"}],"_postman_id":"4171b645-efd8-403a-a334-65484dea7435"},{"name":"Create Auth Capture Transaction","id":"321df2f8-cd28-4ce3-a2d8-ed5d8f082da4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/payments/capture","description":"

Create a card authorization capture event transaction.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
transactionId	Transaction unique identifier	Yes	String	-	-
invoiceId	Invoice unique identifier	No	String	-	-
payAmount	Amount to be paid	Yes(if invoiceId has value)	Float	-	-
sendEmail	Email to be sent to customer	No	Int	0	[1,0]

","urlObject":{"path":["payments","capture"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"cde89221-db92-42b7-bab9-1c93213e765c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"transactionId","value":"","type":"text"},{"key":"invoiceId","value":"","type":"text"},{"key":"payAmount","value":"","type":"text"},{"key":"sendEmail","value":"","type":"text"}]},"url":"{{v2-url}}/payments/capture"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 08:47:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"7406185193\",\n \"message\": \"Payment Successful\",\n \"code\": 200\n}"}],"_postman_id":"321df2f8-cd28-4ce3-a2d8-ed5d8f082da4"},{"name":"Create Refund Transaction","id":"e6f1da6f-b62c-4aab-abc0-b2587b14c78c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/payments/refund","description":"

Create a refund.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
transactionId	Transaction unique identifier	Yes	String	-	-
invoiceRefundData	invoiceId and payAmount	No	Array	-	-
payAmount	Amount to be refunded	Yes(if invoiceRefundData column does not have value)	Float	-	-
sendEmail	Email to be sent to customer	No	Int	0	[1,0]

","urlObject":{"path":["payments","refund"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"a56c7962-6f17-40ca-be9c-c8da530bbf2c","name":"Transaction Refund","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"transactionId","value":"200028607652","type":"text"},{"key":"payAmount","value":"10","type":"text"},{"key":"sendEmail","value":"0","type":"text"}]},"url":"{{v2-url}}/payments/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 09:19:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"67"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"200028607652\",\n \"message\": \"Transaction Refunded\",\n \"code\": 200\n}"},{"id":"b867a44e-ff38-4673-b383-052ea2f08343","name":"Invoice Transaction Refund","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"transactionId","value":"200028607652","type":"text"},{"key":"invoiceRefundData","value":"[{\"invoiceId\":\"INV-4729343-ME84RW\", \"payAmount\":20}]","type":"text"},{"key":"payAmount","value":"1","type":"text","disabled":true},{"key":"sendEmail","value":"1","type":"text"}]},"url":"{{v2-url}}/payments/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 09:19:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"67"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"200028607652\",\n \"message\": \"Transaction Refunded\",\n \"code\": 200\n}"}],"_postman_id":"e6f1da6f-b62c-4aab-abc0-b2587b14c78c"},{"name":"Create Void Transaction","id":"a13b4673-d2c4-4762-a87b-a5d72615af64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/payments/void","description":"

Void a transaction.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
transactionId	Transaction unique identifier	Yes	String	-	-

","urlObject":{"path":["payments","void"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"14a9824c-25b4-44b9-ae11-de8e48392cb5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"transactionId","value":"7406185193","type":"text"}]},"url":"{{v2-url}}/payments/void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 09:25:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"7406185193\",\n \"message\": \"Transaction Voided\",\n \"code\": 200\n}"}],"_postman_id":"a13b4673-d2c4-4762-a87b-a5d72615af64"},{"name":"Get Transactions","id":"520963ea-40f4-4821-81fc-f0b3200d71dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/payments/list/transactions","description":"

Retrieve all transactions.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
page	Page Number (Starting - 0)	No	Int	-	-
limit	Listing Limit Count	No	Int	-	-
customerId	Customer unique identifier	No	String	-	-
transactionId	Transaction unique identifier	No	String	-	-
dateTo	Date To	No	String	-	-
dateFrom	Date From	No	String	-	-

","urlObject":{"path":["payments","list","transactions"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"cbb5cd30-ca26-4255-a187-4c09496df675","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"limit","value":"1","type":"text"}]},"url":"{{v2-url}}/payments/list/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 09:56:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"456"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"All transactions\",\n \"data\": [\n {\n \"tnxID\": \"200028623802\",\n \"tnxAmount\": \"20.00\",\n \"tnxDate\": \"2022-07-14 02:19:07\",\n \"tnxStatus\": \"Success\",\n \"tnxCustomerId\": \"CUS-7676728-NPIE2O\",\n \"tnxType\": \"refund\",\n \"tnxGateway\": \"Heartland\",\n \"tnxGatewayId\": \"642\",\n \"tnxCode\": \"200\",\n \"tnxUserStatus\": \"2\",\n \"tnxPaymentMethod\": \"1\",\n \"tnxCustomDataFields\": \"{\\\"payment_type\\\":\\\"Visa - 1111\\\"}\",\n \"tnxReferenceMemo\": null,\n \"tnxInvoiceId\": \"INV-4729343-ME84RW\",\n \"tnxInvoiceRef\": \"CHZ10305\"\n }\n ]\n}"}],"_postman_id":"520963ea-40f4-4821-81fc-f0b3200d71dc"}],"id":"09aff1b8-d9ad-476d-976f-d6836064be51","_postman_id":"09aff1b8-d9ad-476d-976f-d6836064be51","description":""},{"name":"Product & Services","item":[{"name":"Item Create","id":"cb19ce0f-ad63-45e0-9f79-9ade07c18922","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/products/create","description":"

Create a new product or item.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Each item type and merchant type has a unique request dataset. Refer to the sample request of available items:

QBO type and item type Inventory Request Parameters

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemSku	Item SKU	Yes	String	-	-
itemType	Item Type	Yes	String	-	-
itemSalePrice	Item sale price	Yes	Float	-	-
itemSaleDescription	Item sale description	Yes	String	-	-
itemPurchasePrice	Item purchase or list price.	Yes	Float	-	-
itemPurchaseDescription	Item purchase description	Yes	String	-	-
itemQuantity	Item quantity	No	Int	-	-
parentItemId	Parent Item Id	No	String	-	-
expenseAccountId	Item expense Account Id	No	Int	-	-
incomeAccountId	Item income Account Id	No	Int	-	-
inventoryAccountId	Item inventory Account Id	No	Int	-	-

QBO type and item type service Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemSku	Item SKU	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
itemPurchasePrice	Item purchase Price	Yes	Float	-	-
itemPurchaseDescription	Item purchase description	Yes	String	-	-
parentItemId	Parent Item Id	No	String	-	-
expenseAccountId	Item expense Account Id	No	Int	-	-
incomeAccountId	Item income Account Id	No	Int	-	-

QBD type and item type Service and NonInventory and OtherCharge Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
parentItemId	Parent Item Id	No	String	-	-
incomeAccountId	Item income Account Id	Yes	String	-	-

QBD type and item type Discount Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemDiscount	Item discount Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
parentItemId	Parent Item Id	No	String	-	-
incomeAccountId	Item income Account Id	Yes	String	-	-

QBD type and item type Payment or subTotal Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-

FreshBooks type and item type item Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
itemQuantity	Item quantity	Yes	Int	-	-
incomeAccountId	Item income Account Id	Yes	String	-	-
inventoryType	Item inventory Type	No	String	-	-
inventoryStock	Item inventory Stock	Yes(if you input the value inventoryType )	Int	-	-

FreshBooks type and item type Service Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-

XERO type Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
itemCode	Item code	Yes	String	-	-
itemAccountId	Item Account Id	Yes	String	-	-

NAP type and item type Service and Inventory and OtherCharge Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
parentItemId	Item parent Item Id	No	String	-	-

NAP type and item type discount Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemDiscount	Item discount Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
parentItemId	Item parent Item Id	No	String	-	-

NAP type and item type Payment and subTotal Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-

","urlObject":{"path":["products","create"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"326e865e-46b9-47db-bd31-343d08d248df","name":"REQUEST - QBO INVENTORY","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"","type":"text"},{"key":"token","value":"","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"ACER-ASPIRE-XU507U","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemSku","value":"ACER-ASPIRE-XU507U","description":"**SKU** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Inventory","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSalePrice","value":"10","description":"**Sale Price** || **float** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"Acer Aspire Series","description":"**Sale Description** || **String** || **Required**","type":"text"},{"key":"itemPurchasePrice","value":"8","description":"**Purchase Price** || **float** || **Required**","type":"text"},{"key":"itemPurchaseDescription","value":"","description":"**Purchase Description** || **String** || **Required**","type":"text"},{"key":"itemQuantity","value":"1","description":"**Item Quantity** || **int**","type":"text"},{"key":"parentItemId","value":"12","description":"**Parent Item id** || **int**","type":"text"},{"key":"expenseAccountId","value":"80","description":"**Expense Account Id** || **int**","type":"text"},{"key":"incomeAccountId","value":"79","description":"**Income Account Id** || **int**","type":"text"},{"key":"inventoryAccountId","value":"81","description":"**Inventory Account Id** || **int**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 12:58:03 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"91"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": 480030\n },\n \"data\": \"\",\n \"code\": 200\n}"},{"id":"cbb7882b-5292-4a89-80ee-10acb1e743a8","name":"REQUEST - QBO SERVICE","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"LAPTOP-REPAIR","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemSku","value":"LAPTOP-REPAIR","description":"**SKU** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Service","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSalePrice","value":"10","description":"**Sale Price** || **float** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"LAPTOP-REPAIR","description":"**Sale Description** || **String** || **Required**","type":"text"},{"key":"itemPurchasePrice","value":"8","description":"**Purchase Price** || **float** || **Required**","type":"text"},{"key":"itemPurchaseDescription","value":"LAPTOP-REPAIR","description":"**Purchase Description** || **String** || **Required**","type":"text"},{"key":"parentItemId","value":"10","description":"**Item Quantity** || **int**","type":"text"},{"key":"expenseAccountId","value":"80","description":"**Item id** || **int**","type":"text"},{"key":"incomeAccountId","value":"79","description":"**Expense Account Id** || **int**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 13:09:21 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"91"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": 543714\n },\n \"data\": \"\",\n \"code\": 200\n}"},{"id":"fcabe906-1f4b-4df1-81b0-f17682bd3320","name":"REQUEST - FRESHBOOKS ITEM","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"ACER-ASPIRE-XU507U","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Item","description":"**SKU** || **String** || **Required**","type":"text"},{"key":"itemSalePrice","value":"10","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"Acer Aspire Series","description":"**Sale Price** || **float** || **Required**","type":"text"},{"key":"itemQuantity","value":"1","description":"**Sale Description** || **String** || **Required**","type":"text"},{"key":"inventoryType","value":"Inventory","description":"**Purchase Price** || **float** || **Required**","type":"text"},{"key":"inventoryStock","value":"10","description":"**Purchase Description** || **String** || **Required**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 13:16:29 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"103"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": 352927,\n \"data\": true\n },\n \"data\": \"\",\n \"code\": 200\n}"},{"id":"d649d97f-0b15-4912-9c5a-50ff7389d46a","name":"REQUEST - FRESHBOOKS SERVICE","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"LAPTOP-REPAIR","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Service","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSalePrice","value":"10","description":"**Sale Price** || **float** || **Required**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 13:32:36 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"103"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": 352981,\n \"data\": true\n },\n \"data\": \"\",\n \"code\": 200\n}"},{"id":"ba5bb9f8-73a5-497b-9e5f-827767594207","name":"REQUEST - XERO ITEM","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"ACER-ASPIRE-XU507U","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemSalePrice","value":"10","description":"**Sale Price** || **float** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"Acer Aspire Series","description":"**Sale Description** || **String** || **Required**","type":"text"},{"key":"itemAccountId","value":"","description":"**Account Id** || **string**","type":"text"},{"key":"itemCode","value":"T-100018","description":"**Item Code** || **String** || **Required** || **Unique**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 13:48:11 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"99"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Product Created Successfully\",\n \"data\": \"b6c0c3a0-b8e9-4420-bb5c-19393aaf0eac\",\n \"code\": 200\n}"},{"id":"be490e4d-337b-474b-9fcb-758847ff6b65","name":"REQUEST - QBD NON-INVENTORY | SERVIC | OTHER CHARGE","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"LAPTOP-REPAIR","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Service","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSalePrice","value":"10","description":"**Sale Price** || **float** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"Acer Aspire Series","description":"**Sale Description** || **String** || **Required**","type":"text"},{"key":"itemAccountId","value":"80000003-1649078296","description":"**Item Account Id** || **String** || **Required**","type":"text"},{"key":"parentItemId","value":"0","description":"**Parent Item id** || **string**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 05:08:59 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"91"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": 334079\n },\n \"data\": \"\",\n \"code\": 200\n}"},{"id":"dfec5d25-f0aa-49cc-b45d-dab9a8296848","name":"REQUEST - QBD DISCOUNT","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"Christmas Sale","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Discount","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"Christmas Sale - 50%","description":"**Sale Description** || **String** || **Required**","type":"text"},{"key":"itemDiscount","value":"50","description":"**Discount Price** || **float** || **Required**","type":"text"},{"key":"itemAccountId","value":"80000003-1649078296","description":"**Account ID** || **String** || **Required**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 06:30:56 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"91"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": 325868\n },\n \"data\": \"\",\n \"code\": 200\n}"},{"id":"cd491ac3-6bbb-4a7f-9235-8a73e5d37c6e","name":"REQUEST - QBD ITEM - PAYMENT | SUBTOTAL","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"test item","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Payment","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"itemSaleDescription","description":"**Sale Description** || **String** || **Required**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 06:33:22 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"91"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": 516193\n },\n \"data\": \"\",\n \"code\": 200\n}"},{"id":"af89e34d-c197-47d7-a81d-c687c9791613","name":"REQUEST - NAP NON-INVENTORY | SERVIC | OTHER CHARGE","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"LAPTOP-REPAIR","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Service","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSalePrice","value":"10","description":"**Sale Price** || **float** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"Acer Aspire Series","description":"**Sale Description** || **string** || **Required**","type":"text"},{"key":"parentItemId","value":"","description":"**Item id** || **STRING**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 07:01:21 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"104"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": \"PRO-531350-OGD1FB\"\n },\n \"data\": \"\",\n \"code\": 200\n}"},{"id":"c21e6620-1b09-4b42-891d-830a17b99b3e","name":"Item create NAP item Type Discount","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"Christmas Sale","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Discount","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"Christmas Sale - 50%","description":"**Sale Description** || **String** || **Required**","type":"text"},{"key":"parentItemId","value":"","description":"**item id** || **string**","type":"text"},{"key":"itemDiscount","value":"50","description":"**Item Discount** || **float** || **Required**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 07:04:22 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"104"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": \"PRO-680041-TRXVCO\"\n },\n \"data\": \"\",\n \"code\": 200\n}"},{"id":"8d3b23fd-616d-4d35-ba33-43e1430e464b","name":"REQUEST - NAP ITEM - PAYMENT | SUBTOTAL","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"test item","description":"**Item** || **String** || **Required**","type":"text"},{"key":"itemType","value":"Subtotal","description":"**Type** || **String** || **Required**","type":"text"},{"key":"itemSaleDescription","value":"itemSaleDescription","description":"**SaleDescription** || **String** || **Required**","type":"text"}]},"url":"{{v2-url}}/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 07:08:54 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"104"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"message\": \"Product Created Successfully\",\n \"itemId\": \"PRO-562691-ITWSFL\"\n },\n \"data\": \"\",\n \"code\": 200\n}"}],"_postman_id":"cb19ce0f-ad63-45e0-9f79-9ade07c18922"},{"name":"Item Details","id":"d9b6ea18-0129-485c-a50a-82e25cefb6d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{v2-url}}/products/","description":"

Get a specific item/product details.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["products",""],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"3e0b12c1-d37a-4005-87b3-414363f0b178","name":"Get Single Item Data QBO Inventory Type","originalRequest":{"method":"GET","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/products/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Apr 2022 12:23:38 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11"},{"key":"X-Powered-By","value":"PHP/7.3.11"},{"key":"Content-Length","value":"422"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"itemId\": \"25\",\n \"itemName\": \"eajgjga\",\n \"itemSKU\": \"skhjbx\",\n \"itemStatus\": \"Active\",\n \"itemParentId\": \"0\",\n \"itemType\": \"Inventory\",\n \"itemQuantity\": \"10\",\n \"itemSalePrice\": \"20\",\n \"itemSaleDescription\": \"xbxbxxb\",\n \"itemPurchasePrice\": \"52\",\n \"itemPurchaseDescription\": \"zjzjzjjz\",\n \"itemIncomeAccount\": \"79\",\n \"itemExpenseAccountId\": \"80\",\n \"itemInventoryAccountId\": \"81\",\n \"itemDate\": \"2022-04-02\"\n },\n \"message\": \"Item Detail Get Successfully\",\n \"code\": 200\n}"}],"_postman_id":"d9b6ea18-0129-485c-a50a-82e25cefb6d2"},{"name":"Get All Item","id":"dc5a64ae-fce2-4e14-acc6-4333f3df1fcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{v2-url}}/products/all","description":"

Get list of items/products.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
page	Page Number (Starting - 0)	No	Int	-	-
limit	Listing Limit Count	No	Int	-	-
search	Filter Customer by [ itemName ]	No	String	-	-

","urlObject":{"path":["products","all"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"a19edc34-2050-462b-a0d4-57444fe63baa","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"limit","value":"1","type":"text"}]},"url":"{{v2-url}}/products/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 09:58:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"247"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item Detail Get Successfully\",\n \"data\": [\n {\n \"itemId\": \"PRO-541417-P8Q79M\",\n \"itemName\": \"Hours\",\n \"itemType\": \"OtherCharge\",\n \"itemStatus\": \"Active\",\n \"itemSalePrice\": \"1\",\n \"itemParentId\": \"\",\n \"itemSaleDescription\": \" hours\",\n \"itemAccountId\": \"\"\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"dc5a64ae-fce2-4e14-acc6-4333f3df1fcd"},{"name":"Update Item Status","id":"cae2907a-837e-4a3c-b57b-c34191d47b9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/products/status_update","description":"

Update item/product status.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemStatus	Item status	Yes	Integer	-	Aceepted Values [ 1, 0 ]

","urlObject":{"path":["products","status_update"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"3d1d421c-9689-4073-8b0c-3f4659266a35","name":"Activated Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemId","value":"","type":"text"},{"key":"itemStatus","value":"1","type":"text"}]},"url":"{{v2-url}}/products/status_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 10:01:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"94"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item Activated\",\n \"data\": {\n \"itemId\": \"\"\n },\n \"code\": 200\n}"},{"id":"3ebaadc0-9b6c-465b-9004-3306b987726a","name":"Deactivated Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemId","value":"","type":"text"},{"key":"itemStatus","value":"0","type":"text"}]},"url":"{{v2-url}}/products/status_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Jul 2022 10:00:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"96"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item Deactivated\",\n \"data\": {\n \"itemId\": \"\"\n },\n \"code\": 200\n}"}],"_postman_id":"cae2907a-837e-4a3c-b57b-c34191d47b9f"},{"name":"Update Item","id":"a085b347-f7ca-42b2-8f2e-9b7b291adb78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"url":"{{v2-url}}/products/edit","description":"

Update item/product details.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
token	Access token received from the login authentication response	Yes	String	-	-

Body

Each item type and merchant type has a unique request dataset. Refer to the sample request of available items:

QBO type and item type Inventory Request Parameters

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemSku	Item SKU	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
itemPurchasePrice	Item purchase Price	Yes	Float	-	-
itemPurchaseDescription	Item purchase description	Yes	String	-	-
itemQuantity	Item quantity	No	Integer	-	-
parentItemId	Parent Item Id	No	String	-	-
expenseAccountId	Item expense Account Id	No	iInteger	-	-
incomeAccountId	Item income Account Id	No	Integer	-	-
inventoryAccountId	Item inventory Account Id	No	Integer	-	-

QBO type and item type service Request Parameters

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemSku	Item SKU	Yes	String	-	-
itemType	item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
itemPurchasePrice	Item purchase Price	Yes	Float	-	-
itemPurchaseDescription	Item purchase description	Yes	String	-	-
parentItemId	Parent Item Id	No	String	-	-
expenseAccountId	Item expense Account Id	No	Integer	-	-
incomeAccountId	Item income Account Id	No	Integer	-	-

QBD type and item type Service and NonInventory and OtherCharge Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
parentItemId	Parent Item Id	No	String	-	-
incomeAccountId	Item income Account Id	Yes	String	-	-

QBD type and item type Discount Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemDiscount	Item discount Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
parentItemId	Parent Item Id	No	sString	-	-
incomeAccountId	Item income Account Id	Yes	sString	-	-

QBD type and item type Payment or subTotal Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-

FreshBooks type and item type item Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
itemQuantity	Item quantity	Yes	Int	-	-
incomeAccountId	Item income Account Id	Yes	String	-	-
inventoryType	Item inventory Type	No	String	-	-
inventoryStock	Item inventory Stock	Yes(if you input the value inventoryType )	Int	-	-

FreshBooks type and item type Service Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	sString	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-

XERO type Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
itemCode	Item code	Yes	String	-	-
itemAccountId	Item Account Id	Yes	String	-	-

NAP type and item type Service and Inventory and OtherCharge Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSalePrice	Item sale Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
parentItemId	Item parent Item Id	No	String	-	-

NAP type and item type discount Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemDiscount	Item discount Price	Yes	Float	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-
parentItemId	Item parent Item Id	No	String	-	-

NAP type and item type Payment and subTotal Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
itemId	Item Id	Yes	String	-	-
itemName	Item name	Yes	String	-	-
itemType	Item type	Yes	String	-	-
itemSaleDescription	Item Sale description	Yes	String	-	-

","urlObject":{"path":["products","edit"],"host":["{{v2-url}}"],"query":[],"variable":[]}},"response":[{"id":"38041d9c-d9ff-45f6-828b-123916d1f962","name":"XERO - Update Item","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemId","value":"76cda3bc-e81e-4b52-97e2-4da849e2f64a","type":"text"},{"key":"itemName","value":"HP Pavallion - 1001","type":"text"},{"key":"itemSalePrice","value":"15","type":"text"},{"key":"itemSaleDescription","value":"HP Pavallion - 1001","type":"text"},{"key":"itemAccountId","value":"","type":"text"},{"key":"itemCode","value":"HP-P-1001","type":"text"}]},"url":"{{v2-url}}/products/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Apr 2022 07:52:37 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"347"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Product Created Successfully\",\n \"data\": {\n \"ListID\": \"49\",\n \"productID\": \"76cda3bc-e81e-4b52-97e2-4da849e2f64a\",\n \"Code\": \"HP-P-1001\",\n \"IsActive\": \"true\",\n \"TimeModified\": \"2022-04-11 09:52:38\",\n \"Name\": \"HP Pavallion - 1001\",\n \"SalesDescription\": \"HP Pavallion - 1001\",\n \"saleCost\": \"15\",\n \"QuantityOnHand\": null,\n \"AccountCode\": null,\n \"merchantID\": \"200\"\n },\n \"code\": 200\n}"},{"id":"984f4e18-4d35-4aad-993e-6b97e66b62ab","name":"FreshBook - Update Item","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"{{v2-secretKey}}","type":"text"},{"key":"token","value":"{{v2-token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"itemId","value":"361869","type":"text"},{"key":"itemName","value":"ASUS X-507-UISA","type":"text"},{"key":"itemType","value":"Item","type":"text"},{"key":"itemSalePrice","value":"100","type":"text"},{"key":"itemSaleDescription","value":"ASUS X-507-UI","type":"text"},{"key":"itemQuantity","value":"1","type":"text"},{"key":"inventoryType","value":"Inventory","type":"text"},{"key":"inventoryStock","value":"10","type":"text"}]},"url":"{{v2-url}}/products/edit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Apr 2022 07:52:37 GMT"},{"key":"Server","value":"Apache/2.4.51 (Win64) OpenSSL/1.1.1l PHP/7.3.33"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Content-Length","value":"347"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Product Created Successfully\",\n \"data\": {\n \"ListID\": \"82\",\n \"productID\": \"361869\",\n \"IsActive\": \"1\",\n \"TimeModified\": \"2022-04-11 03:32:56\",\n \"Name\": \"ASUS X-507-UISA\",\n \"SalesDescription\": \"ASUS X-507-UI\",\n \"saleCost\": \"100.00\",\n \"QuantityOnHand\": \"1\",\n \"Inventory\": \"0\",\n \"Tax1\": \"0\",\n \"Tax2\": \"0\",\n \"merchantID\": \"260\",\n \"fbCompanyID\": \"7VanwM\",\n \"isService\": \"0\"\n },\n \"code\": 200\n}"}],"_postman_id":"a085b347-f7ca-42b2-8f2e-9b7b291adb78"}],"id":"200d678e-e4e7-43a7-a64d-5beccdc78629","_postman_id":"200d678e-e4e7-43a7-a64d-5beccdc78629","description":""},{"name":"Legacy","item":[{"name":"Authentication","item":[{"name":"API Login","event":[{"listen":"prerequest","script":{"id":"6c852d08-11b4-4a23-8e4e-8fcb997d1fd9","exec":[""],"type":"text/javascript"}}],"id":"6cb4409b-5d6e-4a80-90bc-0e354a53f57e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/Auth/auth_login","description":"

Generate access token.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-
This is used to Login to API Services.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
authId	Login ID	Yes	String	-	-
authPass	Password	Yes	String	-	-

","urlObject":{"path":["Auth","auth_login"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"24a9d111-703e-4f03-afe1-0c9d2b26ee20","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Login ID","key":"authId","type":"text","value":"john.smith@cztester.com"},{"description":"Password","key":"authPass","type":"text","value":"Alpha123!!!"}]},"url":"{{url}}/Auth/auth_login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 Feb 2021 12:46:34 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%228af30e71a8c03aeacde88440a555c96b%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614257194%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D7488d2715758b6d180f2f17af0300e8c224c29fe; expires=Thu, 25-Feb-2021 14:46:34 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"52"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 403,\n \"message\": \"Invalid credentials.\"\n}"},{"id":"61f62499-278a-4d4c-b089-8e1abb7ff198","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Login ID","key":"authId","type":"text","value":"john.smith@cztester.com"},{"description":"Password","key":"authPass","type":"text","value":"Alpha123!@#"}]},"url":"{{url}}/Auth/auth_login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 Feb 2021 12:43:28 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22b76978f0ba17c895ff0459b39c8da87e%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614257008%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Da7958a6c96e97c7d1a37770037317f3f264032f2; expires=Thu, 25-Feb-2021 14:43:28 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"481"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQyNTcwMDgsImNoayI6MTAwNTQ1NjY4Miwic3RhcnQiOjE2MTQyNTcwMDgsImV4cGlyZSI6MTYxNDI2NDIwOCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.ZWLDGvzq8cYNWi6J92seIDsuSZtxOa-yR84bIpAh9iQ\",\n \"message\": \"Token generated successfully.\"\n}"}],"_postman_id":"6cb4409b-5d6e-4a80-90bc-0e354a53f57e"},{"name":"Refresh Token","id":"360acb9b-45a3-48a0-b315-12dc42221160","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/Auth/refresh_token","description":"

Refresh existing access token. (Note: must be done within two hours of existing token's creation.)

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["Auth","refresh_token"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cdf5a3e4-11a8-40bb-9866-b0391ab07f7a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"OLD Token ","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQyNTcwMDgsImNoayI6MTAwNTQ1NjY4Miwic3RhcnQiOjE2MTQyNTcwMDgsImV4cGlyZSI6MTYxNDI2NDIwOCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.ZWLDGvzq8cYNWi6J92seIDsuSZtxOa-yR84bIpAh9iQ "}]},"url":"{{url}}/Auth/refresh_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 Feb 2021 13:05:25 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22ef320f5ab8e657107945f75c3f261e45%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614258325%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D19323642a2d9af2de8212bdf9fbd1dc6c7ef7b8e; expires=Thu, 25-Feb-2021 15:05:25 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"483"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQyNTgzMjUsImNoayI6MTM2MDI5MTI0Niwic3RhcnQiOjE2MTQyNTgzMjUsImV4cGlyZSI6MTYxNDI2NTUyNSwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.xGiXXTlmdSpPesEjKSFNB0z35SnXT_fFRWfgl68hrzE\",\n \"message\": \"Token regenerated successfully.\"\n}"},{"id":"a56d96f3-b7bf-4589-97e6-8cc82b4603c0","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"OLD Token ","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTY5NjgyODIsImNoayI6NjE3OTk3MTcsInN0YXJ0IjoxNTU2OTY4MjgyLCJleHBpcmUiOjE1NTY5NzU0ODIsInVzZXJuYW1lIjoicG9wcGlvLmpob24xMjNAZ21haWwuY29tIiwibWlkIjoiNDgiLCJpZCI6IjQ5Iiwic2VydmljZSI6IjEiLCJjb21wYW55IjoiMTkzNTE0NzgwNDYzMjk0IiwiZG9tYWluIjoiYXBpLnRlc3QiLCJyb2xlIjoibV91c2VyIn0.LhyD9aIu_9fAZogZxBasvzfVKyJRFx0hLpoHces6b9"}]},"url":"{{url}}/Auth/refresh_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 06:59:09 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%226c4a620d104c1ff53241e71edc143ab4%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614322749%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dc30dd50b9cf852a63899d62d9c54402bf5115367; expires=Fri, 26-Feb-2021 08:59:09 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"61"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 403,\n \"status\": \"fail\",\n \"message\": \"Invalid Key Or token\"\n}"}],"_postman_id":"360acb9b-45a3-48a0-b315-12dc42221160"},{"name":"Get User Profile","id":"4a26ed32-2d93-459a-bed0-6996cb311aa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/Auth/get_profile_data","description":"

Get merchant profile data for provided access token.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["Auth","get_profile_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d3b2ea62-341d-49a8-bf05-af22392eee6b","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Secret API Key","key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Access Token","key":"token","type":"text","value":"eyJ0eXAiOiJK1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v4"}]},"url":"{{url}}/Auth/get_profile_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 07:11:32 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%224bcdf0efa652c3de5f9fb8601dabfed2%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614323492%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D76024a617a7d1c28ea06a4f73180540439c166f3; expires=Fri, 26-Feb-2021 09:11:32 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"232"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Profile data fetched successfully.\",\n \"data\": {\n \"firstName\": \"Anonymous\",\n \"lastName\": \"Delta\",\n \"merchantEmail\": \"john.smith@cztester.com\",\n \"companyName\": \"Demo company name\",\n \"resellerID\": \"11\",\n \"agentID\": \"19\"\n },\n \"code\": 200\n}"},{"id":"f6289d25-45f1-4ba6-bcff-33bd33eddbdc","name":"Error","originalRequest":{"method":"POST","header":[{"description":"Secret API Key","key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Access Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v41"}]},"url":"{{url}}/Auth/get_profile_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 07:12:09 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22df0277b4f7e80be3e74fea07611d4a44%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614323529%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Db7c992dc3945377915786827c2e65b0300ccf168; expires=Fri, 26-Feb-2021 09:12:09 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"46"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 403,\n \"message\": \"Token or Key Invalid.\"\n}"}],"_postman_id":"4a26ed32-2d93-459a-bed0-6996cb311aa6"}],"id":"11dafefd-25dd-4ab3-8088-cc2f25e322d8","_postman_id":"11dafefd-25dd-4ab3-8088-cc2f25e322d8","description":""},{"name":"General Settings","item":[{"name":"Get All Gateways","id":"ea18706f-3dba-4328-85a3-3f6cc68599c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/MerchantGateway/getList","description":"

List of all available gateways.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["MerchantGateway","getList"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"90dce123-badb-4c8e-a25d-f3c3ba8a9b0b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY1MzU4MzYsImNoayI6ODgxOTk5OTI0LCJzdGFydCI6MTYzNjUzNTgzNiwiZXhwaXJlIjoxNjM2NTQzMDM2LCJ1c2VybmFtZSI6Im1yaS5hcGNAY3p0ZXN0ZXIuY29tIiwibWlkIjoiMzIzIiwiaWQiOiIzMjMiLCJzZXJ2aWNlIjoiNSIsImNvbXBhbnkiOjAsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.EJipZyGl3WlGxUZWKZs0rM9NLrwQYl5vJUIeW-EfRTc","type":"text"}]},"url":"{{url}}/MerchantGateway/getList"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Nov 2021 09:32:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2577"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_payportal_=a%3A0%3A%7B%7D; expires=Tue, 10-Nov-2020 19:32:27 GMT; Max-Age=0; path=/; domain=payportaldev.com"},{"key":"Set-Cookie","value":"payportal_payportal_=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%226a7fc9a2017758fe27d571abf6e80dfa%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A21%3A%22PostmanRuntime%2F7.28.4%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1636536747%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D0f325055e18d29dbe644705fe51f4675e7769b92; expires=Wed, 10-Nov-2021 11:32:27 GMT; Max-Age=7200; path=/; domain=payportaldev.com"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Merchant Gateway\",\n \"data\": [\n {\n \"gatewayID\": \"1\",\n \"gatewayName\": \"NMI\",\n \"gatewayUniqueId\": \"NMI_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"nmiUserName\",\n \"nmiPassword\"\n ]\n },\n {\n \"gatewayID\": \"2\",\n \"gatewayName\": \"Authorize.net\",\n \"gatewayUniqueId\": \"AUTHORIZE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"authorizeApiKey\",\n \"authorizeTransactionId\"\n ]\n },\n {\n \"gatewayID\": \"3\",\n \"gatewayName\": \"PayTrace\",\n \"gatewayUniqueId\": \"PAYTRACE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"payTraceUserName\",\n \"payTracePassword\"\n ]\n },\n {\n \"gatewayID\": \"4\",\n \"gatewayName\": \"PayPal\",\n \"gatewayUniqueId\": \"PAYPAL_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"paypalApiUserName\",\n \"paypalApiPassword\"\n ]\n },\n {\n \"gatewayID\": \"5\",\n \"gatewayName\": \"Stripe\",\n \"gatewayUniqueId\": \"STRIPE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"stripePublishableKey\",\n \"stripeSecretApiKey\"\n ]\n },\n {\n \"gatewayID\": \"6\",\n \"gatewayName\": \"USAePay\",\n \"gatewayUniqueId\": \"USAEPAY_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"UsaePayTransactionKey\",\n \"UsaePayPin\"\n ]\n },\n {\n \"gatewayID\": \"7\",\n \"gatewayName\": \"Heartland\",\n \"gatewayUniqueId\": \"HEARTLAND_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"heartlandPublicKey\",\n \"heartlandSecretKey\"\n ]\n },\n {\n \"gatewayID\": \"8\",\n \"gatewayName\": \"CyberSource\",\n \"gatewayUniqueId\": \"CYBERSOURCE_GATEWAY\"\n },\n {\n \"gatewayID\": \"9\",\n \"gatewayName\": \"Chargezoom\",\n \"gatewayUniqueId\": \"CHARGEZOOM_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"chargezoomUserName\",\n \"chargezoomPassword\"\n ]\n },\n {\n \"gatewayID\": \"10\",\n \"gatewayName\": \"iTransact\",\n \"gatewayUniqueId\": \"ITRANSACT_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"itransactUserName\",\n \"itransactApiKey\"\n ]\n },\n {\n \"gatewayID\": \"11\",\n \"gatewayName\": \"Fluidpay\",\n \"gatewayUniqueId\": \"FLUIDPAY_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"fluidPayApiKey\"\n ]\n },\n {\n \"gatewayID\": \"12\",\n \"gatewayName\": \"TSYS\",\n \"gatewayUniqueId\": \"TSYS_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"tsysApiUserId\",\n \"tsysApiPassword\",\n \"tsysGatewayMerchantId\"\n ]\n },\n {\n \"gatewayID\": \"13\",\n \"gatewayName\": \"BASYS iQ Pro\",\n \"gatewayUniqueId\": \"BASYS_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"basysApiKey\"\n ]\n },\n {\n \"gatewayID\": \"14\",\n \"gatewayName\": \"CardPointe\",\n \"gatewayUniqueId\": \"CARDPOINTE_GATEWAY\"\n },\n {\n \"gatewayID\": \"15\",\n \"gatewayName\": \"PayArc Payment\",\n \"gatewayUniqueId\": \"PAYARC_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"payarcSecretKey\"\n ]\n },\n {\n \"gatewayID\": \"16\",\n \"gatewayName\": \"EPX\",\n \"gatewayUniqueId\": \"EPX_GATEWAY\"\n },\n {\n \"gatewayID\": \"17\",\n \"gatewayName\": \"Maverick\",\n \"gatewayUniqueId\": \"MAVERICK_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"maverickAccessToken\",\n \"maverickTerminalId\"\n ]\n },\n {\n \"gatewayID\": \"18\",\n \"gatewayName\": \"Intuit\",\n \"gatewayUniqueId\": \"INTUIT_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"intuitClientId\",\n \"intuitClientSecret\"\n ]\n },\n {\n \"gatewayID\": \"20\",\n \"gatewayName\": \"Square Payment\",\n \"gatewayUniqueId\": \"SQUARE_GATEWAY\",\n \"gatewayRequiredFields\": [\n \"squareAccessToken\",\n \"squareApplicationId\",\n \"squareLocationId\"\n ]\n }\n ]\n}"}],"_postman_id":"ea18706f-3dba-4328-85a3-3f6cc68599c5"},{"name":"Get All Merchant Gateways","id":"69cd66e3-e454-43bb-9aae-71bc05d907ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/SettingConfig/get_merchant_gateway_data","description":"

List of all gateways which have been configured by the merchant.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["SettingConfig","get_merchant_gateway_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7cef573a-408c-4b40-ad9a-7338951f71fd","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20"}]},"url":"{{url}}i/SettingConfig/get_merchant_gateway_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:03:53 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%229e8f570cd0a2d83a71643d9c8ae17cdb%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614603833%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dae884bc1f04f2b203bda5d216106bc78336cf429; expires=Mon, 01-Mar-2021 15:03:53 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"4276"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"All gateway data\",\n \"data\": [\n {\n \"gatewayID\": \"665\",\n \"gatewayFriendlyName\": \"Stripe\",\n \"gatewayUsername\": \"1234657980\",\n \"gatewayPassword\": \"1234567890\",\n \"gatewaySignature\": \"\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"5\",\n \"createdAt\": null,\n \"updatedAt\": \"2021-03-01 09:09:18\",\n \"status\": \"0\",\n \"gatewayMerchantID\": \"478\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"0\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"0\"\n },\n {\n \"gatewayID\": \"667\",\n \"gatewayFriendlyName\": \"PayTrace\",\n \"gatewayUsername\": \"12345\",\n \"gatewayPassword\": \"User@1234\",\n \"gatewaySignature\": \"13246579\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"3\",\n \"createdAt\": null,\n \"updatedAt\": \"2021-03-01 09:09:18\",\n \"status\": \"0\",\n \"gatewayMerchantID\": \"\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"1\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"0\"\n },\n {\n \"gatewayID\": \"668\",\n \"gatewayFriendlyName\": \"PayPal\",\n \"gatewayUsername\": \"12346579\",\n \"gatewayPassword\": \"1234568979\",\n \"gatewaySignature\": \"2356498791245\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"4\",\n \"createdAt\": null,\n \"updatedAt\": \"2021-03-01 09:09:18\",\n \"status\": \"0\",\n \"gatewayMerchantID\": \"\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"0\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"0\"\n },\n {\n \"gatewayID\": \"693\",\n \"gatewayFriendlyName\": \"Authorize.net\",\n \"gatewayUsername\": \"123154654\",\n \"gatewayPassword\": \"2316849\",\n \"gatewaySignature\": \"\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"2\",\n \"createdAt\": null,\n \"updatedAt\": \"2021-03-01 09:09:18\",\n \"status\": \"0\",\n \"gatewayMerchantID\": \"\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"1\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"0\"\n },\n {\n \"gatewayID\": \"704\",\n \"gatewayFriendlyName\": \"NMI\",\n \"gatewayUsername\": \"1324679\",\n \"gatewayPassword\": \"123156457\",\n \"gatewaySignature\": \"\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"1\",\n \"createdAt\": null,\n \"updatedAt\": \"2021-03-01 09:09:18\",\n \"status\": \"0\",\n \"gatewayMerchantID\": \"478\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"1\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"1\"\n },\n {\n \"gatewayID\": \"707\",\n \"gatewayFriendlyName\": \"Heartland\",\n \"gatewayUsername\": \"pkapi_cert_1234567890\",\n \"gatewayPassword\": \"skapi_cert_1234567890\",\n \"gatewaySignature\": \"\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"7\",\n \"createdAt\": null,\n \"updatedAt\": \"2021-03-01 09:09:18\",\n \"status\": \"0\",\n \"gatewayMerchantID\": \"\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"0\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"0\"\n },\n {\n \"gatewayID\": \"712\",\n \"gatewayFriendlyName\": \"TSYS\",\n \"gatewayUsername\": \"2132112\",\n \"gatewayPassword\": \"123456**\",\n \"gatewaySignature\": \"\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"12\",\n \"createdAt\": null,\n \"updatedAt\": \"2021-03-01 09:09:18\",\n \"status\": \"0\",\n \"gatewayMerchantID\": \"887000003195\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"0\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"0\"\n },\n {\n \"gatewayID\": \"720\",\n \"gatewayFriendlyName\": \"USAepay\",\n \"gatewayUsername\": \"1234567890\",\n \"gatewayPassword\": \"123456\",\n \"gatewaySignature\": \"\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"6\",\n \"createdAt\": null,\n \"updatedAt\": \"2021-03-01 09:09:18\",\n \"status\": \"0\",\n \"gatewayMerchantID\": \"\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"0\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"1\",\n \"enable_level_three_data\": \"0\"\n },\n {\n \"gatewayID\": \"727\",\n \"gatewayFriendlyName\": \"Cyber\",\n \"gatewayUsername\": \"chargezoom\",\n \"gatewayPassword\": \"1234567890\",\n \"gatewaySignature\": \"1234657897=\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"8\",\n \"createdAt\": null,\n \"updatedAt\": \"2021-03-01 09:09:18\",\n \"status\": \"0\",\n \"gatewayMerchantID\": \"\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"0\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"0\"\n },\n {\n \"gatewayID\": \"728\",\n \"gatewayFriendlyName\": \"Paytrace\",\n \"gatewayUsername\": \"\",\n \"gatewayPassword\": \"\",\n \"gatewaySignature\": \"\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"1\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"status\": \"0\",\n \"gatewayMerchantID\": \"GM1\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"0\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"0\"\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"69cd66e3-e454-43bb-9aae-71bc05d907ca"},{"name":"Add Merchant Gateway","id":"86664d5f-0e29-4657-a6e8-300b1bbc2d06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/MerchantGateway/addNewGateway","description":"

Add new gateway.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
gatewayIdentifier	Gateway identifier, (each gateway has one unique identifier string).	Yes	String	-	It must be one of the available gateway identifiers which are provided in the \"Get All Gateways\" list. i.e. NMI_GATEWAY, AUTHORIZE_GATEWAY etc.
friendlyName	Friendly name for the gateway	Yes	String	-	-
setAsDefault	Set default gateway for merchant	Yes	String	N	Possible values are Y or N.

","urlObject":{"path":["MerchantGateway","addNewGateway"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"bf553b9a-7b88-4987-8d33-df24dd3b13c4","name":"Add NMI Gateway","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY1MzU4MzYsImNoayI6ODgxOTk5OTI0LCJzdGFydCI6MTYzNjUzNTgzNiwiZXhwaXJlIjoxNjM2NTQzMDM2LCJ1c2VybmFtZSI6Im1yaS5hcGNAY3p0ZXN0ZXIuY29tIiwibWlkIjoiMzIzIiwiaWQiOiIzMjMiLCJzZXJ2aWNlIjoiNSIsImNvbXBhbnkiOjAsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.EJipZyGl3WlGxUZWKZs0rM9NLrwQYl5vJUIeW-EfRTc","type":"text"},{"key":"gatewayIdentifier","value":"NMI_GATEWAY","type":"text"},{"key":"friendlyName","value":"NMI Demo Gateway","type":"text"},{"key":"nmiUserName","value":"demo","type":"text"},{"key":"nmiPassword","value":"demo123","type":"text"},{"key":"setAsDefault","value":"N","type":"text","description":"Y or N"}]},"url":"{{url}}/MerchantGateway/addNewGateway"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Nov 2021 10:26:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"77"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully.\",\n \"data\": {\n \"gatewayId\": 669\n },\n \"code\": 200\n}"},{"id":"fcf6988a-0bba-4444-b0bd-c1d1d4669911","name":"Add Authorize Gateway","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY1MzU4MzYsImNoayI6ODgxOTk5OTI0LCJzdGFydCI6MTYzNjUzNTgzNiwiZXhwaXJlIjoxNjM2NTQzMDM2LCJ1c2VybmFtZSI6Im1yaS5hcGNAY3p0ZXN0ZXIuY29tIiwibWlkIjoiMzIzIiwiaWQiOiIzMjMiLCJzZXJ2aWNlIjoiNSIsImNvbXBhbnkiOjAsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.EJipZyGl3WlGxUZWKZs0rM9NLrwQYl5vJUIeW-EfRTc","type":"text"},{"key":"gatewayIdentifier","value":"AUTHORIZE_GATEWAY","type":"text"},{"key":"friendlyName","value":"Authorize 2","type":"text"},{"key":"authorizeApiKey","value":"EnterApiKey","type":"text"},{"key":"authorizeTransactionId","value":"EnterTxnID","type":"text"},{"key":"setAsDefault","value":"N","type":"text","description":"Y or N"}]},"url":"{{url}}/MerchantGateway/addNewGateway"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Nov 2021 10:34:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"77"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully.\",\n \"data\": {\n \"gatewayId\": 670\n },\n \"code\": 200\n}"},{"id":"3e8ed749-4161-4d60-b64a-c1373cec0380","name":"Add Fluid Gateway","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2MjYzMzUsImNoayI6MTIyODkwNDQ3Mywic3RhcnQiOjE2MzY2MjYzMzUsImV4cGlyZSI6MTYzNjYzMzUzNSwidXNlcm5hbWUiOiJtcmkuYXBjQGN6dGVzdGVyLmNvbSIsIm1pZCI6IjMyMyIsImlkIjoiMzIzIiwic2VydmljZSI6IjUiLCJjb21wYW55IjowLCJkb21haW4iOiJwYXlwb3J0YWxkZXYuY29tIiwicm9sZSI6Im1lcmNoYW50In0.dfICUjBon_z0KYM1WIxcdTsb85p6HYSP_hqhFQIYxwE","type":"text"},{"key":"gatewayIdentifier","value":"FLUIDPAY_GATEWAY","type":"text"},{"key":"friendlyName","value":"Fluid demo","type":"text"},{"key":"fluidPayApiKey","value":"AddFluidPayAPIKey","type":"text"},{"key":"setAsDefault","value":"N","type":"text","description":"Y or N"}]},"url":"{{url}}/MerchantGateway/addNewGateway"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 10:29:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"77"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway added successfully.\",\n \"data\": {\n \"gatewayId\": 678\n },\n \"code\": 200\n}"},{"id":"70a44c7f-a852-4d0b-9e8b-327d82abf5b8","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY1MzU4MzYsImNoayI6ODgxOTk5OTI0LCJzdGFydCI6MTYzNjUzNTgzNiwiZXhwaXJlIjoxNjM2NTQzMDM2LCJ1c2VybmFtZSI6Im1yaS5hcGNAY3p0ZXN0ZXIuY29tIiwibWlkIjoiMzIzIiwiaWQiOiIzMjMiLCJzZXJ2aWNlIjoiNSIsImNvbXBhbnkiOjAsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.EJipZyGl3WlGxUZWKZs0rM9NLrwQYl5vJUIeW-EfRTc","type":"text"},{"key":"gatewayIdentifier","value":"","type":"text"},{"key":"friendlyName","value":"NMI Test Gateway","type":"text"},{"key":"nmiUserName","value":"test","type":"text"},{"key":"nmiPassword","value":"","type":"text"},{"key":"setAsDefault","value":"N","type":"text","description":"Y or N"}]},"url":"{{url}}/MerchantGateway/addNewGateway"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Nov 2021 10:29:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"121"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"gatewayIdentifier\": \"The Gateway Unique Identifier field is required.\"\n },\n \"message\": \"Validation Error\",\n \"code\": 422\n}"}],"_postman_id":"86664d5f-0e29-4657-a6e8-300b1bbc2d06"},{"name":"Edit Merchant Gateway","id":"0eb770f1-c9b4-4e1d-a8e0-49b0beb13af8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/MerchantGateway/updateGateway","description":"

Edit gateway.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
gatewayId	Gateway ID for the merchant configured gateway.	Yes	Integer	-	-
friendlyName	Friendly name for the gateway	No	String	-	-
setAsDefault	Set default gateway for merchant	No	String	N	Possible values are Y or N.

","urlObject":{"path":["MerchantGateway","updateGateway"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3c80f8e6-7be9-4170-a71c-e49b51ae5b72","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"f674fdf50248736e250073a7c9ac419085074257"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY1MzA1ODcsImNoayI6MTAxMDAxMzEyNywic3RhcnQiOjE2MzY1MzA1ODcsImV4cGlyZSI6MTYzNjUzNzc4NywidXNlcm5hbWUiOiJtcmkuYXBjQGN6dGVzdGVyLmNvbSIsIm1pZCI6IjMyMyIsImlkIjoiMzIzIiwic2VydmljZSI6IjUiLCJjb21wYW55IjowLCJkb21haW4iOiJwYXlwb3J0YWxkZXYuY29tIiwicm9sZSI6Im1lcmNoYW50In0.rqkucl9olc4GvollPKNikp_ORu6fWlm78-5XOV2t5Ic","type":"text"},{"key":"gatewayIdentifier","value":"","type":"text"},{"key":"friendlyName","value":"","type":"text"},{"key":"gatewayId","value":"","type":"text"}]},"url":"{{url}}/MerchantGateway/updateGateway"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Nov 2021 10:36:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"228"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"gatewayIdentifier\": \"The Gateway Unique Identifier field is required.\",\n \"friendlyName\": \"The Gateway Friendly Name field is required.\",\n \"gatewayId\": \"The Gateway field is required.\"\n },\n \"message\": \"Validation Error\",\n \"code\": 422\n}"},{"id":"9a8e90a8-f4ba-4a7e-afd5-d9f351aa58d2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY1NDgzMjksImNoayI6OTQwNDkyMTE3LCJzdGFydCI6MTYzNjU0ODMyOSwiZXhwaXJlIjoxNjM2NTU1NTI5LCJ1c2VybmFtZSI6Im1yaS5hcGNAY3p0ZXN0ZXIuY29tIiwibWlkIjoiMzIzIiwiaWQiOiIzMjMiLCJzZXJ2aWNlIjoiNSIsImNvbXBhbnkiOjAsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.Tsvgvm-1-MLf6bFNZz1HuFIPwNKTxARtCmwSPUyLZ2s","type":"text"},{"key":"gatewayIdentifier","value":"AUTHORIZE_GATEWAY","type":"text"},{"key":"friendlyName","value":"AuthFriendlyNet","description":"Not Required","type":"text"},{"key":"gatewayId","value":"0","type":"text"},{"key":"setAsDefault","value":"N","description":"Y or N","type":"text"},{"key":"authorizeApiKey","value":"NewAuthKey","type":"text"},{"key":"authorizeTransactionId","value":"NewTxnId","type":"text"}]},"url":"{{url}}/MerchantGateway/updateGateway"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Nov 2021 13:00:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"64"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway Updated successfully.\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"0eb770f1-c9b4-4e1d-a8e0-49b0beb13af8"},{"name":"Get Gateway","id":"140b31e1-ac9e-4833-9590-4d052ef539e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/SettingConfig/get_single_gateway_data","description":"

Get gateway details.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
gatewayId	Gateway ID for the merchant configured gateway.	Yes	Integer	-	-

","urlObject":{"path":["SettingConfig","get_single_gateway_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"41cc742f-62f5-43d8-b9a9-b1bd05cb0fc3","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20"},{"key":"gatewayId","type":"text","value":"728"}]},"url":"{{url}}/SettingConfig/get_single_gateway_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:55:22 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2239fd76a448cc3d4d5a93c498a5570bf7%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614603322%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D1c78bd663de8fed2b93b1b9a47f06d80be479b3b; expires=Mon, 01-Mar-2021 14:55:22 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"425"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway details fetched successfully.\",\n \"data\": {\n \"gatewayID\": \"100\",\n \"gatewayFriendlyName\": \"NMI friendly\",\n \"gatewayUsername\": \"demo123\",\n \"gatewayPassword\": \"demo123\",\n \"gatewaySignature\": \"\",\n \"merchantID\": \"478\",\n \"gatewayType\": \"1\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"status\": \"0\",\n \"gatewayMerchantID\": \"PTR123\",\n \"creditCard\": \"1\",\n \"echeckStatus\": \"0\",\n \"isSurcharge\": \"0\",\n \"surchargePercentage\": \"0\",\n \"set_as_default\": \"0\",\n \"enable_level_three_data\": \"0\"\n },\n \"code\": 200\n}"},{"id":"944f34ce-7184-49cc-9525-747d9156424f","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20"},{"key":"gatewayId","type":"text","value":"7281"}]},"url":"{{url}}/SettingConfig/get_single_gateway_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:55:36 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22f7b7178f48a65c9213453a49fb427e18%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614603336%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Da381a55927e96a4689af59fa55665683b8085c1c; expires=Mon, 01-Mar-2021 14:55:36 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"53"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gateway details not found.\",\n \"data\": [],\n \"code\": 400\n}"}],"_postman_id":"140b31e1-ac9e-4833-9590-4d052ef539e9"},{"name":"Create Payment Term","id":"db031047-f95d-454f-a17e-8d6cdbe92191","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/SettingConfig/create_payment_term","description":"

Add payment term.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
termName	Payment term title	Yes	String	-	-
termDays	Payment term days	Yes	Integer	-	-

","urlObject":{"path":["SettingConfig","create_payment_term"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"93ab35fc-1fbf-4cdf-ad64-e7ba832e7f3f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"termName","type":"text","value":"Test11"},{"description":"required","key":"termDays","type":"text","value":"10"},{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20"}]},"url":"{{url}}/SettingConfig/create_payment_term"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:07:11 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%225b587066466a9480dbd0ecc7998fe793%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604031%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Da087eedd854d7acf6cccf1f2f0dc484ba7421446; expires=Mon, 01-Mar-2021 15:07:11 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"70"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment Term Created Successfully\",\n \"data\": 2047,\n \"code\": 200\n}"}],"_postman_id":"db031047-f95d-454f-a17e-8d6cdbe92191"},{"name":"Edit Payment Term","id":"ddfa6216-12af-4b3b-ad80-258831e8bd8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/SettingConfig/edit_payment_term","description":"

Edit payment terms.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
termName	Payment term title	Yes	String	-	-
termDays	Payment term days	Yes	Integer	-	-
termId	Payment term ID	Yes	Integer	-	-

","urlObject":{"path":["SettingConfig","edit_payment_term"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"aa2214c5-9e2a-47a5-a167-d3c060148173","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"termName","value":"Test11","description":"required","type":"text"},{"key":"termDays","value":"30","description":"required","type":"text"},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20","description":"required","type":"text"},{"key":"termId","value":"20471","description":"required","type":"text"}]},"url":"{{url}}/SettingConfig/edit_payment_term"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:08:39 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%228e5b79712fc615030bdfd6660a2527ed%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604119%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Df021609e63021174f7bda73981c244b7a981880b; expires=Mon, 01-Mar-2021 15:08:39 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"61"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment Term Already Exist\",\n \"data\": \"\",\n \"code\": 403\n}"},{"id":"26023560-ffac-43cc-a000-fed14feb79ab","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"termName","value":"Test11","description":"required","type":"text"},{"key":"termDays","value":"30","description":"required","type":"text"},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20","description":"required","type":"text"},{"key":"termId","value":"2047","description":"required","type":"text"}]},"url":"{{url}}/SettingConfig/edit_payment_term"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:08:23 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%225a03baa35fcf87e6509fadef28e60267%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604103%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D45f409884ee2703ba1f0db157cb3fdd6edfe2e21; expires=Mon, 01-Mar-2021 15:08:23 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"211"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment Term Updated Successfully\",\n \"data\": {\n \"id\": \"2047\",\n \"termID\": \"0\",\n \"pt_name\": \"Test11\",\n \"pt_netTerm\": \"30\",\n \"date\": \"2021-03-01 13:08:23\",\n \"merchantID\": \"478\",\n \"enable\": \"0\",\n \"set_as_default\": \"0\"\n },\n \"code\": 200\n}"}],"_postman_id":"ddfa6216-12af-4b3b-ad80-258831e8bd8e"},{"name":"Set Invoice Prefix Number","id":"7993c8ce-90bc-4c7a-9388-7eb7c955746c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/SettingConfig/set_invoice_prefix","description":"

Set invoice number series using invoice prefix code and postfix number. ie. ABC-20000, ABC is prefix and 20000 is postfix number.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
prefix	Invoice prefix	Yes	String	-	-
postfix	Invoice postfix number	Yes	Integer	-	-

","urlObject":{"path":["SettingConfig","set_invoice_prefix"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"46657e90-1db4-4b8b-a295-076451963929","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20"},{"description":"Required","key":"prefix","type":"text","value":"QBO"},{"description":"Required","key":"postfix","type":"text","value":"10000"}]},"url":"{{url}}/SettingConfig/set_invoice_prefix"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:09:36 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%229a5c01fb8ec44da340c5dc7867f5a230%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604176%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D2f8a5d3070bfd531d19bc706e1a058fc0d3a8957; expires=Mon, 01-Mar-2021 15:09:36 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"61"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice Prefix Added Successfully\",\n \"data\": \"\",\n \"code\": 200\n}"}],"_postman_id":"7993c8ce-90bc-4c7a-9388-7eb7c955746c"},{"name":"Customer Portal Setup","id":"41aa3dcb-bd52-43ee-baf4-873f563af6c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/SettingConfig/set_customer_portal","description":"

Create customer portal.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
enablePortal	Enable portal	Yes	Integer	0	Possible values are 1 and 0.
portalUrl	Portal URL	Yes	String	-	-
customerHelpText	Customer help text	No	String	-	-
myPass	Show password box in portal	No	Integer	0	Possible values are 1 and 0.
myInfo	Show info tab in portal	No	Integer	-	Possible values are 1 and 0.
mySubscriptions	Show subscription in portal	No	Integer	-	Possible values are 1 and 0.
serviceUrl	Term & Service URL	No	String	-	-

","urlObject":{"path":["SettingConfig","set_customer_portal"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"21deea14-9f6b-4f00-987b-3fc5b85d08b2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20","type":"text"},{"key":"enablePortal","value":"1","description":"Enable=>1, Disable=>0","type":"text"},{"key":"portalUrl","value":"test","description":"Required","type":"text"},{"key":"customerHelpText","value":"","description":"Help Text","type":"text"},{"key":"myPass","value":"1","description":"1=>yes, 0=>No","type":"text"},{"key":"myInfo","value":"1","description":"1=>yes, 0=>No","type":"text"},{"key":"mySubscriptions","value":"1","description":"1=>yes, 0=>No","type":"text"},{"key":"serviceUrl","value":"test.com","description":"Term & Service URL","type":"text"}]},"url":"{{url}}/SettingConfig/set_customer_portal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:12:54 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2262f0461472815d54f70a9c23fb7f7d31%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604374%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Db0287830eddcde400de834b9d7714ea2f3469531; expires=Mon, 01-Mar-2021 15:12:54 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"71"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Portal Updated Successfully\",\n \"data\": \"\",\n \"code\": 200\n}"}],"_postman_id":"41aa3dcb-bd52-43ee-baf4-873f563af6c4"}],"id":"ff3b94d8-040d-425d-bdb8-3a47082b5475","_postman_id":"ff3b94d8-040d-425d-bdb8-3a47082b5475","description":""},{"name":"Customer","item":[{"name":"Create / Edit Customer","id":"42bb2089-9209-4aac-8574-ab84341ab207","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/create_customer","description":"

Create a new customer or update existing customer based on the customer list id.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
firstName	First Name	Yes	String	-	-
lastName	Last Name	Yes	String	-	-
fullName	Fullname	Yes	String	-	-
userEmail	Customer email address	Yes	String	-	-
companyName	Company name	Yes	String	-	-
phone	Phone number	Yes	String	-	-
address1	Address 1	No	String	-	-
address2:	Address 2	No	String	-	-
companyCountry	Company country name or code	No	String	-	-
companyState	Company state name or code	No	String	-	-
companyCity	City name	No	String	-	-
zipcode	Zipcode	No	String	-	-
sCountry	Shipping country name or code	No	String	-	-
sState	Shipping state name or code	No	String	-	-
sCity	Shipping city name	No	String	-	-
sAddress1	Shipping street address 1	No	String	-	-
sAddress2	Shipping street address 2	No	String	-	-
sZipcode	Shipping zipcode	No	String	-	-
customerListId	Customer List ID (required field if editing existing customer)	No	String	-	Existing customerListId

","urlObject":{"path":["customer","create_customer"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d44c07a8-2a7d-4328-8225-43eb995aea41","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjA5ODgwMjcsImNoayI6MTAzNTU5NjI3NSwic3RhcnQiOjE2MjA5ODgwMjcsImV4cGlyZSI6MTYyMDk5NTIyNywidXNlcm5hbWUiOiJjaHoxNzFAbWFpbGluYXRvci5jb20iLCJtaWQiOiIyMzMiLCJpZCI6IjIzMyIsInNlcnZpY2UiOiIyIiwiY29tcGFueSI6IjE0NyIsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.eVqCOStQFMe6vx_YyrduW6IS4-wgVFMSaAfvRCObquo","type":"text"},{"key":"firstName","value":"John","type":"text"},{"key":"lastName","value":"Doe","type":"text"},{"key":"fullName","value":"John Doe","type":"text"},{"key":"userEmail","value":"john.doe@cztester.com","type":"text"},{"key":"companyCountry","value":"United States","type":"text"},{"key":"companyState","value":"CA","type":"text"},{"key":"companyCity","value":"San Francisco","type":"text"},{"key":"sCountry","value":"United State","type":"text"},{"key":"sState","value":"CA","type":"text"},{"key":"sCity","value":"San Francisco","type":"text"},{"key":"sAddress1","value":"12th street 147/58","type":"text"},{"key":"sAddress2","value":"#145","type":"text"},{"key":"address1","value":"12th street 147/58","type":"text"},{"key":"adress2","value":"#15/145","type":"text"},{"key":"zipcode","value":"75024","type":"text"},{"key":"sZipcode","value":"74025","type":"text"},{"key":"companyName","value":"Demo Company","type":"text"},{"key":"phone","value":"0000088880","type":"text"},{"key":"customerListId","value":"","type":"text"}]},"url":"{{url}}/customer/create_customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:07:53 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2212cbcda23e3213ec0d463520c1a87c8e%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614596873%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D5d319918e361a3e45914933499cf0ea123def386; expires=Mon, 01-Mar-2021 13:07:53 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"68"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer created successfully\",\n \"data\": 8238306,\n \"code\": 200\n}"},{"id":"d727feab-60fd-480c-863d-c75de57101ea","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTY4NDIsImNoayI6NjUzMzY3NTEyLCJzdGFydCI6MTYxNDU5Njg0MiwiZXhwaXJlIjoxNjE0NjA0MDQyLCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.GU5rX1vH8fr7NTm15Iu4lrD35sdZD72N1-42mMLIQIk","type":"text"},{"key":"firstName","value":"","type":"text"},{"key":"lastName","value":"Demo","type":"text"},{"key":"fullName","value":"Demo demo","type":"text"},{"key":"userEmail","value":"demo@cztester.com","type":"text"},{"key":"companyCountry","value":"United States","type":"text"},{"key":"companyState","value":"CA","type":"text"},{"key":"companyCity","value":"LA","type":"text"},{"key":"scountry","value":"United States","type":"text"},{"key":"sState","value":"CA","type":"text"},{"key":"sCity","value":"LA","type":"text"},{"key":"sAddress1","value":"demo address","type":"text"},{"key":"sAddress2","value":"#145","type":"text"},{"key":"address1","value":"12th street 147/58","type":"text"},{"key":"address2","value":"#15/145","type":"text"},{"key":"zipCode","value":"75024","type":"text"},{"key":"szipCode","value":"74025","type":"text"},{"key":"companyName","value":"Demo Company","type":"text"},{"key":"phone","value":"0000000000","type":"text"}]},"url":"{{url}}/customer/create_customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:12:10 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22afa33db2ca7971a95c3d468952ed0abe%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597130%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D39a0fd4d8f6d6526c727733a6108c62a2be613b8; expires=Mon, 01-Mar-2021 13:12:10 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"145"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"firstName\": \"The firstName field is required.\"\n },\n \"message\": \"Validation Error\",\n \"code\": 422\n}"}],"_postman_id":"42bb2089-9209-4aac-8574-ab84341ab207"},{"name":"Get Customer","id":"e26d6b12-49ca-4ccf-8bcf-e9219f372659","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/get_customer_details","description":"

Get customer details by customer ID.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer Id	Yes	Integer	-	-

","urlObject":{"path":["customer","get_customer_details"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"288ee5aa-ba66-43a2-acd3-0528fe207873","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Access Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTY4NDIsImNoayI6NjUzMzY3NTEyLCJzdGFydCI6MTYxNDU5Njg0MiwiZXhwaXJlIjoxNjE0NjA0MDQyLCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.GU5rX1vH8fr7NTm15Iu4lrD35sdZD72N1-42mMLIQIk"},{"description":"QBO Customer ID","key":"customerId","type":"text","value":"82383061"}]},"url":"{{url}}/customer/get_customer_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:13:38 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%221483a5e65e5b0ea2f49834c9a2ccdeb7%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597218%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dec1b88fffb885bf14b87269aad3132dedacc7120; expires=Mon, 01-Mar-2021 13:13:38 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"50"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No record found\",\n \"data\": [],\n \"code\": 200\n}"},{"id":"460a7469-b1b3-423a-b37b-5661e9d4d38b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Access Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTY4NDIsImNoayI6NjUzMzY3NTEyLCJzdGFydCI6MTYxNDU5Njg0MiwiZXhwaXJlIjoxNjE0NjA0MDQyLCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.GU5rX1vH8fr7NTm15Iu4lrD35sdZD72N1-42mMLIQIk"},{"description":"QBO Customer ID","key":"customerId","type":"text","value":"8238306"}]},"url":"{{url}}/customer/get_customer_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:13:13 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%222926702c8e99e003763ecf9eb861c094%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597193%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D4198c8abe365f62f5684ea6bed95cedfa20d0076; expires=Mon, 01-Mar-2021 13:13:13 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"708"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer\",\n \"data\": {\n \"customerID\": \"123123\",\n \"Customer_ListID\": \"8238306\",\n \"firstName\": \"Demo\",\n \"lastName\": \"Customer\",\n \"fullName\": \"Demo Customer\",\n \"userEmail\": \"demo.customer@cztester.com\",\n \"phoneNumber\": \"555585554\",\n \"address1\": \"Dummy address\",\n \"address2\": \"dummy address 2\",\n \"Country\": \"United States\",\n \"State\": \"CA\",\n \"City\": \"LA\",\n \"zipCode\": \"75024\",\n \"ship_address1\": \"Dummy shipping adddress\",\n \"ship_address2\": \"Dummy shipping address 2\",\n \"ship_country\": \"United States\",\n \"ship_state\": \"CA\",\n \"ship_city\": \"LA\",\n \"ship_zipcode\": \"74025\",\n \"companyName\": \"Demo company\",\n \"companyID\": \"8238306\",\n \"accept\": null,\n \"createdAt\": \"2021-03-01 11:07:53\",\n \"updatedAt\": \"2021-03-01 11:07:53\",\n \"listID\": \"8238306\",\n \"merchantID\": \"478\",\n \"profile_picture\": null,\n \"customerStatus\": \"true\"\n },\n \"code\": 200\n}"}],"_postman_id":"e26d6b12-49ca-4ccf-8bcf-e9219f372659"},{"name":"Get All Customers","id":"211cbba9-0fec-491c-a9e1-2a348deda61f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/get_customer_data","description":"

Get all customers.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
page	Page number, (if provided needs to be greater than 0).	No	Integer	-	-
limit	Records per page, (if provided needs to be greater than 0).	No	Integer	-	-
status	Status	No	Integer		Possible values are 1 and 0.

","urlObject":{"path":["customer","get_customer_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"99b836c0-7964-4a64-871f-f18ba9170c93","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"access token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTY4NDIsImNoayI6NjUzMzY3NTEyLCJzdGFydCI6MTYxNDU5Njg0MiwiZXhwaXJlIjoxNjE0NjA0MDQyLCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.GU5rX1vH8fr7NTm15Iu4lrD35sdZD72N1-42mMLIQIk"},{"key":"status","value":"1","description":"1=>Enable, 0=>Disable","type":"text"},{"key":"page","value":"4","description":"For Paging default value0","type":"text"},{"key":"limit","value":"20","description":"set limit of records by defualt 10","type":"text"}]},"url":"{{url}}/customer/get_customer_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:14:39 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2250a0763466eb3151ad2143f268484d8f%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597279%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D12ae668ea54a5acd8e43e3c3b4fd449680a4765f; expires=Mon, 01-Mar-2021 13:14:39 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"12104"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer\",\n \"data\": [],\n \"code\": 200\n}"},{"id":"b2c76c9d-90f0-455e-b43e-59539a9b4abf","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"access token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTY4NDIsImNoayI6NjUzMzY3NTEyLCJzdGFydCI6MTYxNDU5Njg0MiwiZXhwaXJlIjoxNjE0NjA0MDQyLCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.GU5rX1vH8fr7NTm15Iu4lrD35sdZD72N1-42mMLIQIk"},{"key":"status","value":"1","description":"1=>Enable, 0=>Disable","type":"text"},{"key":"page","value":"4","description":"For Paging default value0","type":"text"},{"key":"limit","value":"20","description":"set limit of records by defualt 10","type":"text"}]},"url":"{{url}}/customer/get_customer_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:14:39 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2250a0763466eb3151ad2143f268484d8f%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597279%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D12ae668ea54a5acd8e43e3c3b4fd449680a4765f; expires=Mon, 01-Mar-2021 13:14:39 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"12104"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer\",\n \"data\": [\n {\n \"customerID\": \"123123\",\n \"Customer_ListID\": \"CUST_123123\",\n \"firstName\": \"Demo\",\n \"lastName\": \"Demo\",\n \"fullName\": \"Demo Demo\",\n \"userEmail\": \"demo.demo@cztester.com\",\n \"phoneNumber\": \"5555666458\",\n \"address1\": \"Demo street address\",\n \"address2\": \"Demo street address 2\",\n \"Country\": \"USA\",\n \"State\": \"CA\",\n \"City\": \"LA\",\n \"zipCode\": \"22201\",\n \"ship_address1\": \"Demo street address\",\n \"ship_address2\": \"Demo street address 2\",\n \"ship_country\": \"USA\",\n \"ship_state\": \"CA\",\n \"ship_city\": \"LV\",\n \"ship_zipcode\": \"55524\",\n \"companyName\": \"Demo company name\",\n \"companyID\": \"545555221\",\n \"accept\": null,\n \"createdAt\": \"2021-01-11 11:44:13\",\n \"updatedAt\": \"2021-02-23 13:43:44\",\n \"listID\": \"1\",\n \"merchantID\": \"478\",\n \"profile_picture\": null,\n \"customerStatus\": \"true\",\n \"Balance\": \"312.06\"\n },\n {\n \"customerID\": \"5123123\",\n \"Customer_ListID\": \"CUST_5123123\",\n \"firstName\": \"Dummy\",\n \"lastName\": \"Demo\",\n \"fullName\": \"Dummy Demo\",\n \"userEmail\": \"dummy.demo@cztester.com\",\n \"phoneNumber\": \"5555666458\",\n \"address1\": \"Demo street address\",\n \"address2\": \"Demo street address 2\",\n \"Country\": \"USA\",\n \"State\": \"CA\",\n \"City\": \"LA\",\n \"zipCode\": \"22201\",\n \"ship_address1\": \"Demo street address\",\n \"ship_address2\": \"Demo street address 2\",\n \"ship_country\": \"USA\",\n \"ship_state\": \"CA\",\n \"ship_city\": \"LV\",\n \"ship_zipcode\": \"55524\",\n \"companyName\": \"Demo company name\",\n \"companyID\": \"545555221\",\n \"accept\": null,\n \"createdAt\": \"2021-01-11 11:44:13\",\n \"updatedAt\": \"2021-02-23 13:43:44\",\n \"listID\": \"1\",\n \"merchantID\": \"478\",\n \"profile_picture\": null,\n \"customerStatus\": \"true\",\n \"Balance\": \"312.06\"\n },\n ],\n \"code\": 200\n}"}],"_postman_id":"211cbba9-0fec-491c-a9e1-2a348deda61f"},{"name":"Create Customer Credit Card","id":"2a3ea416-adbf-40bd-b34c-25b1fccb429f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/create_customer_card","description":"

Add new credit card for customer.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer list ID	Yes	String	-	-
cardNo	Credit card number	Yes	Integer	-	Must be 15 or 16 digit number.
cardCvv	CVV Number	Yes	Integer	-	Must be 3 to 4 digit number.
expMonth	Expiration month	Yes	Integer	-	Month must be a two-digit number. For single-digit months, prepend with a leading zero (eg: 01-12).
expYear	Expiration year	Yes	Integer	-	Month and year combination must be future date.
friendlyName	Card friendly name	Yes	String	-	-
address1	Address 1	No	String	-	-
address2	Address 2	No	String	-	-
city	City name	No	String	-	-
state	State name	No	String	-	-
country	Country name or code	No	String	-	-
contact	Contact number	No	String	-	-
zipcode	Zipcode	No	Integer	-	-

","urlObject":{"path":["customer","create_customer_card"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7780d0df-515a-463b-84fa-a1684c4cc84b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjA5ODgwMjcsImNoayI6MTAzNTU5NjI3NSwic3RhcnQiOjE2MjA5ODgwMjcsImV4cGlyZSI6MTYyMDk5NTIyNywidXNlcm5hbWUiOiJjaHoxNzFAbWFpbGluYXRvci5jb20iLCJtaWQiOiIyMzMiLCJpZCI6IjIzMyIsInNlcnZpY2UiOiIyIiwiY29tcGFueSI6IjE0NyIsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.eVqCOStQFMe6vx_YyrduW6IS4-wgVFMSaAfvRCObquo","type":"text","description":"Acces Token Valid for 120 minutes"},{"key":"customerId","value":"9063401","type":"text","description":"Customer ID Required"},{"key":"cardNo","value":"4242424242424242","type":"text","description":"Required"},{"key":"cardCvv","value":"999","type":"text","description":"Required"},{"key":"expMonth","value":"10","type":"text","description":"Required"},{"key":"expYear","value":"2022","type":"text","description":"Required"},{"key":"friendlyName","value":"My Visa Card","type":"text","description":"Required"},{"key":"address1","value":"12th Street 12/58","type":"text","description":"Address1 Like 12th street 12/58 "},{"key":"address2","value":"Sec 4 ","type":"text"},{"key":"city","value":"LA","type":"text","description":"City"},{"key":"state","value":"CA","type":"text","description":"State"},{"key":"country","value":"US","type":"text","description":"Country (United States, Canada )"},{"key":"contact","value":"55555222132","type":"text","description":"Contact"},{"key":"zipcode","value":"78036","type":"text","description":"Number"}]},"url":"{{url}}/customer/create_customer_card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:18:12 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22425fa3b83e2e45a17b191f8219a39473%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597492%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D1c94ad1ec7753d832fe31f26e741ed14ae4dcae9; expires=Mon, 01-Mar-2021 13:18:12 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"106"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Card Created Successfuly\",\n \"data\": {\n \"cardID\": 1677,\n \"cardName\": \"Visa - 4242\"\n },\n \"code\": 200\n}"},{"id":"aa1b0e0f-e517-4e2f-85b1-a9c169a0216b","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjA5ODgwMjcsImNoayI6MTAzNTU5NjI3NSwic3RhcnQiOjE2MjA5ODgwMjcsImV4cGlyZSI6MTYyMDk5NTIyNywidXNlcm5hbWUiOiJjaHoxNzFAbWFpbGluYXRvci5jb20iLCJtaWQiOiIyMzMiLCJpZCI6IjIzMyIsInNlcnZpY2UiOiIyIiwiY29tcGFueSI6IjE0NyIsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.eVqCOStQFMe6vx_YyrduW6IS4-wgVFMSaAfvRCObquo","type":"text","description":"Acces Token Valid for 120 minutes"},{"key":"customerId","value":"9063401","type":"text","description":"Customer ID Required"},{"key":"cardNo","value":"4242424242424242","type":"text","description":"Required"},{"key":"cardCvv","value":"999","type":"text","description":"Required"},{"key":"expMonth","value":"10","type":"text","description":"Required"},{"key":"expYear","value":"2022","type":"text","description":"Required"},{"key":"friendlyName","value":"My Visa Card","type":"text","description":"Required"},{"key":"address1","value":"12th Street 12/58","type":"text","description":"Address1 Like 12th street 12/58 "},{"key":"address2","value":"Sec 4 ","type":"text"},{"key":"city","value":"LA","type":"text","description":"City"},{"key":"state","value":"CA","type":"text","description":"State"},{"key":"country","value":"US","type":"text","description":"Country (United States, Canada )"},{"key":"contact","value":"9874596851","type":"text","description":"Contact"},{"key":"zipcode","value":"78036","type":"text","description":"Number"}]},"url":"{{url}}/customer/create_customer_card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:18:56 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%220543f22bca48056c7e8bd1dbea902aa0%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597536%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D2482ef0a270b914c8e64652ffd8b7a3b3e41dc38; expires=Mon, 01-Mar-2021 13:18:56 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"106"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"customer\": \"

The Customer ID field is required.

\"\n },\n \"message\": \"Validation Error\",\n \"code\": 422\n}"}],"_postman_id":"2a3ea416-adbf-40bd-b34c-25b1fccb429f"},{"name":"Activate / Deactivate Customer","id":"d64efd8d-c6a7-4d45-aff0-e80e5d41520b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/update_customer_status","description":"

Activate and deactivate customer by customer list ID.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	customer list Id	Yes	String	-	-
status	customer status	Yes	Integer	-	Possible values are 1 and 0. 1 for actived and 0 for disabled.

","urlObject":{"path":["customer","update_customer_status"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"96a0ac4a-c28d-4406-9fd6-b093a33978ef","name":"Activate Success","originalRequest":{"method":"POST","header":[{"key":"secret_key","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTY4NDIsImNoayI6NjUzMzY3NTEyLCJzdGFydCI6MTYxNDU5Njg0MiwiZXhwaXJlIjoxNjE0NjA0MDQyLCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.GU5rX1vH8fr7NTm15Iu4lrD35sdZD72N1-42mMLIQIk"},{"description":"required","key":"customerID","type":"text","value":"8238306"},{"description":"required (1=>Enable, 0=> Desable)","key":"status","type":"text","value":"1"}]},"url":"{{url}}/customer/update_customer_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:21:42 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%229e48ca6ad910be4f54ab919cb51f6836%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597702%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dd259663ccc992749c96a920dc78b65d8ba348143; expires=Mon, 01-Mar-2021 13:21:42 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"729"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer enabled successfully\",\n \"data\": \"8238306\",\n \"code\": 200\n}"},{"id":"ad7ff038-4ec0-4143-89a2-82223ca58b9a","name":"Deactivate Success","originalRequest":{"method":"POST","header":[{"key":"secret_key","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTY4NDIsImNoayI6NjUzMzY3NTEyLCJzdGFydCI6MTYxNDU5Njg0MiwiZXhwaXJlIjoxNjE0NjA0MDQyLCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.GU5rX1vH8fr7NTm15Iu4lrD35sdZD72N1-42mMLIQIk"},{"description":"required","key":"customerID","type":"text","value":"8238306"},{"description":"required (1=>Enable, 0=> Desable)","key":"status","type":"text","value":"0"}]},"url":"{{url}}/customer/update_customer_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:22:18 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22f53cbf3adeed544da8b22aded62e9705%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597738%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Df8b2096f702ffaec33f7cecdddd102d3340f93c7; expires=Mon, 01-Mar-2021 13:22:18 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"730"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer disabled successfully\",\n \"data\": \"8238306\",\n \"code\": 200\n}"},{"id":"e429734b-445a-4701-91ec-8cb2bdef2cfa","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secret_key","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTY4NDIsImNoayI6NjUzMzY3NTEyLCJzdGFydCI6MTYxNDU5Njg0MiwiZXhwaXJlIjoxNjE0NjA0MDQyLCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.GU5rX1vH8fr7NTm15Iu4lrD35sdZD72N1-42mMLIQIk"},{"description":"required","key":"customerID","type":"text","value":"82383061"},{"description":"required (1=>Enable, 0=> Desable)","key":"status","type":"text","value":"0"}]},"url":"{{url}}/customer/update_customer_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:22:46 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22f343edffcf815889e997f427a068387e%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597766%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dac351858ab8872e392d00d213402f60d89ae04ca; expires=Mon, 01-Mar-2021 13:22:46 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"58"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Customer Data\",\n \"data\": null,\n \"code\": 400\n}"}],"_postman_id":"d64efd8d-c6a7-4d45-aff0-e80e5d41520b"},{"name":"Edit Customer Credit Card","id":"5cac7fb3-3834-410a-9883-d50d1d28944e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/edit_customer_card","description":"

Update a customer's credit card.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer list ID	Yes	String	-	-
cardId	Card Id	Yes	Integer	-	-
cardNo	Credit card number	Yes	Integer	-	Must be 15 or 16 digit number.
cardCvv	CVV Number	Yes	Integer	-	Must be 3 or 4 digit number.
expMonth	Expiration month	Yes	Integer	-	Month must be a two-digit number. For single-digit months, prepend with a leading zero (eg: 01-12).
expYear	Expiration year	Yes	Integer	-	Month and year combination must be future date.
friendlyName	Card friendly name	Yes	String	-	-
address1	Address 1	No	String	-	-
address2	Address 2	No	String	-	-
city	City name	No	String	-	-
state	State name	No	String	-	-
country	Country name or code	No	String	-	-
contact	Contact number	No	String	-	-
zipcode	Zipcode	No	Integer	-	-

","urlObject":{"path":["customer","edit_customer_card"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"337a596f-eb46-4c55-b780-9ebd1dbaf250","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjA5OTU1NjQsImNoayI6MTg2MzA2OTIxNywic3RhcnQiOjE2MjA5OTU1NjQsImV4cGlyZSI6MTYyMTAwMjc2NCwidXNlcm5hbWUiOiJjaHoxNzFAbWFpbGluYXRvci5jb20iLCJtaWQiOiIyMzMiLCJpZCI6IjIzMyIsInNlcnZpY2UiOiIyIiwiY29tcGFueSI6IjE0NyIsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.RZPQUV53rAfzW2WdahtL0U0_9_55_4ZwhPrY8-OBC0s","type":"text"},{"key":"customerId","value":"9063401","type":"text","description":"Customer ID"},{"key":"cardNo","value":"4242424242424242","type":"text","description":"Not Required"},{"key":"cardCvv","value":"1234","type":"text","description":"Not Required"},{"key":"expMonth","value":"03","type":"text","description":"Not Required"},{"key":"expYear","value":"2019","type":"text","description":"Not Required"},{"key":"friendlyName","value":"Demo Card","type":"text","description":"Not Required"},{"key":"cardId","value":"237","type":"text","description":"Required"},{"key":"address","value":"12th street","type":"text"},{"key":"city","value":"Dallas","type":"text"},{"key":"state","value":"Texas","type":"text"},{"key":"zipcode","value":"74025","type":"text"},{"key":"country","value":"US","type":"text"}]},"url":"{{url}}/customer/edit_customer_card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:24:05 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22303160131c525daa9ffa9db5e69b5601%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597845%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D1a0755bd1fe7a3bef5982e2cc7545227cf7728a8; expires=Mon, 01-Mar-2021 13:24:05 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"68"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer card updated successfully.\",\n \"data\": \"\",\n \"code\": 200\n}"}],"_postman_id":"5cac7fb3-3834-410a-9883-d50d1d28944e"},{"name":"Get Customer Credit Cards","id":"94dce706-bb20-4cf2-b777-00179d1b71e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/get_customer_card","description":"

Get customer's credit cards.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer ID	Yes	Integer	-	-

","urlObject":{"path":["customer","get_customer_card"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c5d7e7bd-4f92-4dee-ad82-090bd3911384","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTc5MzksImNoayI6MTI0ODUyMjk4MSwic3RhcnQiOjE2MTQ1OTc5MzksImV4cGlyZSI6MTYxNDYwNTEzOSwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.ufd7MGoOM7djIbd9KVMcBCm4rrEdMuIPZAHBIShTm-Y"},{"key":"customerId","type":"text","value":"12356"}]},"url":"{{url}}/customer/get_customer_card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:26:50 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%222b7266c9964aee7154fcec49f8b7725a%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614598010%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Ddb47e123dc4e18841e004122dbeb6e95fd2c39d5; expires=Mon, 01-Mar-2021 13:26:50 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"77"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Card\",\n \"data\": {\n \"cards\": [],\n \"customer_data\": []\n },\n \"code\": 200\n}"},{"id":"3cfe5964-8f00-4b90-ac1e-83fdf88b4397","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTc5MzksImNoayI6MTI0ODUyMjk4MSwic3RhcnQiOjE2MTQ1OTc5MzksImV4cGlyZSI6MTYxNDYwNTEzOSwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.ufd7MGoOM7djIbd9KVMcBCm4rrEdMuIPZAHBIShTm-Y"},{"key":"customerId","type":"text","value":"8238306"}]},"url":"{{url}}/customer/get_customer_card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:26:08 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2241a3439f59e3fbde2325cf86d1d12731%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614597968%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D6bf786a0b44aaf85038d5db4b484e0fbbaf96c7e; expires=Mon, 01-Mar-2021 13:26:08 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"889"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Card\",\n \"data\": {\n \"cards\": [\n {\n \"CardID\": \"1677\",\n \"CustomerCard\": \"4242\",\n \"cardMonth\": \"3\",\n \"cardYear\": \"2019\",\n \"CardType\": \"Visa\",\n \"CardCVV\": \"1234\",\n \"customerCardfriendlyName\": \"Demo Card\"\n }\n ],\n \"customer_data\": {\n \"customerID\": \"0\",\n \"Customer_ListID\": \"8238306\",\n \"firstName\": \"Demo\",\n \"lastName\": \"Customer\",\n \"fullName\": \"Demo Customer\",\n \"userEmail\": \"demo.customer@cztester.com\",\n \"phoneNumber\": \"5555522228\",\n \"address1\": \"Demo address 1\",\n \"address2\": \"Demo address 2\",\n \"Country\": \"United States\",\n \"State\": \"CA\",\n \"City\": \"LA\",\n \"zipCode\": \"75024\",\n \"ship_address1\": \"Demo street address 1\",\n \"ship_address2\": \"Demo street address 2\",\n \"ship_country\": \"United States\",\n \"ship_state\": \"CA\",\n \"ship_city\": \"LA\",\n \"ship_zipcode\": \"74025\",\n \"companyName\": \"Demo Company\",\n \"companyID\": \"8238306\",\n \"accept\": null,\n \"createdAt\": \"2021-03-01 11:07:53\",\n \"updatedAt\": \"2021-03-01 11:22:18\",\n \"listID\": \"8238306\",\n \"merchantID\": \"478\",\n \"profile_picture\": null,\n \"customerStatus\": \"false\"\n }\n },\n \"code\": 200\n}"}],"_postman_id":"94dce706-bb20-4cf2-b777-00179d1b71e9"},{"name":"Get Customer Credit Card","id":"6450c79b-2e45-429b-a94f-5696a4b8d160","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/get_single_card_data","description":"

Get customer's credit card.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer ID	Yes	Integer	-	-
cardId	Card ID	Yes	Integer	-	-

","urlObject":{"path":["customer","get_single_card_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f0a0c4ed-6433-47d2-abc5-85e68c185795","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTc5MzksImNoayI6MTI0ODUyMjk4MSwic3RhcnQiOjE2MTQ1OTc5MzksImV4cGlyZSI6MTYxNDYwNTEzOSwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.ufd7MGoOM7djIbd9KVMcBCm4rrEdMuIPZAHBIShTm-Y"},{"description":"required","key":"cardId","type":"text","value":"1677"},{"key":"customerId","type":"text","value":"8238306"}]},"url":"{{url}}/customer/get_single_card_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:27:55 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22259a4d383f567c9280694039252a5106%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614598075%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dde49ed91e6ea901b69508fae02c54ca97bf67007; expires=Mon, 01-Mar-2021 13:27:55 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"352"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Card\",\n \"data\": {\n \"CardID\": \"1677\",\n \"CustomerCard\": \"4242\",\n \"cardMonth\": \"3\",\n \"cardYear\": \"2019\",\n \"CardType\": \"Visa\",\n \"CardCVV\": \"1234\",\n \"customerCardfriendlyName\": \"Demo Card\",\n \"Billing_Addr1\": \"Demo address 1\",\n \"Billing_Addr2\": \"Demo address 2\",\n \"Billing_City\": \"Demo city\",\n \"Billing_State\": \"Demo State\",\n \"Billing_Zipcode\": \"74025\",\n \"Billing_Contact\": \"5555222222\"\n },\n \"code\": 200\n}"},{"id":"6b7dc83f-5a19-4090-bf2e-2f6d5e23efc0","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTc5MzksImNoayI6MTI0ODUyMjk4MSwic3RhcnQiOjE2MTQ1OTc5MzksImV4cGlyZSI6MTYxNDYwNTEzOSwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.ufd7MGoOM7djIbd9KVMcBCm4rrEdMuIPZAHBIShTm-Y"},{"description":"required","key":"cardId","type":"text","value":"16771"},{"key":"customerId","type":"text","value":"8238306"}]},"url":"{{url}}/customer/get_single_card_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:28:15 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22b23623fe291fa169897cdde8ed83e096%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614598095%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D1a8c5fd09916e7246bcbb1b3be169803eff082da; expires=Mon, 01-Mar-2021 13:28:15 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"50"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No record found\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"6450c79b-2e45-429b-a94f-5696a4b8d160"},{"name":"Delete Customer Credit Card","id":"be036811-0bc5-4ec7-b557-2a1d9508af70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/delete_customer_card","description":"

Delete customer's credit card.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer list ID	Yes	String	-	-
cardId	Card ID	Yes	Integer	-	-

","urlObject":{"path":["customer","delete_customer_card"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"dc6ed62b-68f6-4316-97ee-3e643e119b4a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTc5MzksImNoayI6MTI0ODUyMjk4MSwic3RhcnQiOjE2MTQ1OTc5MzksImV4cGlyZSI6MTYxNDYwNTEzOSwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.ufd7MGoOM7djIbd9KVMcBCm4rrEdMuIPZAHBIShTm-Y"},{"description":"Required","key":"cardId","type":"text","value":"1677"},{"description":"Required","key":"customerId","type":"text","value":"8238306"}]},"url":"{{url}}/customer/delete_customer_card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:29:21 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2294657bfd3672f4d1f80ee029d6754e89%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614598161%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D226f86bd2a1246f5eb9ec045cb9ce1ea434df86e; expires=Mon, 01-Mar-2021 13:29:21 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"68"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer card deleted Successfully.\",\n \"data\": \"\",\n \"code\": 200\n}"}],"_postman_id":"be036811-0bc5-4ec7-b557-2a1d9508af70"},{"name":"Create Customer Note","id":"0fb3abe2-a9a6-41fc-acb0-1caaf791d3ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/create_customer_note","description":"

Create a customer note.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer list Id	Yes	String	-	-
privateNote	Private note text	Yes	String	-	-

","urlObject":{"path":["customer","create_customer_note"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"605260c0-05f2-40ce-8cdb-147a69282500","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTgzMzYsImNoayI6MzIyNTQyNDI4LCJzdGFydCI6MTYxNDU5ODMzNiwiZXhwaXJlIjoxNjE0NjA1NTM2LCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.R7TW4cr22Rd_ehJoL7dl8IRzlg65ZrGix5YRvFK3wRo"},{"description":"requied","key":"customerId","type":"text","value":"8238306"},{"description":"required","key":"privateNote","type":"text","value":"This is test customer note"}]},"url":"{{url}}/customer/create_customer_note"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 11:33:11 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22a6aacd75e95922286b89142163a2ec01%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614598391%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D141c1d9c038610dcf472393ac4491519526bb5dd; expires=Mon, 01-Mar-2021 13:33:11 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"68"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Private note created successfully.\",\n \"data\": 32,\n \"code\": 200\n}"}],"_postman_id":"0fb3abe2-a9a6-41fc-acb0-1caaf791d3ab"},{"name":"Get Customer Notes","id":"6cb59fb9-c12c-45cb-bf85-c514aacfabb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/get_customer_notes","description":"

Get customer's notes.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer list Id	Yes	String	-	-

","urlObject":{"path":["customer","get_customer_notes"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0cb19a22-b72f-4437-a784-4ba5c14e4c3e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Access Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTgzMzYsImNoayI6MzIyNTQyNDI4LCJzdGFydCI6MTYxNDU5ODMzNiwiZXhwaXJlIjoxNjE0NjA1NTM2LCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.R7TW4cr22Rd_ehJoL7dl8IRzlg65ZrGix5YRvFK3wRo"},{"description":"QBO Customer ID","key":"customerId","type":"text","value":"8238306"}]},"url":"{{url}}/customer/get_customer_notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:05:00 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2205b5274387ea1b292e7fb9ab46246cad%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614600300%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D7658c27e645a71f1d2b8c1cfac1e8921bbd93ec8; expires=Mon, 01-Mar-2021 14:05:00 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"216"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"All Customer Notes\",\n \"data\": [\n {\n \"noteID\": \"32\",\n \"privateNote\": \"This is demo note\",\n \"privateNoteDate\": \"2021-03-01 11:33:11\",\n \"customerID\": \"8238306\",\n \"merchantID\": \"478\",\n \"fullName\": \"demo\"\n }\n ],\n \"code\": 200\n}"},{"id":"de565515-3e7a-42ad-8a79-244f8884cb66","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Access Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTgzMzYsImNoayI6MzIyNTQyNDI4LCJzdGFydCI6MTYxNDU5ODMzNiwiZXhwaXJlIjoxNjE0NjA1NTM2LCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.R7TW4cr22Rd_ehJoL7dl8IRzlg65ZrGix5YRvFK3wRo"},{"description":"QBO Customer ID","key":"customerId","type":"text","value":"82383061"}]},"url":"{{url}}/customer/get_customer_notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:05:21 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22990a5c2c527dc3df1d54fb0d9ddeb158%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614600321%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dbf3ede35f53060eb53cbc27aa71f394da878a512; expires=Mon, 01-Mar-2021 14:05:21 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"50"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No record found\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"6cb59fb9-c12c-45cb-bf85-c514aacfabb3"},{"name":"Delete Customer Note","id":"11d9f684-c897-4d59-9fe4-7c1fa22403da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/delete_customer_note","description":"

Delete customer note.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer list Id	Yes	String	-	-
noteId	Note Id	Yes	Integer	-	-

","urlObject":{"path":["customer","delete_customer_note"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"807cb565-0990-41c8-9c31-9031372bb390","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTgzMzYsImNoayI6MzIyNTQyNDI4LCJzdGFydCI6MTYxNDU5ODMzNiwiZXhwaXJlIjoxNjE0NjA1NTM2LCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.R7TW4cr22Rd_ehJoL7dl8IRzlg65ZrGix5YRvFK3wRo"},{"description":"requied","key":"customerId","type":"text","value":"8238306"},{"description":"required","key":"noteId","type":"text","value":"32"}]},"url":"{{url}}/customer/delete_customer_note"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:06:24 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22aee28c93f6345ff2e88e5a8e6ba6c5e9%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614600384%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7De82da996d48954f988bf4e148f796a45e6023046; expires=Mon, 01-Mar-2021 14:06:24 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"68"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer note deleted successfully.\",\n \"data\": \"\",\n \"code\": 200\n}"}],"_postman_id":"11d9f684-c897-4d59-9fe4-7c1fa22403da"},{"name":"Get Customer Subscriptions","id":"d842d369-7e68-4268-af0e-bcc2413df569","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/customer/get_customer_subscriptions_data","description":"

Get all subscriptions by customer ID.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	customer list ID	Yes	String	-	-

","urlObject":{"path":["customer","get_customer_subscriptions_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7c5ee4cb-02ec-46bf-958f-22726d74cca0","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTgzMzYsImNoayI6MzIyNTQyNDI4LCJzdGFydCI6MTYxNDU5ODMzNiwiZXhwaXJlIjoxNjE0NjA1NTM2LCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.R7TW4cr22Rd_ehJoL7dl8IRzlg65ZrGix5YRvFK3wRo"},{"description":"requred","key":"customerId","type":"text","value":"74"}]},"url":"{{url}}/customer/get_customer_subscriptions_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:14:31 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%220931518cc69ce0fa077a79e1042de171%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614600871%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Db95bc1ae21810ff1bb51137e56c017f67bb372e3; expires=Mon, 01-Mar-2021 14:14:31 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"1478"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Subscriptions\",\n \"data\": [\n {\n \"subscriptionID\": \"96\",\n \"customerID\": \"2\",\n \"merchantDataID\": \"478\",\n \"subscriptionName\": \"\",\n \"subscriptionPlan\": \"0\",\n \"freeTrial\": \"0\",\n \"invoiceFrequency\": \"mon\",\n \"subscriptionAmount\": \"2.00\",\n \"totalInvoice\": \"0\",\n \"generatedInvoice\": \"0\",\n \"totalAmount\": null,\n \"paidAmount\": null,\n \"generatingDate\": \"1\",\n \"firstDate\": \"2020-02-01\",\n \"nextGeneratingDate\": \"2020-02-01\",\n \"startDate\": \"2020-01-20\",\n \"endDate\": \"2020-01-20\",\n \"paymentGateway\": \"0\",\n \"automaticPayment\": \"1\",\n \"emailRecurring\": \"0\",\n \"usingExistingAddress\": \"0\",\n \"cardID\": \"1670\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"baddress1\": null,\n \"baddress2\": null,\n \"bcountry\": null,\n \"bstate\": null,\n \"bcity\": null,\n \"bzipcode\": null,\n \"bphone\": null,\n \"contactNumber\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"taxID\": \"0\",\n \"planID\": \"48\",\n \"subscriptionStatus\": \"1\",\n \"fullName\": \"Bill's Windsurf Shop\",\n \"companyName\": \"Bill's Windsurf Shop\",\n \"planName\": null,\n \"gatewayID\": null,\n \"gatewayFriendlyName\": null,\n \"gatewayUsername\": null,\n \"gatewayPassword\": null,\n \"gatewaySignature\": null,\n \"merchantID\": null,\n \"gatewayType\": null,\n \"status\": null,\n \"gatewayMerchantID\": null,\n \"creditCard\": null,\n \"echeckStatus\": null,\n \"isSurcharge\": null,\n \"surchargePercentage\": null,\n \"set_as_default\": null,\n \"enable_level_three_data\": null,\n \"items\": [\n {\n \"itemID\": \"222\",\n \"itemListID\": \"27\",\n \"itemFullName\": \"test description\",\n \"itemDescription\": \"test description\",\n \"itemQuantity\": \"1\",\n \"itemRate\": \"2.00\",\n \"itemTax\": \"0\",\n \"oneTimeCharge\": \"0\",\n \"subscriptionID\": \"96\",\n \"invoiceDataID\": \"0\"\n }\n ]\n }\n ],\n \"code\": 200\n}"},{"id":"04ad6ad8-2df9-474d-91ff-08d7fcffdb19","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ1OTgzMzYsImNoayI6MzIyNTQyNDI4LCJzdGFydCI6MTYxNDU5ODMzNiwiZXhwaXJlIjoxNjE0NjA1NTM2LCJ1c2VybmFtZSI6ImhwY29ycC51czJAbWFpbGluYXRvci5jb20iLCJtaWQiOiI0NzgiLCJpZCI6IjQ3OCIsInNlcnZpY2UiOiIxIiwiY29tcGFueSI6IjQ2MjA4MTYzNjUxNTcyNTk5NjAiLCJkb21haW4iOiJodHRwczpcL1wvaHBjaW5jLnBheXBvcnRhbHN0YWdpbmcuY29tXC8iLCJyb2xlIjoibWVyY2hhbnQifQ.R7TW4cr22Rd_ehJoL7dl8IRzlg65ZrGix5YRvFK3wRo"},{"description":"requred","key":"customerId","type":"text","value":"456"}]},"url":"{{url}}/customer/get_customer_subscriptions_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 12:14:51 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%224ae6cce52bd42067db69ba4b60731501%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614600891%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D81e201370d1523df8567c334b36f926c63aefdb0; expires=Mon, 01-Mar-2021 14:14:51 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"50"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No record found\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"d842d369-7e68-4268-af0e-bcc2413df569"}],"id":"a771d1a3-f4a7-4a3d-a952-51c5aad348f7","_postman_id":"a771d1a3-f4a7-4a3d-a952-51c5aad348f7","description":""},{"name":"Items","item":[{"name":"Create / Edit Product","id":"7234b844-9aa9-45fb-911b-cf4336659c0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/item/create_item","description":"

Create a new product or update an existing product based on the product ID.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
sku	Product SKU	No	String	-	-
productName	Product Name	Yes	String	-	-
productType	Product type	Yes	String	-	Product type can be one of these options: Service, Inventory, OtherCharge and NonInventory
quantityOnHand	Product quantity	No	Integer	-	-
incomeAccount	Income Account	No	String	-	-
expenseAccount	Expense Account	No	String	-	-
assetAccountRef	Reference Number	No	String	-	-
salePrice	Sale Price	No	Float	-	-
purchasePrice	Purchase Price	No	String	-	-
saleProDescription	Sales description	No	String	-	-
purProDescription	Purchase description	No	String	-	-
productId	Product ID (required if updating an existing product)	No	String	-	-
productParent	Parent Product ID	No	String	-	-

","urlObject":{"path":["item","create_item"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d96934b3-12b6-485b-94c0-e92b1af8fb67","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjA5OTU1NjQsImNoayI6MTg2MzA2OTIxNywic3RhcnQiOjE2MjA5OTU1NjQsImV4cGlyZSI6MTYyMTAwMjc2NCwidXNlcm5hbWUiOiJjaHoxNzFAbWFpbGluYXRvci5jb20iLCJtaWQiOiIyMzMiLCJpZCI6IjIzMyIsInNlcnZpY2UiOiIyIiwiY29tcGFueSI6IjE0NyIsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.RZPQUV53rAfzW2WdahtL0U0_9_55_4ZwhPrY8-OBC0s","type":"text","description":"Requred"},{"key":"productName","value":"Product Test 1001","type":"text","description":"Requred"},{"key":"productType","value":"Service","type":"text","description":"Required Type(Service, Inventory)"},{"key":"quantityOnHand","value":"100","type":"text","description":"Inventory"},{"key":"incomeAccount","value":"79","type":"text","description":"Inventory"},{"key":"expenseAccount","value":"80","type":"text","description":"Inventory"},{"key":"datePick","value":"2019-04-10","type":"text","description":"Both"},{"key":"assetAccountRef","value":"81","type":"text","description":"Inventory"},{"key":"salePrice","value":"25","type":"text","description":"Inventory"},{"key":"purchasePrice","value":"20","type":"text","description":"Inventory"},{"key":"saleProDescription","value":"Test 23 Inventory Services","type":"text","description":"Inventory"},{"key":"purProDescription","value":"Test 23 Inventory Purchase Services","type":"text","description":"Inventory"},{"key":"productId","value":"37","type":"text"},{"key":"sku","value":"4752","type":"text"},{"key":"productParent","value":"","type":"text"}]},"url":"{{url}}/item/create_item"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:15:50 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22f246766cb24843785bb31454e8b41aa9%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604550%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D796e0289855539b1caa13ed3d7d2ae8dc97d0f8c; expires=Mon, 01-Mar-2021 15:15:50 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"64"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item created successfully.\",\n \"data\": 369449,\n \"code\": 200\n}"}],"_postman_id":"7234b844-9aa9-45fb-911b-cf4336659c0c"},{"name":"Get Product","id":"002a9f2b-8226-4c72-84b9-65e0053cff45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/item/get_item_details","description":"

Get product.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
productId	Product Id	Yes	Integer	-	-

","urlObject":{"path":["item","get_item_details"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cbe9fe15-0fab-4180-957a-8158c52ff02b","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20","type":"text"},{"key":"productId","value":"3694491","type":"text"}]},"url":"{{url}}/item/get_item_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:17:55 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22ef6185bb896bb8e7f93838952f24138c%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604675%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D3f83f9ea36d572d7ca9490b6d250ecb8b0dba63c; expires=Mon, 01-Mar-2021 15:17:55 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"52"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item not found.\",\n \"data\": [],\n \"code\": 400\n}"},{"id":"7fae0863-fb73-4ad8-92f4-ec024df16613","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20","type":"text"},{"key":"productId","value":"369449","type":"text"}]},"url":"{{url}}/item/get_item_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:17:28 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2213e06533b2b16608942d16d34b678cbe%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604648%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D6b17b84b6a90ff72d54de452d12abcb798438365; expires=Mon, 01-Mar-2021 15:17:28 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"534"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item details\",\n \"data\": {\n \"ListID\": \"24926\",\n \"productID\": \"369449\",\n \"IsActive\": \"true\",\n \"TimeCreated\": \"2021-03-01 13:16:12\",\n \"TimeModified\": \"2021-03-01 13:16:12\",\n \"Name\": \"Test12322 Services\",\n \"SKU\": \"4752\",\n \"SalesDescription\": \"Test23 Service\",\n \"saleCost\": \"5\",\n \"Type\": \"Service\",\n \"parent_ListID\": \"0\",\n \"QuantityOnHand\": \"0\",\n \"InvStartDate\": \"2021-03-01\",\n \"AssetAccountRef\": \"0\",\n \"purchaseCost\": \"4\",\n \"purchaseDesc\": \"Test Purchase 23\",\n \"IncomeAccountRef\": \"85\",\n \"ExpenseAccountRef\": \"24\",\n \"CompanyID\": \"4620816365157259960\",\n \"merchantID\": \"478\"\n },\n \"code\": 200\n}"}],"_postman_id":"002a9f2b-8226-4c72-84b9-65e0053cff45"},{"name":"Activate Product","id":"528e98a5-8850-40e4-b6af-6db15c6ac0ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/item/activate_item","description":"

Activate product.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
productId	Product ID	Yes	Integer	-	-

","urlObject":{"path":["item","activate_item"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3130038b-6f03-4b2d-8214-543675a5cb7f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20","type":"text"},{"key":"productId","value":"369449","type":"text"}]},"url":"{{url}}/item/activate_item"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:19:09 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22b91067af196d05404ffedbd196bb0e52%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604749%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Db102cfa98a278c8c66fcc0db905e8bf043d076fd; expires=Mon, 01-Mar-2021 15:19:09 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"543"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item enabled successfully.\",\n \"data\": {\n \"ListID\": \"24926\",\n \"productID\": \"369449\",\n \"IsActive\": \"true\",\n \"TimeCreated\": \"2021-03-01 13:16:12\",\n \"TimeModified\": \"2021-03-01 13:19:09\",\n \"Name\": \"Test12322 Services\",\n \"SKU\": \"4752\",\n \"SalesDescription\": \"Test23 Service\",\n \"saleCost\": \"5\",\n \"Type\": \"Service\",\n \"parent_ListID\": \"0\",\n \"QuantityOnHand\": \"0\",\n \"InvStartDate\": \"2021-03-01\",\n \"AssetAccountRef\": \"0\",\n \"purchaseCost\": \"4\",\n \"purchaseDesc\": \"Test Purchase 23\",\n \"IncomeAccountRef\": \"85\",\n \"ExpenseAccountRef\": \"24\",\n \"CompanyID\": \"4620816365157259960\",\n \"merchantID\": \"478\"\n },\n \"code\": 200\n}"},{"id":"aa12ff33-2f28-424a-8e51-5d345584337c","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20","type":"text"},{"key":"productId","value":"3694491","type":"text"}]},"url":"{{url}}/item/activate_item"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:19:23 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%228737ac07054af4e92618a426353805da%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604763%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D2f2c89f2d01a86545f0f8850433745e46b2e469f; expires=Mon, 01-Mar-2021 15:19:23 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"59"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item not found.\",\n \"data\": \"\",\n \"code\": 400\n}"}],"_postman_id":"528e98a5-8850-40e4-b6af-6db15c6ac0ef"},{"name":"Deactivate Product","id":"aa6d7fae-f593-4988-982b-127380d86366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/item/deactivate_item","description":"

Deactivate product.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
productId	Product ID	Yes	Integer	-	-

","urlObject":{"path":["item","deactivate_item"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b3e98b0d-ce50-444c-89e5-c61f21318bab","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20"},{"key":"productId","type":"text","value":"3694491"}]},"url":"{{url}}/item/deactivate_item"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:20:32 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%229a05aca52555450e67ee0d6d288db167%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604832%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D2767f59854f787b93deff60dc63426242a89c9a8; expires=Mon, 01-Mar-2021 15:20:32 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"52"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item not found.\",\n \"data\": \"\",\n \"code\": 400\n}"},{"id":"137c81af-383b-4831-987b-b39e703b42f6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20"},{"key":"productId","type":"text","value":"369449"}]},"url":"{{url}}/item/deactivate_item"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:20:15 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22517713d09f641c01321b368f76360482%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604815%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D57d2525236f012033f4e894451ae2e7a4f5a3f71; expires=Mon, 01-Mar-2021 15:20:15 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"67"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item disabled successfully.\",\n \"data\": \"369449\",\n \"code\": 200\n}"}],"_postman_id":"aa6d7fae-f593-4988-982b-127380d86366"},{"name":"Get All Products","id":"687e7dee-b6fe-41a6-a0df-e9c3598bb473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/item/get_items_data","description":"

Get all products.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
page	Page number	No	Integer	-	-
limit	Per page records	No	Integer	-	-

","urlObject":{"path":["item","get_items_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c3eda149-8888-4f42-bf4e-89ad4c28e3ba","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20"},{"key":"page","value":"","type":"text"},{"key":"limit","value":"","type":"text"}]},"url":"{{url}}/item/get_items_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:21:06 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%223dc6a8f2e284944a492d5eedfa24d9e0%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604866%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D5dc458de25e581b748c863300b8afbe832ef7730; expires=Mon, 01-Mar-2021 15:21:06 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"2866"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item list\",\n \"data\": [],\n \"code\": 200\n}"},{"id":"26dd4cab-4672-4bbe-9e21-1e3f60fd446e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2MDMyMTQsImNoayI6MTQyMzU2MDc1NCwic3RhcnQiOjE2MTQ2MDMyMTQsImV4cGlyZSI6MTYxNDYxMDQxNCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Zu0qrmtizk6npJQ2k01D0hb_A_9o0JCnCWxSUwTbp20"},{"key":"page","value":"","type":"text"},{"key":"limit","value":"20","type":"text"}]},"url":"{{url}}/item/get_items_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Mar 2021 13:21:06 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%223dc6a8f2e284944a492d5eedfa24d9e0%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614604866%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D5dc458de25e581b748c863300b8afbe832ef7730; expires=Mon, 01-Mar-2021 15:21:06 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"2866"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Item list\",\n \"data\": [\n {\n \"ListID\": \"24914\",\n \"productID\": \"22\",\n \"IsActive\": \"true\",\n \"TimeCreated\": \"2020-12-21 11:18:31\",\n \"TimeModified\": \"2020-12-21 11:18:31\",\n \"Name\": \"Hours\",\n \"SKU\": null,\n \"SalesDescription\": null,\n \"saleCost\": \"0\",\n \"Type\": \"Service\",\n \"parent_ListID\": null,\n \"QuantityOnHand\": null,\n \"InvStartDate\": null,\n \"AssetAccountRef\": null,\n \"purchaseCost\": \"0\",\n \"purchaseDesc\": null,\n \"IncomeAccountRef\": \"153\",\n \"ExpenseAccountRef\": null,\n \"CompanyID\": \"4620816365157259960\",\n \"merchantID\": \"478\"\n },\n {\n \"ListID\": \"24915\",\n \"productID\": \"21\",\n \"IsActive\": \"true\",\n \"TimeCreated\": \"2020-12-21 11:18:31\",\n \"TimeModified\": \"2021-01-08 13:24:01\",\n \"Name\": \"HP Services\",\n \"SKU\": \"HP100\",\n \"SalesDescription\": \"HP services\",\n \"saleCost\": \"50\",\n \"Type\": \"Service\",\n \"parent_ListID\": null,\n \"QuantityOnHand\": null,\n \"InvStartDate\": null,\n \"AssetAccountRef\": null,\n \"purchaseCost\": \"45\",\n \"purchaseDesc\": \"HP services\",\n \"IncomeAccountRef\": \"153\",\n \"ExpenseAccountRef\": \"146\",\n \"CompanyID\": \"4620816365157259960\",\n \"merchantID\": \"478\"\n },\n {\n \"ListID\": \"24916\",\n \"productID\": \"23\",\n \"IsActive\": \"true\",\n \"TimeCreated\": \"2020-12-21 11:28:35\",\n \"TimeModified\": \"2021-01-08 13:24:01\",\n \"Name\": \"CZ Services\",\n \"SKU\": \"100\",\n \"SalesDescription\": \"Services\",\n \"saleCost\": \"100\",\n \"Type\": \"Service\",\n \"parent_ListID\": \"21\",\n \"QuantityOnHand\": null,\n \"InvStartDate\": null,\n \"AssetAccountRef\": null,\n \"purchaseCost\": \"99\",\n \"purchaseDesc\": \"Services\",\n \"IncomeAccountRef\": \"124\",\n \"ExpenseAccountRef\": \"157\",\n \"CompanyID\": \"4620816365157259960\",\n \"merchantID\": \"478\"\n },\n {\n \"ListID\": \"24917\",\n \"productID\": \"24\",\n \"IsActive\": \"true\",\n \"TimeCreated\": \"2021-02-23 13:24:40\",\n \"TimeModified\": \"2021-02-26 00:00:06\",\n \"Name\": \"Meizu Mobile\",\n \"SKU\": \"1000\",\n \"SalesDescription\": \"Meizu Mobile\",\n \"saleCost\": \"1500\",\n \"Type\": \"Inventory\",\n \"parent_ListID\": null,\n \"QuantityOnHand\": \"994\",\n \"InvStartDate\": \"2021-02-23\",\n \"AssetAccountRef\": \"164\",\n \"purchaseCost\": \"1555\",\n \"purchaseDesc\": \"Meizu Mobile\",\n \"IncomeAccountRef\": \"128\",\n \"ExpenseAccountRef\": \"163\",\n \"CompanyID\": \"4620816365157259960\",\n \"merchantID\": \"478\"\n },\n {\n \"ListID\": \"24926\",\n \"productID\": \"369449\",\n \"IsActive\": \"false\",\n \"TimeCreated\": \"2021-03-01 13:16:12\",\n \"TimeModified\": \"2021-03-01 13:20:15\",\n \"Name\": \"Test12322 Services\",\n \"SKU\": \"4752\",\n \"SalesDescription\": \"Test23 Service\",\n \"saleCost\": \"5\",\n \"Type\": \"Service\",\n \"parent_ListID\": \"0\",\n \"QuantityOnHand\": \"0\",\n \"InvStartDate\": \"2021-03-01\",\n \"AssetAccountRef\": \"0\",\n \"purchaseCost\": \"4\",\n \"purchaseDesc\": \"Test Purchase 23\",\n \"IncomeAccountRef\": \"85\",\n \"ExpenseAccountRef\": \"24\",\n \"CompanyID\": \"4620816365157259960\",\n \"merchantID\": \"478\"\n },\n {\n \"ListID\": \"24927\",\n \"productID\": \"335265\",\n \"IsActive\": \"true\",\n \"TimeCreated\": \"2021-03-01 13:16:47\",\n \"TimeModified\": \"2021-03-01 13:16:47\",\n \"Name\": \"Test12322 Services\",\n \"SKU\": \"\",\n \"SalesDescription\": \"Test23 Service\",\n \"saleCost\": \"5\",\n \"Type\": \"Service\",\n \"parent_ListID\": \"0\",\n \"QuantityOnHand\": \"0\",\n \"InvStartDate\": \"2021-03-01\",\n \"AssetAccountRef\": \"0\",\n \"purchaseCost\": \"4\",\n \"purchaseDesc\": \"Test Purchase 23\",\n \"IncomeAccountRef\": \"85\",\n \"ExpenseAccountRef\": \"24\",\n \"CompanyID\": \"4620816365157259960\",\n \"merchantID\": \"478\"\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"687e7dee-b6fe-41a6-a0df-e9c3598bb473"}],"id":"baefcb99-b1a4-4627-a195-21cc6fe877c2","_postman_id":"baefcb99-b1a4-4627-a195-21cc6fe877c2","description":""},{"name":"Invoices","item":[{"name":"Get All Invoices","id":"07010365-7dff-41ff-b5f1-c946b52fafb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/invoices/get_invoice_data","description":"

Get invoices.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
page	Page number	No	Integer	-	-
limit	Per page records	No	Integer	-	-

","urlObject":{"path":["invoices","get_invoice_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ff7c2556-09a2-4412-9149-33ac8328b9c3","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e","description":"required"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v4","description":"Required"},{"key":"page","value":"0","type":"text"},{"key":"limit","value":"5","type":"text"}]},"url":"{{url}}/invoices/get_invoice_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 07:15:36 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2287e1f1156000a5590cb768b6ccdffea3%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614323736%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D7b76c6ef32dfc886fc2799b81e05c191a2dcb312; expires=Fri, 26-Feb-2021 09:15:36 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"46"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"data\":[],\n \"message\": \"No record found\"\n}"},{"id":"9b12f07d-3c59-4b27-b96a-244d50bbbcaa","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e","description":"required"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v41","description":"Required"},{"key":"page","value":"0","type":"text"},{"key":"limit","value":"5","type":"text"}]},"url":"{{url}}/invoices/get_invoice_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 07:15:04 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22bf52c8d5a955974a2b92a04d36c919c1%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614323704%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D551386de47944629211c7dd75f15bebb22cc3b91; expires=Fri, 26-Feb-2021 09:15:04 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"3291"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice\",\n \"data\": [\n {\n \"id\": \"38373\",\n \"invoiceID\": \"274\",\n \"TimeCreated\": \"2021-02-25 12:00:03\",\n \"TimeModified\": \"2021-02-25 12:00:03\",\n \"refNumber\": \"CZ10051\",\n \"CustomerListID\": \"74\",\n \"CustomerFullName\": null,\n \"ShipAddress_Addr1\": \"90 - H\",\n \"ShipAddress_Addr2\": \"\",\n \"ShipAddress_City\": \"LA\",\n \"ShipAddress_State\": \"\",\n \"ShipAddress_Country\": \"USA\",\n \"ShipAddress_Province\": null,\n \"ShipAddress_PostalCode\": \"956238\",\n \"BalanceRemaining\": \"0\",\n \"Total_payment\": \"1500.00\",\n \"AppliedAmount\": \"1500.00\",\n \"DueDate\": \"2021-02-25\",\n \"IsPaid\": \"1\",\n \"UserStatus\": \"0\",\n \"insertInvID\": \"0\",\n \"companyID\": \"4620816365157259960\",\n \"merchantID\": \"478\",\n \"taxID\": null,\n \"taxRate\": \"0.00\",\n \"totalTax\": \"0.00\",\n \"BillAddress_Addr1\": \"Billing address 1\",\n \"BillAddress_Addr2\": \"Billing address 2\",\n \"BillAddress_City\": \"LA\",\n \"BillAddress_State\": \"LA\",\n \"BillAddress_Country\": \"USA\",\n \"BillAddress_PostalCode\": \"956238\",\n \"isDeleted\": \"0\",\n \"custname\": \"Demo Customer\"\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"07010365-7dff-41ff-b5f1-c946b52fafb1"},{"name":"Get Invoice","id":"e273e040-c6cc-42d8-ac77-c7cae7f348ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/invoices/get_invoice_details","description":"

Get invoice.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
invoiceId	Invoice ID	Yes	String	-	-

","urlObject":{"path":["invoices","get_invoice_details"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5dfa3568-0098-4452-917a-f69bfb72ba78","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v41"},{"key":"invoiceId","type":"text","value":"279"}]},"url":"{{url}}/invoices/get_invoice_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 07:27:29 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22e9c8ddb53ca5e59854119536dd7b0218%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614324449%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D2095a8ae6bf4061f53f80beb015a5ef12ba1645a; expires=Fri, 26-Feb-2021 09:27:29 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"1137"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice\",\n \"data\": {\n \"id\": \"38375\",\n \"invoiceID\": \"279\",\n \"TimeCreated\": \"2021-02-26 00:00:06\",\n \"TimeModified\": \"2021-02-26 00:00:06\",\n \"refNumber\": \"CZ10054\",\n \"CustomerListID\": \"64\",\n \"CustomerFullName\": null,\n \"ShipAddress_Addr1\": \"\",\n \"ShipAddress_Addr2\": \"\",\n \"ShipAddress_City\": \"\",\n \"ShipAddress_State\": \"\",\n \"ShipAddress_Country\": \"\",\n \"ShipAddress_Province\": null,\n \"ShipAddress_PostalCode\": \"\",\n \"BalanceRemaining\": \"1500.00\",\n \"Total_payment\": \"1500.00\",\n \"AppliedAmount\": \"0.00\",\n \"DueDate\": \"2021-02-26\",\n \"IsPaid\": \"0\",\n \"UserStatus\": \"0\",\n \"insertInvID\": \"0\",\n \"companyID\": \"4620816365157259960\",\n \"merchantID\": \"478\",\n \"taxID\": null,\n \"taxRate\": \"0.00\",\n \"totalTax\": \"0.00\",\n \"BillAddress_Addr1\": \"Demo address 1\",\n \"BillAddress_Addr2\": \"Demo address 2\",\n \"BillAddress_City\": \"LA\",\n \"BillAddress_State\": \"CA\",\n \"BillAddress_Country\": \"USA\",\n \"BillAddress_PostalCode\": \"258741\",\n \"isDeleted\": \"0\",\n \"custname\": \"Demo customer\",\n \"line_items\": [\n {\n \"itemLineID\": \"387967\",\n \"invoiceID\": \"279\",\n \"itemID\": \"1\",\n \"itemRefID\": \"24\",\n \"merchantID\": \"478\",\n \"releamID\": \"4620816365157259960\",\n \"totalAmount\": \"1500.00\",\n \"itemQty\": \"1\",\n \"itemDescription\": \"Demo item 1\",\n \"itemPrice\": \"1500.00\",\n \"createdAt\": \"2021-02-26 07:26:44\",\n \"itemTax\": \"0\"\n }\n ]\n },\n \"code\": 200\n}"},{"id":"018efcb6-d39f-4f4c-8c48-83f02a759cd4","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v4"},{"key":"invoiceId","type":"text","value":"279"}]},"url":"{{url}}/invoices/get_invoice_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 07:28:06 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%220cf1a5d0e5e502c9ffe75627b70e9931%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614324486%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Db71f3fead15a641abb8e422bb3a1da0b1c3d41b5; expires=Fri, 26-Feb-2021 09:28:06 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"50"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No record found\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"e273e040-c6cc-42d8-ac77-c7cae7f348ce"},{"name":"Schedule Invoice","id":"db2026fd-9a87-445f-903c-814681ec339f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/invoices/schedule_invoice","description":"

Schedule an Invoice

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
scheduleDate	Schedule Date	Yes	String	-	Date format: YYYY-MM-DD
scheduleId	Invoice Id	Yes	String	-	-
scheduleAmount	Amount	Yes	Float	-	-
scheduleCardId	Card Id	Yes	Integer	-	-
scheduleGateway	Gateway Id	Yes	Integer	-	-
scheduleMethod	Schedule Method	Yes	Integer	-	1 For Credit Card and 2 for ACH/eCheck

","urlObject":{"path":["invoices","schedule_invoice"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a3cea7ee-f422-411c-86fb-754141b296cd","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v4"},{"description":"Required (mm/dd/YYYY)","key":"scheduleDate","type":"text","value":"05/25/2019"},{"description":"Required (Invoice ID)","key":"scheduleId","type":"text","value":"610"},{"description":"Required","key":"scheduleAmount","type":"text","value":"2.18"},{"key":"scheduleCardId","type":"text","value":"772"},{"description":"Required","key":"scheduleGateway","type":"text","value":"91"},{"description":"Required (Credit Card, Checking Account )","key":"scheduleMethod","type":"text","value":"1"}]},"url":"{{url}}/invoices/schedule_invoice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 07:33:33 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2242b21b525a52b6453f156db7dfb66ff2%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614324813%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D034d4ae78a3ee92381b2f6ab0d354210a7f57f75; expires=Fri, 26-Feb-2021 09:33:33 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"67"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice scheduled successfully.\",\n \"data\": \"279\",\n \"code\": 200\n}"},{"id":"677f022a-2d8c-436d-ae65-deb4cf9ff319","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v4"},{"description":"Required (mm/dd/YYYY)","key":"scheduleDate","type":"text","value":"05/25/2019"},{"description":"Required (Invoice ID)","key":"scheduleID","type":"text","value":"610"},{"description":"Required","key":"scheduleAmount","type":"text","value":"2.18"},{"key":"scheduleCardId","type":"text","value":"772"},{"description":"Required","key":"scheduleGateway","type":"text","value":"91"},{"description":"Required (Credit Card, Checking Account )","key":"scheduleMethod","type":"text","value":"1"}]},"url":"{{url}}/invoices/schedule_invoice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 07:34:24 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22a465a40487fc5ad451141cf5ae890c3e%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614324864%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Db3aff63f21b40b9df5a7df79cfd8833d48a9ff80; expires=Fri, 26-Feb-2021 09:34:24 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"53"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Invoice\",\n \"data\": \"610\",\n \"code\": 400\n}"}],"_postman_id":"db2026fd-9a87-445f-903c-814681ec339f"},{"name":"Get Customer Invoices","id":"2b66de78-d2fe-4d59-a6f9-068fd9a514e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/invoices/get_customer_invoices_data","description":"

Get customer invoices.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer Id	Yes	String	-	-
type	Invoice Status Type	Yes	Integer	0	0 for Outstanding invoices and 1 for Paid invoices

","urlObject":{"path":["invoices","get_customer_invoices_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6151b52f-ffbf-494c-99a6-ec6892557b60","name":"Success for Outstanding","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v41","type":"text","description":"required"},{"key":"customerId","value":"64","description":"requred","type":"text"},{"key":"type","value":"0","description":" 0=>Outstanding , 1=>Paid","type":"text"}]},"url":"{{url}}/invoices/get_customer_invoices_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 08:56:08 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%222f054502c8190dd7ce303209e98e6f1c%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614329768%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D149526aff8a06c35e461fe043ad325682dff059d; expires=Fri, 26-Feb-2021 10:56:08 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"895"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Invoices Data\",\n \"data\": [\n {\n \"id\": \"38375\",\n \"invoiceID\": \"279\",\n \"TimeCreated\": \"2021-02-26 00:00:06\",\n \"TimeModified\": \"2021-02-26 00:00:06\",\n \"refNumber\": \"CZ10054\",\n \"CustomerListID\": \"64\",\n \"CustomerFullName\": null,\n \"ShipAddress_Addr1\": \"\",\n \"ShipAddress_Addr2\": \"\",\n \"ShipAddress_City\": \"\",\n \"ShipAddress_State\": \"\",\n \"ShipAddress_Country\": \"\",\n \"ShipAddress_Province\": null,\n \"ShipAddress_PostalCode\": \"\",\n \"BalanceRemaining\": \"1500.00\",\n \"Total_payment\": \"1500.00\",\n \"AppliedAmount\": \"0.00\",\n \"DueDate\": \"2019-05-25\",\n \"IsPaid\": \"0\",\n \"UserStatus\": \"0\",\n \"insertInvID\": \"0\",\n \"companyID\": \"4620816365157259960\",\n \"merchantID\": \"478\",\n \"taxID\": null,\n \"taxRate\": \"0.00\",\n \"totalTax\": \"0.00\",\n \"BillAddress_Addr1\": \"Demo address 1\",\n \"BillAddress_Addr2\": \"Demo address 2\",\n \"BillAddress_City\": \"CA\",\n \"BillAddress_State\": \"CA\",\n \"BillAddress_Country\": \"USA\",\n \"BillAddress_PostalCode\": \"258741\",\n \"isDeleted\": \"0\",\n \"custname\": \"Demo customer\",\n \"status\": \"Scheduled\"\n }\n ],\n \"code\": 200\n}"},{"id":"bb791910-181f-4ed3-b069-6a47b5c10100","name":"Success for Paid","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMjM0NDMsImNoayI6MjA3NTU4ODIxNywic3RhcnQiOjE2MTQzMjM0NDMsImV4cGlyZSI6MTYxNDMzMDY0MywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.XoEmIV-_GV8qDprTtEngjCJXKkFrId5p03ZenTlm6v4","type":"text","description":"required"},{"key":"customerId","value":"64","description":"requred","type":"text"},{"key":"type","value":"1","description":" 0=>Outstanding , 1=>Paid","type":"text"}]},"url":"{{url}}/invoices/get_customer_invoices_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 08:55:33 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%228bd07218c8ba62813a3920b153bf3f36%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614329733%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D35a06c618fcf0f0394cbe3d0e0c07c3dd46ed0cf; expires=Fri, 26-Feb-2021 10:55:33 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"857"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Invoices Data\",\n \"data\": [\n {\n \"id\": \"38372\",\n \"invoiceID\": \"275\",\n \"TimeCreated\": \"2021-02-25 12:00:05\",\n \"TimeModified\": \"2021-02-25 13:00:32\",\n \"refNumber\": \"CZ10052\",\n \"CustomerListID\": \"64\",\n \"CustomerFullName\": null,\n \"ShipAddress_Addr1\": \"90 - H\",\n \"ShipAddress_Addr2\": \"\",\n \"ShipAddress_City\": \"LA\",\n \"ShipAddress_State\": \"\",\n \"ShipAddress_Country\": \"USA\",\n \"ShipAddress_Province\": null,\n \"ShipAddress_PostalCode\": \"956238\",\n \"BalanceRemaining\": \"0\",\n \"Total_payment\": \"1550.00\",\n \"AppliedAmount\": \"1550.00\",\n \"DueDate\": \"2021-02-25\",\n \"IsPaid\": \"1\",\n \"UserStatus\": \"0\",\n \"insertInvID\": \"0\",\n \"companyID\": \"4620816365157259960\",\n \"merchantID\": \"478\",\n \"taxID\": null,\n \"taxRate\": \"0.00\",\n \"totalTax\": \"0.00\",\n \"BillAddress_Addr1\": \"Demo address 1\",\n \"BillAddress_Addr2\": \"Demo address 2\",\n \"BillAddress_City\": \"CA\",\n \"BillAddress_State\": \"CA\",\n \"BillAddress_Country\": \"USA\",\n \"BillAddress_PostalCode\": \"258741\",\n \"isDeleted\": \"0\"\n }\n ],\n \"code\": 200\n}"},{"id":"003f04c6-d57b-4758-bdc9-993843ee3e64","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzI4NzgsImNoayI6MTIzNzYxNzg0OCwic3RhcnQiOjE2MTQzMzI4NzgsImV4cGlyZSI6MTYxNDM0MDA3OCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.8rJudQ8RP3Z2h-2i_jfqxfZBRxToR2vC_s3kUBVkX1","type":"text","description":"required"},{"key":"customerId","value":"642","description":"requred","type":"text"},{"key":"type","value":"0","description":" 0=>Outstanding , 1=>Paid","type":"text"}]},"url":"{{url}}/invoices/get_customer_invoices_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 09:48:16 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22ce29634679e60d5a78d05f2770265035%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614332896%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D578b4cd81007b27735b24e64283fcd90bf5fdc8b; expires=Fri, 26-Feb-2021 11:48:16 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"50"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No record found\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"2b66de78-d2fe-4d59-a6f9-068fd9a514e1"},{"name":"Delete Invoice","id":"ad7090ab-b405-4f64-bc05-b319e577b030","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/invoices/delete_invoice","description":"

Delete Invoice.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
invoiceId	Invoice ID	Yes	String	-	-

","urlObject":{"path":["invoices","delete_invoice"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f68c0ebc-71da-4c8b-b53d-fbaa428c7179","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzI4NzgsImNoayI6MTIzNzYxNzg0OCwic3RhcnQiOjE2MTQzMzI4NzgsImV4cGlyZSI6MTYxNDM0MDA3OCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.8rJudQ8RP3Z2h-2i_jfqxfZBRxToR2vC_s3kUBVkX1","type":"text","description":"Required"},{"key":"invoiceId","value":"64","description":"Required","type":"text"}]},"url":"{{url}}/invoices/delete_invoice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 09:58:23 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%220aca8da934b22498315768229088bce3%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614333503%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D88d8c20acb17ec96d42de18b3acfab83211df4bd; expires=Fri, 26-Feb-2021 11:58:23 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"62"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice deleted successfully.\",\n \"data\": \"\",\n \"code\": 200\n}"}],"_postman_id":"ad7090ab-b405-4f64-bc05-b319e577b030"},{"name":"Create Invoice","id":"752d5147-138b-41e1-8d82-905368ae0b7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/invoices/create_invoice_data","description":"

Create invoice.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
customerId	Customer ID	Yes	String	-	-
dueDate	Due Date	Yes	String	-	Must be in YYYY-MM-DD Format
taxId	Tax ID	No	String	-	-
payTerm	Pay Term Days	No	Integer	-	-
autoPay	Auto pay	Yes	Integer	0	1 if Auto pay using Credit card
gatewayId	Gateway ID	Yes	Integer	-	Gateway Id for merchant configured gateway
cardId	Card ID	Yes	String	-	Use 'new1' for new card or use card id for existing card
cardNumber	Card Number	Yes	Integer	-	Must be 15 or 16 digits long.
expMonth	Card expiry month	Yes	String	-	Must be between 01 to 12.
expYear	Card expiry year	Yes	String	-	Must be valid expiry year.
cardCvv	Card CVV	Yes	Integer	-	CVV should have 3 or 4 digits.
friendlyName	Card Friendly Name	No	String	-	-
bAddress1	Billing Address 1	No	String	-	-
bAddress2	Billing Address 2	No	String	-	-
bCity	Billing City	No	String	-	-
bState	Billing State	No	String	-	-
bCountry	Country	No	String	-	Country name or code can be used (e.g. - US, USA, United States)
bZipcode	Billing Zipcode	No	Integer	-	-
bPhone	Billing Phone	No	String	-	-
address1	Address 1	No	String	-	-
address2	Address 2	No	String	-	-
city	City Name	No	String	-	-
state	State Name	No	String	-	-
country	Country	No	String	-	-
zipcode	Zipcode	No	Integer	-	-
phone	Phone Number	No	String	-	-
productId[]	Product ID	No	String	-	Invoice can have multiple product items.
itemQuantity[]	Item Quantity	No	Integer	-	-
itemPrice[]	Item Price	No	Float	-	-
itemFullName[]	Item Name	No	String	-	-
itemDescription[]	Item description	No	String	-	-
taxCheck[]	Tax Check	No	Integer	-	Tax include, 1 => Yes and 0 => No

","urlObject":{"path":["invoices","create_invoice_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"99118172-698a-438f-a12b-dfd5f13f65bf","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzI4NzgsImNoayI6MTIzNzYxNzg0OCwic3RhcnQiOjE2MTQzMzI4NzgsImV4cGlyZSI6MTYxNDM0MDA3OCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.8rJudQ8RP3Z2h-2i_jfqxfZBRxToR2vC_s3kUBVkX14","type":"text","description":"required"},{"key":"customerID","value":"621","type":"text","description":"required"},{"key":"dueDate","value":"2021-01-21","type":"text","description":"date type (required)"},{"key":"taxID","value":"3","type":"text","description":"optional"},{"key":"payTerm","value":"5","type":"text","description":"optional "},{"key":"autoPay","value":"1","type":"text","description":"requied ( 0 or 1) 1=>Credit Card, 0 =>Offline"},{"key":"gatewayID","value":"91","type":"text"},{"key":"cardID","value":"new1","type":"text","description":"for new card use \"new1\" or card ID"},{"key":"cardNumber","value":"4111111111111111","type":"text"},{"key":"expMonth","value":"02","type":"text","description":"1to 12"},{"key":"expYear","value":"2022","type":"text","description":"For example (2025)"},{"key":"cardCVV","value":"1234","type":"text"},{"key":"friendlyName","value":"Popio Card","type":"text"},{"key":"baddress1","value":"12th street 147/58 Sec 4","type":"text","description":"Required"},{"key":"baddress2","value":"#123","type":"text"},{"key":"bcity","value":"Los Anglish","type":"text","description":"Required"},{"key":"bstate","value":"CA","type":"text","description":"Required"},{"key":"bcountry","value":"United States","type":"text","description":"Required United States, Canada"},{"key":"bzipcode","value":"74502","type":"text","description":"Required"},{"key":"bphone","value":"(999) 658-7485","type":"text"},{"key":"address1","value":"12th street 147/58 Sec 4","type":"text","description":"Required"},{"key":"address2","value":"#123","type":"text","description":"Required"},{"key":"city","value":"Los Anglish","type":"text","description":"Required"},{"key":"state","value":"CA","type":"text","description":"Required"},{"key":"country","value":"United States","type":"text","description":"Required"},{"key":"zipcode","value":"74025","type":"text","description":"Required"},{"key":"phone","value":"(999) 658-7485","type":"text"},{"key":"productID[]","value":"21","type":"text","description":"Product ID"},{"key":"itemQuantity[]","value":"1","type":"text","description":"Quantity"},{"key":"itemPrice[]","value":"35.00","type":"text","description":"Price"},{"key":"itemFullName[]","value":"Triming","type":"text","description":"Full Name"},{"key":"itemDescription[]","value":"This is test service1","type":"text"},{"key":"taxCheck[]","value":"1token:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTY5NjU0MTEsImNoayI6MTgzNjc3MTI3Miwic3RhcnQiOjE1NTY5NjU0MTEsImV4cGlyZSI6MTU1Njk3MjYxMSwidXNlcm5hbWUiOiJwb3BwaW8uamhvbjEyM0BnbWFpbC5jb20iLCJtaWQiOiI0OCIsImlkIjoiNDkiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiIxOTM1MTQ3ODA0NjMyOTQiLCJkb21haW4iOiJhcGkudGVzdCIsInJvbGUiOiJtX3VzZXIifQ._pRSu1fOTUp6aNXT2XunjIoGAcF6-V0LJPq6I-KSkoY","type":"text"},{"key":"customerId","value":"123","type":"text"},{"key":"dueDate","value":"2019-05-25","type":"text"},{"key":"taxId","value":"3","type":"text"},{"key":"payTerm","value":"5","type":"text"},{"key":"autoPay","value":"1","type":"text"},{"key":"gatewayId","value":"91","type":"text"},{"key":"cardId","value":"772","type":"text"},{"key":"cardNumber","value":"4111111111111111","type":"text"},{"key":"expMonth","value":"02","type":"text"},{"key":"expYear","value":"2022","type":"text"},{"key":"cardCvv","value":"1234","type":"text"},{"key":"friendlyName","value":"Popio Card","type":"text"},{"key":"bAddress1","value":"12th street 147/58 Sec 4","type":"text"},{"key":"bAddress2","value":"#123","type":"text"},{"key":"bCity","value":"Los Anglish","type":"text"},{"key":"bState","value":"CA","type":"text"},{"key":"bCountry","value":"United States","type":"text"},{"key":"bZipcode","value":"74502","type":"text"},{"key":"bPhone","value":"(999) 658-7485","type":"text"},{"key":"address1","value":"12th street 147/58 Sec 4","type":"text"},{"key":"address2","value":"#123","type":"text"},{"key":"city","value":"Los Anglish","type":"text"},{"key":"state","value":"CA","type":"text"},{"key":"country","value":"United States","type":"text"},{"key":"zipcode","value":"74025","type":"text"},{"key":"phone","value":"(999) 658-7485","type":"text"},{"key":"productId[]","value":"18","type":"text"},{"key":"itemQuantity[]","value":"1","type":"text"},{"key":"itemPrice[]","value":"35.00","type":"text"},{"key":"itemFullName[]","value":"Triming","type":"text"},{"key":"itemDescription[]","value":"This is test service1","type":"text"},{"key":"taxCheck[]","value":"1","type":"text"},{"key":"productId[]","value":"5","type":"text"},{"key":"itemQuantity[]","value":"5","type":"text"},{"key":"itemPrice[]","value":"20.00","type":"text"},{"key":"itemFullName[]","value":"Rock Fountain","type":"text"},{"key":"itemDescription[]","value":"This is test service2","type":"text"},{"key":"taxCheck[]","value":"","type":"text"}]},"url":"{{url}}/invoices/create_invoice_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 10:31:02 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2230747c937aa3b19d046fb290892d028a%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614335462%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Df9eb8fa7cca6988f1b47a787c0077d6ef66a03e5; expires=Fri, 26-Feb-2021 12:31:02 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"68"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Please Generate Invoice Prefix Code to Create Invoices\",\n \"data\": \"Error\",\n \"code\": \"403\"\n}"},{"id":"1e63b077-b18f-483d-bad9-13b13b218b1d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTY5NjU0MTEsImNoayI6MTgzNjc3MTI3Miwic3RhcnQiOjE1NTY5NjU0MTEsImV4cGlyZSI6MTU1Njk3MjYxMSwidXNlcm5hbWUiOiJwb3BwaW8uamhvbjEyM0BnbWFpbC5jb20iLCJtaWQiOiI0OCIsImlkIjoiNDkiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiIxOTM1MTQ3ODA0NjMyOTQiLCJkb21haW4iOiJhcGkudGVzdCIsInJvbGUiOiJtX3VzZXIifQ._pRSu1fOTUp6aNXT2XunjIoGAcF6-V0LJPq6I-KSkoY","type":"text","description":"required"},{"key":"customerId","value":"123","type":"text","description":"required"},{"key":"dueDate","value":"2019-05-25","type":"text","description":"date type (required)"},{"key":"taxId","value":"3","type":"text","description":"optional"},{"key":"payTerm","value":"5","type":"text","description":"optional "},{"key":"autoPay","value":"1","type":"text","description":"requied ( 0 or 1) 1=>Credit Card, 0 =>Offline"},{"key":"gatewayId","value":"91","type":"text"},{"key":"cardId","value":"772","type":"text","description":"for new card use \"new1\" or card ID"},{"key":"cardNumber","value":"4111111111111111","type":"text"},{"key":"expMonth","value":"02","type":"text","description":"1to 12"},{"key":"expYear","value":"2022","type":"text","description":"For example (2025)"},{"key":"cardCvv","value":"1234","type":"text"},{"key":"friendlyName","value":"Popio Card","type":"text"},{"key":"bAddress1","value":"12th street 147/58 Sec 4","type":"text","description":"Required"},{"key":"bAddress2","value":"#123","type":"text"},{"key":"bCity","value":"Los Anglish","type":"text","description":"Required"},{"key":"bState","value":"CA","type":"text","description":"Required"},{"key":"bCountry","value":"United States","type":"text","description":"Required United States, Canada"},{"key":"bZipcode","value":"74502","type":"text","description":"Required"},{"key":"bPhone","value":"(999) 658-7485","type":"text"},{"key":"address1","value":"12th street 147/58 Sec 4","type":"text","description":"Required"},{"key":"address2","value":"#123","type":"text","description":"Required"},{"key":"city","value":"Los Anglish","type":"text","description":"Required"},{"key":"state","value":"CA","type":"text","description":"Required"},{"key":"country","value":"United States","type":"text","description":"Required"},{"key":"zipcode","value":"74025","type":"text","description":"Required"},{"key":"phone","value":"(999) 658-7485","type":"text"},{"key":"productId[]","value":"18","type":"text","description":"Product ID"},{"key":"itemQuantity[]","value":"1","type":"text","description":"Quantity"},{"key":"itemPrice[]","value":"35.00","type":"text","description":"Price"},{"key":"itemFullName[]","value":"Triming","type":"text","description":"Full Name"},{"key":"itemDescription[]","value":"This is test service1","type":"text"},{"key":"taxCheck[]","value":"1","type":"text"},{"key":"productId[]","value":"5","type":"text"},{"key":"itemQuantity[]","value":"5","type":"text"},{"key":"itemPrice[]","value":"20.00","type":"text"},{"key":"itemFullName[]","value":"Rock Fountain","type":"text"},{"key":"itemDescription[]","value":"This is test service2","type":"text"},{"key":"taxCheck[]","value":"","type":"text"}]},"url":"{{url}}/invoices/create_invoice_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 10:27:00 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22e69c7f49be2e751b20276b50aef138b1%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614335220%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D7639ea8733fe7c4a313dff99f42602a0fa2ad780; expires=Fri, 26-Feb-2021 12:27:00 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"68"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice created successfully.\",\n \"data\": 75358566,\n \"code\": 200\n}"}],"_postman_id":"752d5147-138b-41e1-8d82-905368ae0b7a"}],"id":"14319eae-4fbd-4085-aecb-21c647468339","_postman_id":"14319eae-4fbd-4085-aecb-21c647468339","description":""},{"name":"Gateway","item":[{"name":"Sale","item":[{"name":"Create Sale Transaction","id":"3492e475-dcda-4368-b211-a7b4e7c31579","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/Sale/process_sale","description":"

Create customer sale transaction through the provided gateway.

If gatewayIdentifier isn't provided the default gateway will be used. All gateways can be found
from calls to the \"Get All Gateways\" route.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
gatewayIdentifier	Gateway Identifier	Yes	String	-	Each gateway has one unique ID.
customerId	Customer ID	Yes	String	-	-
cardId	Card ID	Yes	String	-	Use 'new1' for New Card and Card Id for existing card.
cardNo	Card Number	Yes	String	-	Must be 15 or 16 digits number.
cardCvv	Card CVV	N	String	-	Must be 3 or 4 digit number.
expMonth	Expiration month	Yes	String	-	Month must be a two-digit number. For single-digit months, prepend with a leading zero (eg: 01-12).
expYear	Expiration year	Yes	String	-	Must be valid current or future year number ie. 2022 or 2025 etc.
friendlyName	Card Friendly Name	Yes	String	-	-
firstName	First Name	Yes	String	-	-
lastName	Last Name	Yes	String	-	-
companyName	Company Name	Yes	String	-	-
userEmail	Customer Email address	Yes	String	-	-
totalAmount	Sale Total Amount	Yes	String	-	-
bAddress	Billing street address	Yes	String	-	-
bCountry	Country	Yes	String	-	Country name or code can be used (e.g. - US, USA, United States)
bCity	Billing city name	Yes	String	-	-
bState	Billing state name	Yes	String	-	State name or code
bZipcode	Billing zipcode	Yes	String	-	-
userContact	Contact number.	Yes	String	-	-
shipAddress	Shipping street address	No	String	-	-
shipCountry	Country	No	String	-	Country name or code can be used (e.g. - US, USA, United States)
shipZipcode	Shipping address zipcode	No	String	-	-
shipCity	Shipping city name	Yes	String	-	-
shipState	Shipping state name	Yes	String	-	-
refNo	Reference Number	No	String	-	-
saveCard	Save card	Yes	Integer	-	1 => Yes, 0 => No.

","urlObject":{"path":["Sale","process_sale"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"67642ee7-b300-46ef-a3b1-c9afdf0445c3","name":"NMI Payment Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2MjE1NTgsImNoayI6MTkwODkyODU2Mywic3RhcnQiOjE2MzY2MjE1NTgsImV4cGlyZSI6MTYzNjYyODc1OCwidXNlcm5hbWUiOiJtcmkuYXBjQGN6dGVzdGVyLmNvbSIsIm1pZCI6IjMyMyIsImlkIjoiMzIzIiwic2VydmljZSI6IjUiLCJjb21wYW55IjowLCJkb21haW4iOiJwYXlwb3J0YWxkZXYuY29tIiwicm9sZSI6Im1lcmNoYW50In0.T0pcDm_CwJxRoFuxjEYwz_-5eU0JimF2DKglB-DZOLM","type":"text"},{"key":"gatewayIdentifier","value":"NMI_GATEWAY","type":"text"},{"key":"customerId","value":"CUS-5333380-ZPSD7Y","type":"text"},{"key":"cardId","value":"new1","type":"text","description":"new1 or card id number"},{"key":"cardNo","value":"4111111111111111","type":"text"},{"key":"cardCvv","value":"999","type":"text"},{"key":"expMonth","value":"12","type":"text"},{"key":"expYear","value":"2025","type":"text"},{"key":"friendlyName","value":"Alpha","type":"text"},{"key":"totalAmount","value":"16.00","type":"text"},{"key":"bAddress","value":"Demo address 1","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"Texas","type":"text"},{"key":"bZipcode","value":"87026","type":"text"},{"key":"bCountry","value":"US","type":"text"},{"key":"shipAddress","value":"","type":"text"},{"key":"shipCity","value":"","type":"text"},{"key":"shipState","value":"","type":"text"},{"key":"shipCountry","value":"","type":"text"},{"key":"shipzipCode","value":"","type":"text"},{"key":"firstName","value":"Demo","type":"text"},{"key":"lastName","value":"Customer","type":"text"},{"key":"userEmail","value":"demo.customer@cztester.com","type":"text"},{"key":"userContact","value":"000000000","type":"text"},{"key":"companyName","value":"Demo Company","type":"text"},{"key":"refNo","value":"#123","type":"text"},{"key":"saveCard","value":"1","type":"text"},{"key":"merchan","value":"","type":"text","disabled":true}]},"url":"{{url}}/Sale/process_sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 09:10:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"73"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_payportal_=a%3A4%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%225e2d17a6d8456163f1931a7c88c4c932%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A21%3A%22PostmanRuntime%2F7.28.4%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1636621818%3B%7D9723384a08ebeb0ba730959b6e987d17efb20d29; expires=Thu, 11-Nov-2021 11:10:18 GMT; Max-Age=7200; path=/; domain=payportaldev.com"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully Created Payment\",\n \"data\": \"6732612010\",\n \"code\": 200\n}"},{"id":"8055eae7-3ed4-462d-b65d-9358dfedacfb","name":"Authorize.Net Payment Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2MjE1NTgsImNoayI6MTkwODkyODU2Mywic3RhcnQiOjE2MzY2MjE1NTgsImV4cGlyZSI6MTYzNjYyODc1OCwidXNlcm5hbWUiOiJtcmkuYXBjQGN6dGVzdGVyLmNvbSIsIm1pZCI6IjMyMyIsImlkIjoiMzIzIiwic2VydmljZSI6IjUiLCJjb21wYW55IjowLCJkb21haW4iOiJwYXlwb3J0YWxkZXYuY29tIiwicm9sZSI6Im1lcmNoYW50In0.T0pcDm_CwJxRoFuxjEYwz_-5eU0JimF2DKglB-DZOLM","type":"text"},{"key":"gatewayIdentifier","value":"AUTHORIZE_GATEWAY","type":"text"},{"key":"customerId","value":"CUS-5333380-ZPSD7Y","type":"text"},{"key":"cardId","value":"new1","type":"text","description":"new1 or card id number"},{"key":"cardNo","value":"4111111111111111","type":"text"},{"key":"cardCvv","value":"999","type":"text"},{"key":"expMonth","value":"12","type":"text"},{"key":"expYear","value":"2025","type":"text"},{"key":"friendlyName","value":"Alpha","type":"text"},{"key":"totalAmount","value":"18.00","type":"text"},{"key":"bAddress","value":"#12/24 12th street ","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"Texas","type":"text"},{"key":"bZipcode","value":"87026","type":"text"},{"key":"bCountry","value":"US","type":"text"},{"key":"shipAddress","value":"","type":"text"},{"key":"shipCity","value":"","type":"text"},{"key":"shipState","value":"","type":"text"},{"key":"shipCountry","value":"","type":"text"},{"key":"shipzipCode","value":"","type":"text"},{"key":"firstName","value":"Demo","type":"text"},{"key":"lastName","value":"Customer","type":"text"},{"key":"userEmail","value":"demo.customer@cztester.com","type":"text"},{"key":"userContact","value":"0000000000","type":"text"},{"key":"companyName","value":"Demo CMP","type":"text"},{"key":"refNo","value":"#123","type":"text"},{"key":"saveCard","value":"1","type":"text"}]},"url":"{{url}}/Sale/process_sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 09:28:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully Payment Created\",\n \"data\": \"60179364036\",\n \"code\": 200\n}"},{"id":"9279ed93-307d-4364-ace3-9a27dd2fe8f3","name":"FluidPay Payment Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"3f5445c15e863c459f24c65381c2e203901b8564","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzcxNDY3MzYsImNoayI6NTQ5Mzc1ODI3LCJzdGFydCI6MTYzNzE0NjczNiwiZXhwaXJlIjoxNjM3MTUzOTM2LCJ1c2VybmFtZSI6ImludHVpdC5uYXBtZXJjaGFudDE5NEBtYWlsbmF0b3IuY29tIiwibWlkIjoiMjk0IiwiaWQiOiIyOTQiLCJzZXJ2aWNlIjoiNSIsImNvbXBhbnkiOjAsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.KQDpz2xg-n7XNs_EAA6XFg2D6stScmnBsUxMy8x7jwU","type":"text"},{"key":"gatewayIdentifier","value":"FLUIDPAY_GATEWAY","type":"text"},{"key":"customerId","value":"CUS-5118644-BFXLI7","type":"text"},{"key":"cardId","value":"new1","type":"text","description":"new1 or card id number"},{"key":"cardNo","value":"4111111111111111","type":"text"},{"key":"cardCvv","value":"999","type":"text"},{"key":"expMonth","value":"12","type":"text"},{"key":"expYear","value":"2025","type":"text"},{"key":"friendlyName","value":"Ivana","type":"text"},{"key":"taxVal","value":"1.50","type":"text"},{"key":"amount","value":"17.50","type":"text"},{"key":"totalAmount","value":"19.00","type":"text"},{"key":"bAddress","value":"#12/24 12th street ","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"Texas","type":"text"},{"key":"bZipcode","value":"87026","type":"text"},{"key":"bCountry","value":"US","type":"text"},{"key":"shipAddress","value":"","type":"text"},{"key":"shipCity","value":"","type":"text"},{"key":"shipState","value":"","type":"text"},{"key":"shipCountry","value":"","type":"text"},{"key":"shipzipCode","value":"12312","type":"text"},{"key":"firstName","value":"Demo","type":"text"},{"key":"lastName","value":"Customer","type":"text"},{"key":"userEmail","value":"demo.customer@cztester.com","type":"text"},{"key":"userContact","value":"000000000","type":"text"},{"key":"companyName","value":"Demo Company","type":"text"},{"key":"refNo","value":"#123","type":"text"},{"key":"gatewayId","value":"","type":"text"},{"key":"invoiceId","value":"","type":"text"},{"key":"saveCard","value":"1","type":"text"},{"key":"merchan","value":"","type":"text","disabled":true}]},"url":"{{url}}/Sale/process_sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Nov 2021 11:13:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"77"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction successful\",\n \"data\": \"c6ae7o46lr8skt0f6t80\",\n \"code\": 200\n}"},{"id":"9140b6bd-0985-491b-8028-dd6db1159625","name":"Payment Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY1NDk5NTUsImNoayI6MjA3NzI3MDk1Nywic3RhcnQiOjE2MzY1NDk5NTUsImV4cGlyZSI6MTYzNjU1NzE1NSwidXNlcm5hbWUiOiJtcmkuYXBjQGN6dGVzdGVyLmNvbSIsIm1pZCI6IjMyMyIsImlkIjoiMzIzIiwic2VydmljZSI6IjUiLCJjb21wYW55IjowLCJkb21haW4iOiJwYXlwb3J0YWxkZXYuY29tIiwicm9sZSI6Im1lcmNoYW50In0.YxTmb2bFnpFw7IPipmfTtKhVLxUCWUiPAy2I_8u7R9c","type":"text"},{"key":"gatewayIdentifier","value":"NMI_GATEWAY","type":"text"},{"key":"customerId","value":"CUS-5333380-ZPSD7Y","type":"text"},{"key":"cardId","value":"new1","type":"text","description":"new1 or card id number"},{"key":"cardNo","value":"4242424242424242","type":"text"},{"key":"cardCvv","value":"999","type":"text"},{"key":"expMonth","value":"12","type":"text"},{"key":"expYear","value":"2025","type":"text"},{"key":"friendlyName","value":"Alpha","type":"text"},{"key":"taxVal","value":"0","type":"text"},{"key":"amount","value":"19.00","type":"text"},{"key":"totalAmount","value":"19.00","type":"text"},{"key":"bAddress","value":"#12/24 12th street ","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"Texas","type":"text"},{"key":"bzipCode","value":"87026","type":"text"},{"key":"bCountry","value":"US","type":"text"},{"key":"shipAddress","value":"","type":"text"},{"key":"shipCity","value":"","type":"text"},{"key":"shipState","value":"","type":"text"},{"key":"shipCountry","value":"","type":"text"},{"key":"shipzipCode","value":"","type":"text"},{"key":"firstName","value":"Demo","type":"text"},{"key":"lastName","value":"Customer","type":"text"},{"key":"userEmail","value":"demo.customer@cztester.com","type":"text"},{"key":"userContact","value":"000000000","type":"text"},{"key":"companyName","value":"Demo CMP","type":"text"},{"key":"refNo","value":"#123","type":"text"},{"key":"gatewayId","value":"","type":"text"},{"key":"invoiceId","value":"","type":"text"},{"key":"saveCard","value":"1","type":"text"},{"key":"merchan","value":"","type":"text","disabled":true}]},"url":"{{url}}/Sale/process_sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Nov 2021 14:04:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_payportal_=a%3A4%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22112129a550308b0ada0bf7c93160acfa%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A21%3A%22PostmanRuntime%2F7.28.4%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1636553066%3B%7Da64e6156de220c9e4a25d139eb6d73038b333bdc; expires=Wed, 10-Nov-2021 16:04:26 GMT; Max-Age=7200; path=/; domain=payportaldev.com"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"DECLINE\",\n \"data\": \"\",\n \"code\": 403\n}"}],"_postman_id":"3492e475-dcda-4368-b211-a7b4e7c31579"},{"name":"Get Sale Transactions","id":"3f2bf030-ef3c-4640-b673-3538b139e61c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/NMIPayment/get_all_sale_transaction_data","description":"

Get all sale transactions.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
page	Page number	No	Integer	-	Page number, (if provided needs to be greater than 0).
limit	Records per page	No	Integer	-	Records per page, (if provided needs to be greater than 0).

","urlObject":{"path":["NMIPayment","get_all_sale_transaction_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d23f7ba7-39d5-4552-bac7-088849ec6cba","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzNDQ1MTQsImNoayI6NTA0MDE2NDcsInN0YXJ0IjoxNjE0MzQ0NTE0LCJleHBpcmUiOjE2MTQzNTE3MTQsInVzZXJuYW1lIjoiaHBjb3JwLnVzMkBtYWlsaW5hdG9yLmNvbSIsIm1pZCI6IjQ3OCIsImlkIjoiNDc4Iiwic2VydmljZSI6IjEiLCJjb21wYW55IjoiNDYyMDgxNjM2NTE1NzI1OTk2MCIsImRvbWFpbiI6Imh0dHBzOlwvXC9ocGNpbmMucGF5cG9ydGFsc3RhZ2luZy5jb21cLyIsInJvbGUiOiJtZXJjaGFudCJ9.vOINeVd9o0WCH5wc7SdmT0Z4s7WLjWYfKJmWthXvhZc"},{"key":"page","value":"0","type":"text"},{"key":"limit","value":"10","type":"text"}]},"url":"{{url}}/NMIPayment/get_all_sale_transaction_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 13:03:51 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22cf38209feb6e01430fc95618aea57163%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614344632%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Ddf0b220be8ed4b8947e704f41c0f9f9f70686a47; expires=Fri, 26-Feb-2021 15:03:52 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"70212"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"All transactions\",\n \"data\": [],\n \"code\": 200\n}"},{"id":"de0a7f6e-0581-4427-95c2-1417117200a4","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzNDQ1MTQsImNoayI6NTA0MDE2NDcsInN0YXJ0IjoxNjE0MzQ0NTE0LCJleHBpcmUiOjE2MTQzNTE3MTQsInVzZXJuYW1lIjoiaHBjb3JwLnVzMkBtYWlsaW5hdG9yLmNvbSIsIm1pZCI6IjQ3OCIsImlkIjoiNDc4Iiwic2VydmljZSI6IjEiLCJjb21wYW55IjoiNDYyMDgxNjM2NTE1NzI1OTk2MCIsImRvbWFpbiI6Imh0dHBzOlwvXC9ocGNpbmMucGF5cG9ydGFsc3RhZ2luZy5jb21cLyIsInJvbGUiOiJtZXJjaGFudCJ9.vOINeVd9o0WCH5wc7SdmT0Z4s7WLjWYfKJmWthXvhZc"},{"key":"page","value":"0","type":"text"},{"key":"limit","value":"10","type":"text"}]},"url":"{{url}}/NMIPayment/get_all_sale_transaction_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 13:02:21 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22c7907af92df56314393d0d8304dadab3%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614344541%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D18ba577806182a97ec54c23e003960fb20af4d77; expires=Fri, 26-Feb-2021 15:02:21 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"70212"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"All transactions\",\n \"data\": [\n {\n \"id\": \"24522\",\n \"transactionID\": \"370238508\",\n \"transactionDate\": \"2021-02-26 12:50:16\",\n \"transactionStatus\": \"Your transaction was successfully approved.\",\n \"transactionAmount\": \"0.50\",\n \"customerListID\": \"62\",\n \"transactionModified\": null,\n \"transactionType\": \"pay_sale\",\n \"transactionGateway\": \"1\",\n \"gateway\": \"NMI\",\n \"gatewayID\": \"667\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"200\",\n \"transactionCard\": \"0057\",\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": null,\n \"creditTxnID\": null,\n \"qbListTxnID\": null,\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": null,\n \"transaction_by_user_id\": null,\n \"tr_Day\": \"0\",\n \"FirstName\": \"Mr. Demo\",\n \"LastName\": \"Customer\",\n \"FullName\": \"Mr. Demo Customer\",\n \"Email\": \"demo.customer@cztester.com\",\n \"Phone\": \"\",\n \"BillingAddress_Addr1\": \"Demo address\",\n \"BillingAddress_Addr2\": \"Demo AD2\",\n \"BillingAddress_Country\": \"USA\",\n \"BillingAddress_State\": \"CA\",\n \"BillingAddress_City\": \"CA\",\n \"BillingAddress_PostalCode\": \"258963\",\n \"ShipAddress_Addr1\": null,\n \"ShipAddress_Addr2\": null,\n \"ShipAddress_Country\": null,\n \"ShipAddress_State\": null,\n \"ShipAddress_City\": null,\n \"ShipAddress_PostalCode\": null,\n \"CompanyName\": \"DEMO CPM\",\n \"CompanyID\": \"4620816365157259960\",\n \"Profile_Picture\": null,\n \"CustomerStatus\": \"true\"\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"3f2bf030-ef3c-4640-b673-3538b139e61c"}],"id":"cefe6d9a-f421-46fe-b8e2-e21dda68d040","description":"

Process credit card sales for all gateways.

\n","_postman_id":"cefe6d9a-f421-46fe-b8e2-e21dda68d040"},{"name":"Authorize","item":[{"name":"Authorize Payment","id":"560e47b5-f6b7-4826-81d1-3e1d35ca1c92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/AuthSale/process_auth","description":"

Authorize transaction using credit card.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
gatewayIdentifier	Gateway Identifier, Each gateway has one unique ID.	Yes	String	-	-
customerId	Customer ID	Yes	String	-	-
cardId	Use text 'new1' if card is new and use actual card id if it is existing card.	Yes	String	-	-
cardNo	Card Number	Yes	String	-	Must be 15 or 16 digits number.
cardCvv	Card CVV	N	String	-	Must be 3 or 4 digits number.
expMonth	Expiration month	Yes	String	-	Month must be a two-digit number. For single-digit months, prepend with a leading zero (eg: 01-12).
expYear	Expiration year	Yes	String	-	Must be valid current or future year number ie. 2022 or 2025 etc.
friendlyName	Card Friendly Name	Yes	String	-	-
firstName	Customer first name	Yes	String	-	-
lastName	Customer last name	Yes	String	-	-
companyName	Company Name	Yes	String	-	-
userEmail	Email address	Yes	String	-	-
userContact	User contact number	Yes	Integer	-	-
totalAmount	Total Amount to be paid	Yes	Float	-	-
bAddress	Billing street address	Yes	String	-	-
bCountry	Billing Country	Yes	String	-	Name or Code. ie. US, USA or United States
bCity	Billing city name	Yes	String	-	-
bState	Billing state name	Yes	String	-	-
bZipcode	Billing Zipcode	Yes	String	-	-
shipAddress	Shipping street address	No	String	-	-
shipCity	Shipping city name	No	String	-	-
shipState	Shipping state name	No	String	-	-
shipCountry	Shipping country	No	String	-	-
shipZipcode	Shipping address zipcode	No	String	-	-
saveCard	Save card	Yes	Integer	-	1 => Yes, 0 => No.

","urlObject":{"path":["AuthSale","process_auth"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3d6e963c-847e-4855-ac90-de623511035d","name":"NMI Auth Transaction","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2MzA0OTAsImNoayI6NzQyNDI3NzMsInN0YXJ0IjoxNjM2NjMwNDkwLCJleHBpcmUiOjE2MzY2Mzc2OTAsInVzZXJuYW1lIjoibXJpLmFwY0BjenRlc3Rlci5jb20iLCJtaWQiOiIzMjMiLCJpZCI6IjMyMyIsInNlcnZpY2UiOiI1IiwiY29tcGFueSI6MCwiZG9tYWluIjoicGF5cG9ydGFsZGV2LmNvbSIsInJvbGUiOiJtZXJjaGFudCJ9.6drLeZjtcw_ETUBJdE0U8awqxwywEXTcvJNf2ToMC7E\n","type":"text"},{"key":"customerId","value":"CUS-5333380-ZPSD7Y","type":"text"},{"key":"cardId","value":"new1","type":"text","description":"new1 if card is new"},{"key":"cardNo","value":"4111111111111111","type":"text"},{"key":"cardCvv","value":"999","type":"text"},{"key":"expMonth","value":"12","type":"text"},{"key":"expYear","value":"2025","type":"text"},{"key":"friendlyName","value":"demo card","type":"text"},{"key":"taxVal","value":"1.0","type":"text"},{"key":"amount","value":"15.00","type":"text"},{"key":"totalAmount","value":"16.00","type":"text"},{"key":"bAddress","value":"#12/24 Demo address","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"Texas","type":"text"},{"key":"bZipcode","value":"87026","type":"text"},{"key":"bCountry","value":"US","type":"text"},{"key":"shipAddress","value":"","type":"text"},{"key":"shipCity","value":"","type":"text"},{"key":"shipState","value":"","type":"text"},{"key":"shipCountry","value":"","type":"text"},{"key":"shipZipcode","value":"","type":"text"},{"key":"firstName","value":"Demo","type":"text"},{"key":"lastName","value":"Demo","type":"text"},{"key":"userEmail","value":"demo.customer@cztester.com","type":"text"},{"key":"userContact","value":"4444455555","type":"text"},{"key":"companyName","value":"Demo Company","type":"text"},{"key":"refNo","value":"#123","type":"text"},{"key":"gatewayIdentifier","value":"NMI_GATEWAY","type":"text"},{"key":"saveCard","value":"1","type":"text"}]},"url":"{{url}}/AuthSale/process_auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 11:35:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"73"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment authorized successfully.\",\n \"data\": \"6732762194\",\n \"code\": 200\n}"},{"id":"8c702217-eff8-4a57-9cff-30fc31acfdea","name":"Authorize.net Auth Payment","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2MzA0OTAsImNoayI6NzQyNDI3NzMsInN0YXJ0IjoxNjM2NjMwNDkwLCJleHBpcmUiOjE2MzY2Mzc2OTAsInVzZXJuYW1lIjoibXJpLmFwY0BjenRlc3Rlci5jb20iLCJtaWQiOiIzMjMiLCJpZCI6IjMyMyIsInNlcnZpY2UiOiI1IiwiY29tcGFueSI6MCwiZG9tYWluIjoicGF5cG9ydGFsZGV2LmNvbSIsInJvbGUiOiJtZXJjaGFudCJ9.6drLeZjtcw_ETUBJdE0U8awqxwywEXTcvJNf2ToMC7E\n","type":"text"},{"key":"customerId","value":"CUS-5333380-ZPSD7Y","type":"text"},{"key":"cardId","value":"new1","type":"text","description":"new1 if card is new"},{"key":"cardNo","value":"4111111111111111","type":"text"},{"key":"cardCvv","value":"999","type":"text"},{"key":"expMonth","value":"12","type":"text"},{"key":"expYear","value":"2025","type":"text"},{"key":"friendlyName","value":"demo card","type":"text"},{"key":"taxVal","value":"1.0","type":"text"},{"key":"amount","value":"15.00","type":"text"},{"key":"totalAmount","value":"16.00","type":"text"},{"key":"bAddress","value":"#12/24 12th Demo street","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"Texas","type":"text"},{"key":"bZipcode","value":"87026","type":"text"},{"key":"bCountry","value":"US","type":"text"},{"key":"shipAddress","value":"","type":"text"},{"key":"shipCity","value":"","type":"text"},{"key":"shipState","value":"","type":"text"},{"key":"shipCountry","value":"","type":"text"},{"key":"shipZipcode","value":"","type":"text"},{"key":"firstName","value":"Demo","type":"text"},{"key":"lastName","value":"demo","type":"text"},{"key":"userEmail","value":"demo.demo@cztester.com","type":"text"},{"key":"userContact","value":"45611321345","type":"text"},{"key":"companyName","value":"Demo Copany","type":"text"},{"key":"refNo","value":"#123","type":"text"},{"key":"gatewayIdentifier","value":"AUTHORIZE_GATEWAY","type":"text"},{"key":"saveCard","value":"1","type":"text"}]},"url":"{{url}}/AuthSale/process_auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 11:58:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment authorized successfully.\",\n \"data\": \"60179380824\",\n \"code\": 200\n}"},{"id":"a2b80177-518f-4c0c-a9f0-9dc2a48ce152","name":"FluidPay Authorize Payment Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"3f5445c15e863c459f24c65381c2e203901b8564","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzcxNTIzODYsImNoayI6MTQ5OTY4NzAzLCJzdGFydCI6MTYzNzE1MjM4NiwiZXhwaXJlIjoxNjM3MTU5NTg2LCJ1c2VybmFtZSI6ImludHVpdC5uYXBtZXJjaGFudDE5NEBtYWlsbmF0b3IuY29tIiwibWlkIjoiMjk0IiwiaWQiOiIyOTQiLCJzZXJ2aWNlIjoiNSIsImNvbXBhbnkiOjAsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.YZeczGIEVyI69L1ctoYTHrT7ern2FKEd0PmEaR_ygZc","type":"text"},{"key":"customerId","value":"CUS-7922420-MACFJ7","type":"text"},{"key":"cardId","value":"new1","type":"text","description":"new1 if card is new"},{"key":"cardNo","value":"4111111111111111","type":"text"},{"key":"cardCvv","value":"999","type":"text"},{"key":"expMonth","value":"12","type":"text"},{"key":"expYear","value":"2025","type":"text"},{"key":"friendlyName","value":"demo card","type":"text"},{"key":"taxVal","value":"1.0","type":"text"},{"key":"amount","value":"15.00","type":"text"},{"key":"totalAmount","value":"16.00","type":"text"},{"key":"bAddress","value":"#12/24 12th street ","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"Texas","type":"text"},{"key":"bZipcode","value":"87026","type":"text"},{"key":"bCountry","value":"US","type":"text"},{"key":"shipAddress","value":"","type":"text"},{"key":"shipCity","value":"","type":"text"},{"key":"shipState","value":"","type":"text"},{"key":"shipCountry","value":"","type":"text"},{"key":"shipZipcode","value":"","type":"text"},{"key":"firstName","value":"Leo","type":"text"},{"key":"lastName","value":"Dison","type":"text"},{"key":"userEmail","value":"leao.dison@cztester.com","type":"text"},{"key":"userContact","value":"45611321345","type":"text"},{"key":"companyName","value":"Leo corp","type":"text"},{"key":"refNo","value":"","type":"text"},{"key":"gatewayIdentifier","value":"FLUIDPAY_GATEWAY","type":"text"},{"key":"saveCard","value":"1","type":"text"}]},"url":"{{url}}/AuthSale/process_auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Nov 2021 12:33:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"608"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment authorized successfully\",\n \"data\": \"c6afdb46lr8skt0f703g\",\n \"code\": 200\n}"}],"_postman_id":"560e47b5-f6b7-4826-81d1-3e1d35ca1c92"},{"name":"Get Authorized Transactions","id":"73c4b8af-5568-4b8e-afdf-ae650a3f1918","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/NMIPayment/get_auth_transaction_data","description":"

Get all authorized transactions.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
page	Page number	No	Integer	-	Page number, (if provided needs to be greater than 0).
limit	Limit	No	Integer	-	Records per page, (if provided needs to be greater than 0).

","urlObject":{"path":["NMIPayment","get_auth_transaction_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"82f87fdd-406a-406b-a42b-85fddf866a20","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2NzEwODQsImNoayI6MTg1OTQ5Mzk1MSwic3RhcnQiOjE2MTQ2NzEwODQsImV4cGlyZSI6MTYxNDY3ODI4NCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.08Y2jrZTzu1oEcfw1kEx5GJDSu_nPH0h-xox1WdNdjM"}]},"url":"{{url}}/NMIPayment/get_auth_transaction_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Mar 2021 07:52:47 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22fbce5aa8921060706a719e14817a9134%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614671567%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D6056bb92367f3a7e677a7df556cf5541cffd9adb; expires=Tue, 02-Mar-2021 09:52:47 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"2490"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorize transactions\",\n \"data\": [\n {\n \"id\": \"20628\",\n \"transactionID\": \"5927684506\",\n \"transactionDate\": \"2021-01-13 06:41:46\",\n \"transactionStatus\": \"SUCCESS\",\n \"transactionAmount\": \"7.00\",\n \"customerListID\": \"58\",\n \"transactionModified\": \"2021-01-13 06:41:46\",\n \"transactionType\": \"auth\",\n \"transactionGateway\": \"1\",\n \"gateway\": \"NMI\",\n \"gatewayID\": \"656\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"100\",\n \"transactionCard\": null,\n \"transaction_user_status\": \"4\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": null,\n \"creditTxnID\": null,\n \"qbListTxnID\": null,\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": null,\n \"transaction_by_user_id\": null,\n \"fullName\": \"Aman Jain\"\n }\n ],\n \"code\": 200\n}"},{"id":"0725b4b6-b35f-411f-a6b5-6d3037afb5c2","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2NzEwODQsImNoayI6MTg1OTQ5Mzk1MSwic3RhcnQiOjE2MTQ2NzEwODQsImV4cGlyZSI6MTYxNDY3ODI4NCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.08Y2jrZTzu1oEcfw1kEx5GJDSu_nPH0h-xox1WdNdjM"}]},"url":"{{url}}/NMIPayment/get_auth_transaction_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Mar 2021 07:52:47 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22fbce5aa8921060706a719e14817a9134%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614671567%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D6056bb92367f3a7e677a7df556cf5541cffd9adb; expires=Tue, 02-Mar-2021 09:52:47 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"2490"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No record found\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"73c4b8af-5568-4b8e-afdf-ae650a3f1918"}],"id":"9c9bb42f-0974-4c1d-983c-bed5ad6eef35","description":"

Authorize credit card for all gateways.

\n","_postman_id":"9c9bb42f-0974-4c1d-983c-bed5ad6eef35"},{"name":"Capture","item":[{"name":"Authorize Capture Transaction","id":"6b6372f7-b74b-4572-9c38-303a1f7b6cbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/CaptureSale/process_capture","description":"

Capture transaction.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
transactionId	Transaction ID	Yes	String	-	Authorize payment transaction ID

","urlObject":{"path":["CaptureSale","process_capture"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"720d1788-c3b2-4fa4-9572-718e9e721b2d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2MzA0OTAsImNoayI6NzQyNDI3NzMsInN0YXJ0IjoxNjM2NjMwNDkwLCJleHBpcmUiOjE2MzY2Mzc2OTAsInVzZXJuYW1lIjoibXJpLmFwY0BjenRlc3Rlci5jb20iLCJtaWQiOiIzMjMiLCJpZCI6IjMyMyIsInNlcnZpY2UiOiI1IiwiY29tcGFueSI6MCwiZG9tYWluIjoicGF5cG9ydGFsZGV2LmNvbSIsInJvbGUiOiJtZXJjaGFudCJ9.6drLeZjtcw_ETUBJdE0U8awqxwywEXTcvJNf2ToMC7E","description":"Token","type":"text"},{"key":"transactionId","value":"6732762194","description":"required (authorization transaction ID)","type":"text"}]},"url":"{{url}}/CaptureSale/process_capture"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 12:54:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_payportal_=a%3A4%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22a64e4e8fb75ebc42268d8a768f349057%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A21%3A%22PostmanRuntime%2F7.28.4%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1636635256%3B%7D15fd6d878c00dd32e23bba7fd0d4ba6545ee882f; expires=Thu, 11-Nov-2021 14:54:16 GMT; Max-Age=7200; path=/; domain=payportaldev.com"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction captured successfully.\",\n \"data\": \"6732837410\",\n \"code\": 200\n}"},{"id":"2d5189da-e7f2-40fa-8777-eabae8340a50","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2MzA0OTAsImNoayI6NzQyNDI3NzMsInN0YXJ0IjoxNjM2NjMwNDkwLCJleHBpcmUiOjE2MzY2Mzc2OTAsInVzZXJuYW1lIjoibXJpLmFwY0BjenRlc3Rlci5jb20iLCJtaWQiOiIzMjMiLCJpZCI6IjMyMyIsInNlcnZpY2UiOiI1IiwiY29tcGFueSI6MCwiZG9tYWluIjoicGF5cG9ydGFsZGV2LmNvbSIsInJvbGUiOiJtZXJjaGFudCJ9.6drLeZjtcw_ETUBJdE0U8awqxwywEXTcvJNf2ToMC7E","description":"Token","type":"text"},{"key":"transactionId","value":"67327621940","description":"required (authorization transaction ID)","type":"text"}]},"url":"{{url}}/CaptureSale/process_capture"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 13:25:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_payportal_=a%3A4%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%220a63b14f68abfc26baa24c09d6656b85%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A21%3A%22PostmanRuntime%2F7.28.4%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1636637143%3B%7D3744e58f4469e2448ff9887fa004171833f43f5a; expires=Thu, 11-Nov-2021 15:25:43 GMT; Max-Age=7200; path=/; domain=payportaldev.com"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Transaction\",\n \"data\": \"\",\n \"code\": 405\n}"}],"_postman_id":"6b6372f7-b74b-4572-9c38-303a1f7b6cbe"}],"id":"f53910f1-44f8-4e25-9c9a-48c2f9f31123","description":"

Capture transactions for all gateways.

\n","_postman_id":"f53910f1-44f8-4e25-9c9a-48c2f9f31123"},{"name":"Void","item":[{"name":"Void Authorized Transaction","id":"ab8dc331-5fe6-4195-940f-82bb7382d9ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/Sale/process_void","description":"

Void authorized transactions.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
transactionId	Transaction Id	Yes	String	-	Authorize payment transaction Id

","urlObject":{"path":["Sale","process_void"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"55a4749d-d6d2-469b-996d-1f046666f2d9","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2MzA0OTAsImNoayI6NzQyNDI3NzMsInN0YXJ0IjoxNjM2NjMwNDkwLCJleHBpcmUiOjE2MzY2Mzc2OTAsInVzZXJuYW1lIjoibXJpLmFwY0BjenRlc3Rlci5jb20iLCJtaWQiOiIzMjMiLCJpZCI6IjMyMyIsInNlcnZpY2UiOiI1IiwiY29tcGFueSI6MCwiZG9tYWluIjoicGF5cG9ydGFsZGV2LmNvbSIsInJvbGUiOiJtZXJjaGFudCJ9.6drLeZjtcw_ETUBJdE0U8awqxwywEXTcvJNf2ToMC7E","type":"text"},{"key":"transactionId","value":"3127792776","type":"text"}]},"url":"{{url}}/Sale/process_void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 13:30:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction voided successfully.\",\n \"data\": \"3127792776\",\n \"code\": 200\n}"},{"id":"edfca136-b600-4871-9c23-238968935bd5","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2MzA0OTAsImNoayI6NzQyNDI3NzMsInN0YXJ0IjoxNjM2NjMwNDkwLCJleHBpcmUiOjE2MzY2Mzc2OTAsInVzZXJuYW1lIjoibXJpLmFwY0BjenRlc3Rlci5jb20iLCJtaWQiOiIzMjMiLCJpZCI6IjMyMyIsInNlcnZpY2UiOiI1IiwiY29tcGFueSI6MCwiZG9tYWluIjoicGF5cG9ydGFsZGV2LmNvbSIsInJvbGUiOiJtZXJjaGFudCJ9.6drLeZjtcw_ETUBJdE0U8awqxwywEXTcvJNf2ToMC7E","type":"text"},{"key":"transactionId","value":"312779277689","type":"text"}]},"url":"{{url}}/Sale/process_void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 13:30:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Transaction\",\n \"data\": \"\",\n \"code\": 405\n}"},{"id":"d06ae49d-803f-4129-9bd9-5125db1b2a32","name":"Fluid Success Transaction","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"3f5445c15e863c459f24c65381c2e203901b8564","description":"required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzcxNTIzODYsImNoayI6MTQ5OTY4NzAzLCJzdGFydCI6MTYzNzE1MjM4NiwiZXhwaXJlIjoxNjM3MTU5NTg2LCJ1c2VybmFtZSI6ImludHVpdC5uYXBtZXJjaGFudDE5NEBtYWlsbmF0b3IuY29tIiwibWlkIjoiMjk0IiwiaWQiOiIyOTQiLCJzZXJ2aWNlIjoiNSIsImNvbXBhbnkiOjAsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.YZeczGIEVyI69L1ctoYTHrT7ern2FKEd0PmEaR_ygZc","description":"required","type":"text"},{"key":"transactionId","value":"c6ag1ec6lr8skt0f70v0","description":"required","type":"text"}]},"url":"{{url}}/Sale/process_void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Nov 2021 13:17:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"84"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction voided successfully.\",\n \"data\": \"c6ag1ec6lr8skt0f70v0\",\n \"code\": 200\n}"},{"id":"1105e29c-f6b4-43f0-808d-fe3179aa6582","name":"FluidPay Failed Transaction","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"3f5445c15e863c459f24c65381c2e203901b8564","description":"required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzcxNTIzODYsImNoayI6MTQ5OTY4NzAzLCJzdGFydCI6MTYzNzE1MjM4NiwiZXhwaXJlIjoxNjM3MTU5NTg2LCJ1c2VybmFtZSI6ImludHVpdC5uYXBtZXJjaGFudDE5NEBtYWlsbmF0b3IuY29tIiwibWlkIjoiMjk0IiwiaWQiOiIyOTQiLCJzZXJ2aWNlIjoiNSIsImNvbXBhbnkiOjAsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.YZeczGIEVyI69L1ctoYTHrT7ern2FKEd0PmEaR_ygZc","description":"required","type":"text"},{"key":"transactionId","value":"c6afhr46lr8skt0f707g","description":"required","type":"text"}]},"url":"{{url}}/Sale/process_void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Nov 2021 13:14:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_payportal_=a%3A4%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22e9fd421a98234aa8b30ba45917d67556%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A21%3A%22PostmanRuntime%2F7.28.4%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1637154855%3B%7D8102142f5ad7892fa24abc8922e6a15e12aba4ad; expires=Wed, 17-Nov-2021 15:14:15 GMT; Max-Age=7200; path=/; domain=payportaldev.com"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"transaction must be in 'authorized' or 'pending_settlement' status, in order to void\",\n \"data\": \"\",\n \"code\": 400\n}"}],"_postman_id":"ab8dc331-5fe6-4195-940f-82bb7382d9ce"}],"id":"f33ba240-c6d7-4096-990c-be0eeb33a337","description":"

Void transactions for all gateways.

\n","_postman_id":"f33ba240-c6d7-4096-990c-be0eeb33a337"},{"name":"Refund","item":[{"name":"Refund a Transaction","id":"088fb667-774e-4159-bf80-b5ae4df87325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/Sale/process_refund","description":"

Refund a sale transaction.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
transactionId	Transaction ID	Yes	String	-	Payment transaction ID

","urlObject":{"path":["Sale","process_refund"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d6459dca-ed41-4ef3-bac2-2e108d7629c2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc"}],"body":{"mode":"formdata","formdata":[{"description":"required (authorization transaction ID)","key":"transactionId","type":"text","value":"6732612010"},{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2Mzc3ODUsImNoayI6MTQwNDM2MjM4Nywic3RhcnQiOjE2MzY2Mzc3ODUsImV4cGlyZSI6MTYzNjY0NDk4NSwidXNlcm5hbWUiOiJtcmkuYXBjQGN6dGVzdGVyLmNvbSIsIm1pZCI6IjMyMyIsImlkIjoiMzIzIiwic2VydmljZSI6IjUiLCJjb21wYW55IjowLCJkb21haW4iOiJwYXlwb3J0YWxkZXYuY29tIiwicm9sZSI6Im1lcmNoYW50In0.A3sMVcEU90wrePkLcm06Noha87knibBd_zuQZGyaQbM"}]},"url":"{{url}}/Sale/process_refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 13:37:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refunded successfully.\",\n \"data\": \"6732902737\",\n \"code\": 200\n}"},{"id":"732d73db-dfd9-4c83-b652-9559c4bae56e","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc"}],"body":{"mode":"formdata","formdata":[{"description":"required (authorization transaction ID)","key":"transactionId","type":"text","value":"4343718086"},{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2Mzc3ODUsImNoayI6MTQwNDM2MjM4Nywic3RhcnQiOjE2MzY2Mzc3ODUsImV4cGlyZSI6MTYzNjY0NDk4NSwidXNlcm5hbWUiOiJtcmkuYXBjQGN6dGVzdGVyLmNvbSIsIm1pZCI6IjMyMyIsImlkIjoiMzIzIiwic2VydmljZSI6IjUiLCJjb21wYW55IjowLCJkb21haW4iOiJwYXlwb3J0YWxkZXYuY29tIiwicm9sZSI6Im1lcmNoYW50In0.A3sMVcEU90wrePkLcm06Noha87knibBd_zuQZGyaQbM"}]},"url":"{{url}}/Sale/process_refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 13:36:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Transaction\",\n \"data\": \"\",\n \"code\": 405\n}"}],"_postman_id":"088fb667-774e-4159-bf80-b5ae4df87325"},{"name":"Get All Refund Transactions","id":"b359b69e-071b-4a2d-952a-d944c878d9c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/NMIPayment/get_all_refund_transaction_data","description":"

Get all refund transactions.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["NMIPayment","get_all_refund_transaction_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a012f353-cf63-44ae-a7e9-2ce9b26ce3ef","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2ODQ3MTIsImNoayI6MTUxNzk1MDEzMCwic3RhcnQiOjE2MTQ2ODQ3MTIsImV4cGlyZSI6MTYxNDY5MTkxMiwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.rX3uhtI-kP4IBYz3mqMkUL-ugbL5sEb7vUPu2c64wO0"}]},"url":"{{url}}/NMIPayment/get_all_refund_transaction_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Mar 2021 12:01:59 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2275366ac3c052fca7513255bf92f7a2c5%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614686519%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D84c0260352b7eed1b4b2f655530bf0afc6671a85; expires=Tue, 02-Mar-2021 14:01:59 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"6186"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"All Refund Transactions\",\n \"data\": [\n {\n \"id\": \"25320\",\n \"transactionID\": \"6052751064\",\n \"transactionDate\": \"2021-03-02 11:59:44\",\n \"transactionStatus\": \"SUCCESS\",\n \"transactionAmount\": \"45.00\",\n \"customerListID\": \"63\",\n \"transactionModified\": null,\n \"transactionType\": \"refund\",\n \"transactionGateway\": \"1\",\n \"gateway\": \"NMI\",\n \"gatewayID\": \"704\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"100\",\n \"transactionCard\": null,\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": null,\n \"creditTxnID\": null,\n \"qbListTxnID\": null,\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": \"1\",\n \"transaction_by_user_id\": \"478\",\n \"customerID\": \"0\",\n \"Customer_ListID\": \"63\",\n \"firstName\": \"Ajit\",\n \"lastName\": \"Singh\",\n \"fullName\": \"Ajit Singh\",\n \"userEmail\": \"ajit.singh@mailinator.com\",\n \"phoneNumber\": \"\",\n \"address1\": \"1 - H Electronics Complex\",\n \"address2\": \"Near Lal Bagh\",\n \"Country\": \"USA\",\n \"State\": \"CA\",\n \"City\": \"CA\",\n \"zipCode\": \"258963\",\n \"ship_address1\": null,\n \"ship_address2\": null,\n \"ship_country\": null,\n \"ship_state\": null,\n \"ship_city\": null,\n \"ship_zipcode\": null,\n \"companyName\": \"ECO QBO Sandbox Company_US_2\",\n \"companyID\": \"4620816365157259960\",\n \"accept\": null,\n \"createdAt\": \"2021-01-11 11:44:13\",\n \"updatedAt\": \"2021-02-23 13:43:44\",\n \"listID\": \"1\",\n \"profile_picture\": null,\n \"customerStatus\": \"true\"\n },\n {\n \"id\": \"24264\",\n \"transactionID\": \"8303415\",\n \"transactionDate\": \"2021-02-24 14:45:24\",\n \"transactionStatus\": \"Return requested, Void successful\",\n \"transactionAmount\": \"95.00\",\n \"customerListID\": \"63\",\n \"transactionModified\": \"2021-02-24 14:45:24\",\n \"transactionType\": \"refund\",\n \"transactionGateway\": \"12\",\n \"gateway\": \"TSYS\",\n \"gatewayID\": \"712\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"100\",\n \"transactionCard\": null,\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": \"\",\n \"creditTxnID\": null,\n \"qbListTxnID\": \"\",\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": \"1\",\n \"transaction_by_user_id\": \"478\",\n \"customerID\": \"0\",\n \"Customer_ListID\": \"63\",\n \"firstName\": \"Ajit\",\n \"lastName\": \"Singh\",\n \"fullName\": \"Ajit Singh\",\n \"userEmail\": \"ajit.singh@mailinator.com\",\n \"phoneNumber\": \"\",\n \"address1\": \"1 - H Electronics Complex\",\n \"address2\": \"Near Lal Bagh\",\n \"Country\": \"USA\",\n \"State\": \"CA\",\n \"City\": \"CA\",\n \"zipCode\": \"258963\",\n \"ship_address1\": null,\n \"ship_address2\": null,\n \"ship_country\": null,\n \"ship_state\": null,\n \"ship_city\": null,\n \"ship_zipcode\": null,\n \"companyName\": \"ECO QBO Sandbox Company_US_2\",\n \"companyID\": \"4620816365157259960\",\n \"accept\": null,\n \"createdAt\": \"2021-01-11 11:44:13\",\n \"updatedAt\": \"2021-02-23 13:43:44\",\n \"listID\": \"1\",\n \"profile_picture\": null,\n \"customerStatus\": \"true\"\n },\n {\n \"id\": \"24263\",\n \"transactionID\": \"\",\n \"transactionDate\": \"2021-02-24 14:45:13\",\n \"transactionStatus\": null,\n \"transactionAmount\": \"150.00\",\n \"customerListID\": \"73\",\n \"transactionModified\": \"2021-02-24 14:45:13\",\n \"transactionType\": \"refund\",\n \"transactionGateway\": \"12\",\n \"gateway\": \"TSYS\",\n \"gatewayID\": \"712\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"300\",\n \"transactionCard\": null,\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": \"258\",\n \"creditTxnID\": null,\n \"qbListTxnID\": \"267\",\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": \"1\",\n \"transaction_by_user_id\": \"478\",\n \"customerID\": \"0\",\n \"Customer_ListID\": \"73\",\n \"firstName\": \"Deepak\",\n \"lastName\": \"Kumar\",\n \"fullName\": \"Deepak Kumar\",\n \"userEmail\": \"deepak.qbo@mailinator.com\",\n \"phoneNumber\": \"(956) 895-6895\",\n \"address1\": \"12 - U LIG\",\n \"address2\": \"\",\n \"Country\": \"USA\",\n \"State\": \"LA\",\n \"City\": \"LA\",\n \"zipCode\": \"456654\",\n \"ship_address1\": \"12 - U LIG\",\n \"ship_address2\": \"\",\n \"ship_country\": \"USA\",\n \"ship_state\": \"LA\",\n \"ship_city\": \"LA\",\n \"ship_zipcode\": \"456654\",\n \"companyName\": \"HP Corporation Sandbox Company_US_2\",\n \"companyID\": \"4620816365157259960\",\n \"accept\": null,\n \"createdAt\": \"2021-02-23 13:22:01\",\n \"updatedAt\": \"2021-02-24 14:44:58\",\n \"listID\": \"1\",\n \"profile_picture\": null,\n \"customerStatus\": \"true\"\n },\n {\n \"id\": \"24262\",\n \"transactionID\": \"8303423\",\n \"transactionDate\": \"2021-02-24 14:45:12\",\n \"transactionStatus\": \"Return requested, Void successful\",\n \"transactionAmount\": \"150.00\",\n \"customerListID\": \"73\",\n \"transactionModified\": \"2021-02-24 14:45:12\",\n \"transactionType\": \"refund\",\n \"transactionGateway\": \"12\",\n \"gateway\": \"TSYS\",\n \"gatewayID\": \"712\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"100\",\n \"transactionCard\": null,\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": \"\",\n \"creditTxnID\": null,\n \"qbListTxnID\": \"\",\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": \"1\",\n \"transaction_by_user_id\": \"478\",\n \"customerID\": \"0\",\n \"Customer_ListID\": \"73\",\n \"firstName\": \"Deepak\",\n \"lastName\": \"Kumar\",\n \"fullName\": \"Deepak Kumar\",\n \"userEmail\": \"deepak.qbo@mailinator.com\",\n \"phoneNumber\": \"(956) 895-6895\",\n \"address1\": \"12 - U LIG\",\n \"address2\": \"\",\n \"Country\": \"USA\",\n \"State\": \"LA\",\n \"City\": \"LA\",\n \"zipCode\": \"456654\",\n \"ship_address1\": \"12 - U LIG\",\n \"ship_address2\": \"\",\n \"ship_country\": \"USA\",\n \"ship_state\": \"LA\",\n \"ship_city\": \"LA\",\n \"ship_zipcode\": \"456654\",\n \"companyName\": \"HP Corporation Sandbox Company_US_2\",\n \"companyID\": \"4620816365157259960\",\n \"accept\": null,\n \"createdAt\": \"2021-02-23 13:22:01\",\n \"updatedAt\": \"2021-02-24 14:44:58\",\n \"listID\": \"1\",\n \"profile_picture\": null,\n \"customerStatus\": \"true\"\n },\n {\n \"id\": \"23310\",\n \"transactionID\": \"6010893023\",\n \"transactionDate\": \"2021-02-15 13:56:27\",\n \"transactionStatus\": \"SUCCESS\",\n \"transactionAmount\": \"50.00\",\n \"customerListID\": \"67\",\n \"transactionModified\": \"2021-02-15 13:56:27\",\n \"transactionType\": \"refund\",\n \"transactionGateway\": \"1\",\n \"gateway\": \"NMI\",\n \"gatewayID\": \"704\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"100\",\n \"transactionCard\": null,\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": \"239\",\n \"creditTxnID\": null,\n \"qbListTxnID\": \"245\",\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": \"1\",\n \"transaction_by_user_id\": \"478\",\n \"customerID\": \"0\",\n \"Customer_ListID\": \"67\",\n \"firstName\": \"Avinash\",\n \"lastName\": \"Kumar\",\n \"fullName\": \"Avinash Kumar\",\n \"userEmail\": \"avinash.qbo@mailinator.com\",\n \"phoneNumber\": \"\",\n \"address1\": \"12 - T-Set, Near Lal Bagh\",\n \"address2\": \"Near Lal Bagh\",\n \"Country\": \"United States\",\n \"State\": \"CA\",\n \"City\": \"CA\",\n \"zipCode\": \"25896\",\n \"ship_address1\": \"12 - T-Set, Near Lal Bagh\",\n \"ship_address2\": \"Near Lal Bagh\",\n \"ship_country\": \"United States\",\n \"ship_state\": \"CA\",\n \"ship_city\": \"CA\",\n \"ship_zipcode\": \"25896\",\n \"companyName\": \"ECO QBO Sandbox_Company _US_2\",\n \"companyID\": \"4620816365157259960\",\n \"accept\": null,\n \"createdAt\": \"2021-01-21 14:45:32\",\n \"updatedAt\": \"2021-02-18 09:20:02\",\n \"listID\": \"1\",\n \"profile_picture\": null,\n \"customerStatus\": \"true\"\n }\n ],\n \"code\": 200\n}"},{"id":"af1558f4-c5d7-45c6-98fa-638c0fb5d767","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ2ODQ3MTIsImNoayI6MTUxNzk1MDEzMCwic3RhcnQiOjE2MTQ2ODQ3MTIsImV4cGlyZSI6MTYxNDY5MTkxMiwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.rX3uhtI-kP4IBYz3mqMkUL-ugbL5sEb7vUPu2c64wO0"}]},"url":"{{url}}/NMIPayment/get_all_refund_transaction_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Mar 2021 12:01:59 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2275366ac3c052fca7513255bf92f7a2c5%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614686519%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D84c0260352b7eed1b4b2f655530bf0afc6671a85; expires=Tue, 02-Mar-2021 14:01:59 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"6186"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"All Refund Transactions\",\n \"data\": [],\n \"code\": 200\n}"}],"_postman_id":"b359b69e-071b-4a2d-952a-d944c878d9c3"}],"id":"567e0989-1c3f-4ff0-98e5-a43e961ae825","description":"

Refund transactions for all gateways.

\n","_postman_id":"567e0989-1c3f-4ff0-98e5-a43e961ae825"},{"name":"Get All Transactions","id":"71312be6-ea70-4b4f-9200-ed5230c81089","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/NMIPayment/get_payment_transaction_data","description":"

Get all transactions.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
page	Page number	No	Integer	-	Page number, (if provided needs to be greater than 0).
limit	Limit	No	Integer	-	Records per page, (if provided needs to be greater than 0).

","urlObject":{"path":["NMIPayment","get_payment_transaction_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ce5aead6-4fe4-4ebf-9307-7f3a674ec5f7","name":"Error","originalRequest":{"method":"POST","header":[{"description":"Required","key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ3NjI0NjcsImNoayI6OTM2MTA2Niwic3RhcnQiOjE2MTQ3NjI0NjcsImV4cGlyZSI6MTYxNDc2OTY2NywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Tt1cQHDylw6gSfMJNMfMJfOc3Dznvs--ijXJzlaFHhc"},{"key":"page","value":"0","type":"text"},{"key":"limit","value":"50","type":"text"}]},"url":"{{url}}/NMIPayment/get_payment_transaction_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Mar 2021 10:10:04 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%224bd4ef6528d4b2bd6f7e48f325020d38%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614766204%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Daa6334b979a21a2af0ab99b261d86ab3274ccc71; expires=Wed, 03-Mar-2021 12:10:04 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"141961"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"All transaction\",\n \"data\": [],\n \"code\": 200\n}"},{"id":"84236418-0d24-4da0-ba54-810e089e4479","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Required","key":"secretKey","type":"text","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQ3NjI0NjcsImNoayI6OTM2MTA2Niwic3RhcnQiOjE2MTQ3NjI0NjcsImV4cGlyZSI6MTYxNDc2OTY2NywidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.Tt1cQHDylw6gSfMJNMfMJfOc3Dznvs--ijXJzlaFHhc"},{"key":"page","value":"0","type":"text"},{"key":"limit","value":"50","type":"text"}]},"url":"{{url}}/NMIPayment/get_payment_transaction_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Mar 2021 10:10:04 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%224bd4ef6528d4b2bd6f7e48f325020d38%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614766204%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Daa6334b979a21a2af0ab99b261d86ab3274ccc71; expires=Wed, 03-Mar-2021 12:10:04 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"141961"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"All transaction\",\n \"data\": [\n {\n \"id\": \"25564\",\n \"transactionID\": \"6055565632\",\n \"transactionDate\": \"2021-03-03 09:52:39\",\n \"transactionStatus\": \"SUCCESS\",\n \"transactionAmount\": \"50.00\",\n \"customerListID\": \"62\",\n \"transactionModified\": \"2021-03-03 09:52:39\",\n \"transactionType\": \"sale\",\n \"transactionGateway\": \"1\",\n \"gateway\": \"NMI\",\n \"gatewayID\": \"704\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"100\",\n \"transactionCard\": null,\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": \"300\",\n \"creditTxnID\": null,\n \"qbListTxnID\": \"\",\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": null,\n \"transaction_by_user_id\": null,\n \"FirstName\": \"Mr. Arnab\",\n \"LastName\": \"Sharma\",\n \"FullName\": \"Mr. Arnab Sharma\",\n \"Email\": \"arnab.qbo@mailinator.com\",\n \"Phone\": \"\",\n \"BillingAddress_Addr1\": \"1 - H Electronics Complex\",\n \"BillingAddress_Addr2\": \"Near LIG\",\n \"BillingAddress_Country\": \"USA\",\n \"BillingAddress_State\": \"CA\",\n \"BillingAddress_City\": \"CA\",\n \"BillingAddress_PostalCode\": \"258963\",\n \"ShipAddress_Addr1\": null,\n \"ShipAddress_Addr2\": null,\n \"ShipAddress_Country\": null,\n \"ShipAddress_State\": null,\n \"ShipAddress_City\": null,\n \"ShipAddress_PostalCode\": null,\n \"CompanyName\": \"ECO QBO Sandbox Company_US_2\",\n \"CompanyID\": \"4620816365157259960\",\n \"Profile_Picture\": null,\n \"CustomerStatus\": \"true\"\n },\n {\n \"id\": \"25563\",\n \"transactionID\": \"371678580\",\n \"transactionDate\": \"2021-03-03 09:48:28\",\n \"transactionStatus\": \"Your transaction was successfully approved.\",\n \"transactionAmount\": \"50.00\",\n \"customerListID\": \"62\",\n \"transactionModified\": \"2021-03-03 09:48:28\",\n \"transactionType\": \"pay_sale\",\n \"transactionGateway\": \"3\",\n \"gateway\": \"Paytrace\",\n \"gatewayID\": \"667\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"200\",\n \"transactionCard\": \"1111\",\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": \"300\",\n \"creditTxnID\": null,\n \"qbListTxnID\": \"\",\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": null,\n \"transaction_by_user_id\": null,\n \"FirstName\": \"Mr. Arnab\",\n \"LastName\": \"Sharma\",\n \"FullName\": \"Mr. Arnab Sharma\",\n \"Email\": \"arnab.qbo@mailinator.com\",\n \"Phone\": \"\",\n \"BillingAddress_Addr1\": \"1 - H Electronics Complex\",\n \"BillingAddress_Addr2\": \"Near LIG\",\n \"BillingAddress_Country\": \"USA\",\n \"BillingAddress_State\": \"CA\",\n \"BillingAddress_City\": \"CA\",\n \"BillingAddress_PostalCode\": \"258963\",\n \"ShipAddress_Addr1\": null,\n \"ShipAddress_Addr2\": null,\n \"ShipAddress_Country\": null,\n \"ShipAddress_State\": null,\n \"ShipAddress_City\": null,\n \"ShipAddress_PostalCode\": null,\n \"CompanyName\": \"ECO QBO Sandbox Company_US_2\",\n \"CompanyID\": \"4620816365157259960\",\n \"Profile_Picture\": null,\n \"CustomerStatus\": \"true\"\n },\n {\n \"id\": \"25562\",\n \"transactionID\": \"40060168905\",\n \"transactionDate\": \"2021-03-03 09:40:45\",\n \"transactionStatus\": \"This transaction has been approved.\",\n \"transactionAmount\": \"50.00\",\n \"customerListID\": \"62\",\n \"transactionModified\": \"2021-03-03 09:40:45\",\n \"transactionType\": \"auth_capture\",\n \"transactionGateway\": \"2\",\n \"gateway\": \"Auth\",\n \"gatewayID\": \"693\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"1\",\n \"transactionCard\": \"1111\",\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": \"300\",\n \"creditTxnID\": null,\n \"qbListTxnID\": \"\",\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": null,\n \"transaction_by_user_id\": null,\n \"FirstName\": \"Mr. Arnab\",\n \"LastName\": \"Sharma\",\n \"FullName\": \"Mr. Arnab Sharma\",\n \"Email\": \"arnab.qbo@mailinator.com\",\n \"Phone\": \"\",\n \"BillingAddress_Addr1\": \"1 - H Electronics Complex\",\n \"BillingAddress_Addr2\": \"Near LIG\",\n \"BillingAddress_Country\": \"USA\",\n \"BillingAddress_State\": \"CA\",\n \"BillingAddress_City\": \"CA\",\n \"BillingAddress_PostalCode\": \"258963\",\n \"ShipAddress_Addr1\": null,\n \"ShipAddress_Addr2\": null,\n \"ShipAddress_Country\": null,\n \"ShipAddress_State\": null,\n \"ShipAddress_City\": null,\n \"ShipAddress_PostalCode\": null,\n \"CompanyName\": \"ECO QBO Sandbox Company_US_2\",\n \"CompanyID\": \"4620816365157259960\",\n \"Profile_Picture\": null,\n \"CustomerStatus\": \"true\"\n },\n {\n \"id\": \"25561\",\n \"transactionID\": \"40060168808\",\n \"transactionDate\": \"2021-03-03 09:38:32\",\n \"transactionStatus\": \"This transaction has been approved.\",\n \"transactionAmount\": \"50.00\",\n \"customerListID\": \"62\",\n \"transactionModified\": \"2021-03-03 09:38:32\",\n \"transactionType\": \"auth_capture\",\n \"transactionGateway\": \"2\",\n \"gateway\": \"Auth\",\n \"gatewayID\": \"693\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"1\",\n \"transactionCard\": \"1111\",\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": \"300\",\n \"creditTxnID\": null,\n \"qbListTxnID\": \"\",\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": null,\n \"transaction_by_user_id\": null,\n \"FirstName\": \"Mr. Arnab\",\n \"LastName\": \"Sharma\",\n \"FullName\": \"Mr. Arnab Sharma\",\n \"Email\": \"arnab.qbo@mailinator.com\",\n \"Phone\": \"\",\n \"BillingAddress_Addr1\": \"1 - H Electronics Complex\",\n \"BillingAddress_Addr2\": \"Near LIG\",\n \"BillingAddress_Country\": \"USA\",\n \"BillingAddress_State\": \"CA\",\n \"BillingAddress_City\": \"CA\",\n \"BillingAddress_PostalCode\": \"258963\",\n \"ShipAddress_Addr1\": null,\n \"ShipAddress_Addr2\": null,\n \"ShipAddress_Country\": null,\n \"ShipAddress_State\": null,\n \"ShipAddress_City\": null,\n \"ShipAddress_PostalCode\": null,\n \"CompanyName\": \"ECO QBO Sandbox Company_US_2\",\n \"CompanyID\": \"4620816365157259960\",\n \"Profile_Picture\": null,\n \"CustomerStatus\": \"true\"\n },\n {\n \"id\": \"25559\",\n \"transactionID\": \"40060168700\",\n \"transactionDate\": \"2021-03-03 09:36:07\",\n \"transactionStatus\": \"This transaction has been approved.\",\n \"transactionAmount\": \"14.52\",\n \"customerListID\": \"62\",\n \"transactionModified\": \"2021-03-03 09:36:07\",\n \"transactionType\": \"auth_capture\",\n \"transactionGateway\": \"2\",\n \"gateway\": \"Auth\",\n \"gatewayID\": \"693\",\n \"invoiceTxnID\": null,\n \"transactionCode\": \"1\",\n \"transactionCard\": \"1111\",\n \"transaction_user_status\": \"1\",\n \"merchantID\": \"478\",\n \"resellerID\": \"11\",\n \"invoiceID\": \"298\",\n \"creditTxnID\": null,\n \"qbListTxnID\": null,\n \"invoiceRefID\": null,\n \"paymentType\": \"1\",\n \"transaction_by_user_type\": \"1\",\n \"transaction_by_user_id\": \"478\",\n \"FirstName\": \"Mr. Arnab\",\n \"LastName\": \"Sharma\",\n \"FullName\": \"Mr. Arnab Sharma\",\n \"Email\": \"arnab.qbo@mailinator.com\",\n \"Phone\": \"\",\n \"BillingAddress_Addr1\": \"1 - H Electronics Complex\",\n \"BillingAddress_Addr2\": \"Near LIG\",\n \"BillingAddress_Country\": \"USA\",\n \"BillingAddress_State\": \"CA\",\n \"BillingAddress_City\": \"CA\",\n \"BillingAddress_PostalCode\": \"258963\",\n \"ShipAddress_Addr1\": null,\n \"ShipAddress_Addr2\": null,\n \"ShipAddress_Country\": null,\n \"ShipAddress_State\": null,\n \"ShipAddress_City\": null,\n \"ShipAddress_PostalCode\": null,\n \"CompanyName\": \"ECO QBO Sandbox Company_US_2\",\n \"CompanyID\": \"4620816365157259960\",\n \"Profile_Picture\": null,\n \"CustomerStatus\": \"true\"\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"71312be6-ea70-4b4f-9200-ed5230c81089"},{"name":"Pay Invoice","id":"c8d52906-9202-4ff1-8288-e5eb38ead544","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/Sale/process_invoice","description":"

Pay invoice using gateway.

If gatewayIdentifier isn't provided the default gateway will be used. All gateways can be found
from calls to the \"Get All Gateways\" route.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
invoiceId	Invoice Number	Yes	String	-	-
gatewayIdentifier	Gateway Identifier	Yes	String	-	-
cardId	Card ID	Yes	String	-	Use 'new1' for New card or use card id of the existing saved card.
cardNumber	Card Number	Yes	String		Must be 15 or 16 digits number.
cardCvv	Card CVV	No	Integer	-	Must be 3 or 4 digits number.
expMonth	Expiration Month	Yes	Integer	-	Month must be a two-digit number. For single-digit months, prepend with a leading zero (eg: 01-12).
expYear	Expiration year	Yes	Integer	-	Must be valid current or future year number ie. 2022 or 2025 etc.
friendlyName	Card Friendly Name	Yes	String	-	-
payAmount	Invoice Pay Amount.	Yes	Float	-	-
bAddress1	Billing Stret Address	Yes	String	-	-
bAddress2	Billing Street Address 2	Yes	String	-	-
bCity	Billing City Name	Yes	String	-	-
bState	Billing State Name	Yes	String	-	-
bCountry	Billing Country Name	Yes	String	-	-
bPhone	Billing Phone Number	No	Integer	-	Phone number should be 10 digits.
bZipcode	Billing Zipcode	No	Integer	-	-
saveCard	Save Card	Yes	Integer	-	1=>Save Card, 0=>Not

","urlObject":{"path":["Sale","process_invoice"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ed1e3d8c-6f3f-4b4b-bd61-3adf3f872550","name":"Success","originalRequest":{"method":"POST","header":[{"description":"required","key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTY5NjgyODIsImNoayI6NjE3OTk3MTcsInN0YXJ0IjoxNTU2OTY4MjgyLCJleHBpcmUiOjE1NTY5NzU0ODIsInVzZXJuYW1lIjoicG9wcGlvLmpob24xMjNAZ21haWwuY29tIiwibWlkIjoiNDgiLCJpZCI6IjQ5Iiwic2VydmljZSI6IjEiLCJjb21wYW55IjoiMTkzNTE0NzgwNDYzMjk0IiwiZG9tYWluIjoiYXBpLnRlc3QiLCJyb2xlIjoibV91c2VyIn0.LhyD9aIu_9fAZogZxBasvzfVKyJRFx0hLpoHces6b9s","type":"text","description":"required"},{"key":"cardId","value":"772","type":"text","description":"required (Put the value for existing card and new1 option for new card)"},{"key":"cardNumber","value":"4111111111111111","type":"text","description":"required (In case of new card)"},{"key":"cardCvv","value":"1234","type":"text","description":"required"},{"key":"expMonth","value":"02","type":"text","description":"required"},{"key":"expYear","value":"2019","type":"text","description":"required"},{"key":"friendlyName","value":"Popio NMI Card","type":"text","description":"required"},{"key":"payAmount","value":"55.00","type":"text","description":"requred"},{"key":"gatewayIdentifier","value":"NMI_GATEWAY","type":"text","description":"required"},{"key":"bAddress1","value":"87026","type":"text"},{"key":"bAddress2","value":"US","type":"text"},{"key":"bCity","value":"Dallas","type":"text"},{"key":"bState","value":"TX","type":"text"},{"key":"bCountry","value":"United States","type":"text"},{"key":"bPhone","value":"8745859654","type":"text"},{"key":"bZipcode","value":"54781","type":"text"},{"key":"invoiceId","value":"621","type":"text","description":"required"},{"key":"merchantDefinedField_#","value":"","type":"text"},{"key":"saveCard","value":"1","type":"text"}]},"url":"{{url}}/Sale/process_invoice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Mar 2021 09:52:36 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%225edc02bab96614491e9e2c531627d13e%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614765156%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D1e505097b289c3afa046e5e09987d2b83db37912; expires=Wed, 03-Mar-2021 11:52:36 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"63"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Invoice paid successfully.\",\n \"data\": 25564\n}"},{"id":"5b8effaa-8966-493a-8abb-7ab0fb4b0364","name":"Error","originalRequest":{"method":"POST","header":[{"description":"required","key":"secretKey","value":"d0a13f803c0c0bc00e86b855a53bd9f76f590cfc"}],"body":{"mode":"formdata","formdata":[{"description":"required","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MzY2Mzc3ODUsImNoayI6MTQwNDM2MjM4Nywic3RhcnQiOjE2MzY2Mzc3ODUsImV4cGlyZSI6MTYzNjY0NDk4NSwidXNlcm5hbWUiOiJtcmkuYXBjQGN6dGVzdGVyLmNvbSIsIm1pZCI6IjMyMyIsImlkIjoiMzIzIiwic2VydmljZSI6IjUiLCJjb21wYW55IjowLCJkb21haW4iOiJwYXlwb3J0YWxkZXYuY29tIiwicm9sZSI6Im1lcmNoYW50In0.A3sMVcEU90wrePkLcm06Noha87knibBd_zuQZGyaQbM"},{"description":"required (Put the value for existing card and new1 option for new card)","key":"cardId","type":"text","value":"772"},{"description":"required (In case of new card)","key":"cardNumber","type":"text","value":"4111111111111111"},{"description":"required","key":"cardCvv","type":"text","value":"1234"},{"description":"required","key":"expMonth","type":"text","value":"02"},{"description":"required","key":"expYear","type":"text","value":"2030"},{"description":"required","key":"friendlyName","type":"text","value":"Popio NMI Card"},{"description":"requred","key":"payAmount","type":"text","value":"55.00"},{"description":"required","key":"gatewayIdentifier","type":"text","value":"NMI_GATEWAY"},{"key":"bAddress1","type":"text","value":"87026"},{"key":"bAddress2","type":"text","value":"US"},{"key":"bCity","type":"text","value":"Dallas"},{"key":"bState","type":"text","value":"TX"},{"key":"bCountry","type":"text","value":"United States"},{"key":"bPhone","type":"text","value":"8745859654"},{"key":"bZipcode","type":"text","value":"54781"},{"description":"required","key":"invoiceId","type":"text","value":"621"},{"key":"","value":"","description":"You can pass custom information in up to 20 fields.\nFormat: merchant_defined_field_1=Value","type":"text","disabled":true}]},"url":"{{url}}/Sale/process_invoice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Nov 2021 13:43:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"access-control-allow-origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Invocie Id\",\n \"data\": \"\",\n \"code\": 403\n}"}],"_postman_id":"c8d52906-9202-4ff1-8288-e5eb38ead544"}],"id":"a1ec7ed3-bc35-4393-b617-ebce5608f90f","_postman_id":"a1ec7ed3-bc35-4393-b617-ebce5608f90f","description":""},{"name":"Subscriptions","item":[{"name":"Create Subscription Plan","id":"53accdc3-8c00-4929-a0ff-e7dc408d9eed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/subscription/create_plan","description":"

Create subscription plan for a customer.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
planId	Plan ID	Yes	Integer	-	-
planName	Plan Name	Yes	String	-	-
durationList	Duration	Yes	String	-	Pass 0 if it is having unlimited recurrence.
payCycle	Pay Cycle	Yes	String	-	Pay cycle options: 1wk, 2wk, mon, qtr, six, yrl, 2yr and 3yr.
gatewayId	Gateway ID	Yes	Integer	-	Merchant configured gateway Id.
autoPay	Auto Pay	Yes	Integer	-	Either 1 or 0. 1 means Yes and 0 means No.
emailRecurrance	Email recurrence	Yes	Integer	-	Either 1 or 0. 1 means Yes and 0 means No.
freeTrial	Free Trial	Yes	Integer	-	If more than 0 then plan cycle will be free for that many recurrences.
shortUrl	URL	Yes	String	-	-
billingInfo	Billing Info	Yes	Integer	-	Either 1 or 0. 1 means Yes and 0 means No.
requireShipping	Shipping Required	Yes	Integer	-	Either 1 or 0. 1 means Yes and 0 means No.
requireService	Service Required	Yes	Integer	-	Either 1 or 0. 1 means Yes and 0 means No.
productId[]	Product ID	Yes	Integer	-	Can have one or more products.
quantity[]	Product Quantity	Yes	Integer	-	-
oneTimeCharge[]	One Time Charge	Yes	String	-	-
description[]	Description	Yes	String	-	-
unitRate[]	Unit Rate	Yes	Float	-	-
total[]	Total	Yes	Float	-	-
planUrl	Plan URL	Yes	String	-	-

","urlObject":{"path":["subscription","create_plan"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b53ba7c7-0fcb-4e2c-b040-499fc8cd2832","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjA5ODgwMjcsImNoayI6MTAzNTU5NjI3NSwic3RhcnQiOjE2MjA5ODgwMjcsImV4cGlyZSI6MTYyMDk5NTIyNywidXNlcm5hbWUiOiJjaHoxNzFAbWFpbGluYXRvci5jb20iLCJtaWQiOiIyMzMiLCJpZCI6IjIzMyIsInNlcnZpY2UiOiIyIiwiY29tcGFueSI6IjE0NyIsImRvbWFpbiI6InBheXBvcnRhbGRldi5jb20iLCJyb2xlIjoibWVyY2hhbnQifQ.eVqCOStQFMe6vx_YyrduW6IS4-wgVFMSaAfvRCObquo","type":"text"},{"key":"planName","value":"Test Plan","type":"text","description":"Required"},{"key":"durationList","value":"0","type":"text","description":"0 =>Unlimited"},{"key":"payCycle","value":"mon","type":"text","description":"Rquired"},{"key":"gatewayId","value":"2","type":"text","description":"Required"},{"key":"autoPay","value":"1","type":"text","description":"0=>No,1=>Yes"},{"key":"emailRecurrance","value":"0","type":"text","description":"0=>No,1=>Yes"},{"key":"freeTrial","value":"0","type":"text","description":"0 to 5 for Free trial"},{"key":"shortUrl","value":"testpl","type":"text","description":"this is"},{"key":"billingInfo","value":"1","type":"text","description":"0=>No,1=>Yes"},{"key":"requireShipping","value":"1","type":"text","description":"0=>No,1=>Yes"},{"key":"requireService","value":"1","type":"text","description":"0=>No,1=>Yes"},{"key":"productId[]","value":"1445","type":"text"},{"key":"quantity[]","value":"1","type":"text"},{"key":"oneTimeCharge[]","value":"0","type":"text"},{"key":"description[]","value":"test description","type":"text"},{"key":"unitRate[]","value":"2.00","type":"text"},{"key":"total[]","value":"2.00","type":"text"},{"key":"planUrl","value":"","type":"text"},{"key":"planId","value":"","type":"text"}]},"url":"{{url}}/subscription/create_plan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 10:40:23 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22518dd02267d7115cc33d1246defc8b72%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614336023%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D2d79baa9f5643608e666826bde0fec2557a09d9d; expires=Fri, 26-Feb-2021 12:40:23 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"74"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Please set your Customer Portal to create Plan\",\n \"data\": \"\",\n \"code\": 403\n}"},{"id":"f31ae501-c5ae-481a-b817-6f16d9ed125d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzI4NzgsImNoayI6MTIzNzYxNzg0OCwic3RhcnQiOjE2MTQzMzI4NzgsImV4cGlyZSI6MTYxNDM0MDA3OCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.8rJudQ8RP3Z2h-2i_jfqxfZBRxToR2vC_s3kUBVkX1","type":"text"},{"key":"planName","value":"Test Plan","type":"text"},{"key":"planUrl","value":"","type":"text"},{"key":"durationList","value":"0","type":"text"},{"key":"payCycle","value":"mon","type":"text"},{"key":"gatewayId","value":"704","type":"text"},{"key":"autoPay","value":"1","type":"text"},{"key":"emailRecurrance","value":"0","type":"text"},{"key":"freeTrial","value":"0","type":"text"},{"key":"shortUrl","value":"testpl","type":"text"},{"key":"billingInfo","value":"1","type":"text"},{"key":"requireShipping","value":"1","type":"text"},{"key":"requireService","value":"1","type":"text"},{"key":"productID[]","value":"21","type":"text"},{"key":"quantity[]","value":"1","type":"text"},{"key":"oneTimecharge[]","value":"0","type":"text"},{"key":"description[]","value":"test description","type":"text"},{"key":"unitRate[]","value":"10.00","type":"text"},{"key":"total[]","value":"10.00","type":"text"},{"key":"planId","value":"","description":"If updating existing plan then pass planId","type":"text"}]},"url":"{{url}}/subscription/create_plan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 10:37:56 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%221f993e4222e29322ddf1552a6a3ade44%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614335876%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D513bf0dbaec30af66e767721b4e381342b1352cf; expires=Fri, 26-Feb-2021 12:37:56 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"74"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subscription plan created succsessfully.\",\n \"data\": 46,\n \"code\": 200\n}"}],"_postman_id":"53accdc3-8c00-4929-a0ff-e7dc408d9eed"},{"name":"Get Subscription Plans","id":"67ecf997-adf4-497d-bda3-f586927760e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/subscription/get_subscription_plans_data","description":"

Get all subscription plans.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["subscription","get_subscription_plans_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cc12b31a-7eab-49f1-a50f-e60ec4be1263","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzI4NzgsImNoayI6MTIzNzYxNzg0OCwic3RhcnQiOjE2MTQzMzI4NzgsImV4cGlyZSI6MTYxNDM0MDA3OCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.8rJudQ8RP3Z2h-2i_jfqxfZBRxToR2vC_s3kUBVkX1"}]},"url":"{{url}}/subscription/get_subscription_plans_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 10:43:23 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2290fc67407f228d0e804557de83ee3f4d%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614336203%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D57abb7600f897e7bc099b5f8e9e1ca4e33b5382a; expires=Fri, 26-Feb-2021 12:43:23 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"3939"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subscription plans\",\n \"data\": [\n {\n \"planID\": \"48\",\n \"merchantDataID\": \"478\",\n \"planName\": \"Test Plan\",\n \"subscriptionPlan\": \"0\",\n \"freeTrial\": \"0\",\n \"invoiceFrequency\": \"mon\",\n \"subscriptionAmount\": \"10.00\",\n \"totalInvoice\": \"0\",\n \"generatedInvoice\": \"0\",\n \"totalAmount\": null,\n \"paidAmount\": null,\n \"paymentGateway\": \"704\",\n \"automaticPayment\": \"1\",\n \"emailRecurring\": \"0\",\n \"usingExistingAddress\": \"1\",\n \"createdAt\": \"2021-02-26 10:41:44\",\n \"updatedAt\": null,\n \"postPlanURL\": \"testpl\",\n \"merchantPlanURL\": \"https://demo.demo.com\",\n \"isShipping\": \"1\",\n \"isService\": \"1\",\n \"confirm_page_url\": \"0\",\n \"proRate\": \"0\",\n \"proRateBillingDay\": \"0\",\n \"nextMonthInvoiceDate\": \"0\",\n \"autoBilling\": \"1\",\n \"creditCard\": \"0\",\n \"eCheck\": \"0\",\n \"gatwayName\": \"NMI\",\n \"plan_items\": [\n {\n \"itemID\": \"125\",\n \"itemListID\": \"21\",\n \"itemFullName\": \"test description\",\n \"itemDescription\": \"test description\",\n \"itemQuantity\": \"1\",\n \"itemRate\": \"10.00\",\n \"itemTax\": \"0\",\n \"oneTimeCharge\": \"0\",\n \"planID\": \"48\",\n \"invoiceDataID\": \"0\"\n }\n ]\n }\n ],\n \"code\": 200\n}"},{"id":"c302e5c6-72d9-4365-b39f-c10baec70653","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzI4NzgsImNoayI6MTIzNzYxNzg0OCwic3RhcnQiOjE2MTQzMzI4NzgsImV4cGlyZSI6MTYxNDM0MDA3OCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.8rJudQ8RP3Z2h-2i_jfqxfZBRxToR2vC_s3kUBVkX14"}]},"url":"{{url}}/subscription/get_subscription_plans_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 10:44:19 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%223eb945ac4992c668bc504c03dab725c4%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614336259%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D1eb9d7514630ccdf4b980f4bcbcf858a49fe04d1; expires=Fri, 26-Feb-2021 12:44:19 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"46"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 403,\n \"message\": \"Token or Key Invalid.\"\n}"}],"_postman_id":"67ecf997-adf4-497d-bda3-f586927760e7"},{"name":"Get Plan","id":"94eebd23-2f20-4ea5-b72d-6ef99c9dea6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/subscription/get_plan_data","description":"

Get plan details.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
planId	Plan ID	Yes	Integer	-	-

","urlObject":{"path":["subscription","get_plan_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"e950c7f2-d593-4af9-8a88-303a71addc25","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzI4NzgsImNoayI6MTIzNzYxNzg0OCwic3RhcnQiOjE2MTQzMzI4NzgsImV4cGlyZSI6MTYxNDM0MDA3OCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.8rJudQ8RP3Z2h-2i_jfqxfZBRxToR2vC_s3kUBVkX14"},{"description":"Required","key":"planId","type":"text","value":"48"}]},"url":"{{url}}/subscription/get_plan_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 10:45:57 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22565235b6bbe4d77dc4ecb1cc3c0f3747%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614336357%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Dc1eb89f2ac420dfbfc1c3b4117d18060ce8fb084; expires=Fri, 26-Feb-2021 12:45:57 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"61"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No record found\",\n \"data\": [],\n \"code\": 200\n}"},{"id":"421df488-57a0-41b9-8acb-2271d60cc4a8","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzI4NzgsImNoayI6MTIzNzYxNzg0OCwic3RhcnQiOjE2MTQzMzI4NzgsImV4cGlyZSI6MTYxNDM0MDA3OCwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.8rJudQ8RP3Z2h-2i_jfqxfZBRxToR2vC_s3kUBVkX1"},{"description":"Required","key":"planId","type":"text","value":"48"}]},"url":"{{url}}/subscription/get_plan_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 10:45:29 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%220495b2e5fa87fed0101d748f57d8d05b%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614336329%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D2a1ba929bce251b036a6df817ccb99166ebcaa8b; expires=Fri, 26-Feb-2021 12:45:29 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"941"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subscription plan\",\n \"data\": {\n \"planID\": \"48\",\n \"merchantDataID\": \"478\",\n \"planName\": \"Test Plan\",\n \"subscriptionPlan\": \"0\",\n \"freeTrial\": \"0\",\n \"invoiceFrequency\": \"mon\",\n \"subscriptionAmount\": \"10.00\",\n \"totalInvoice\": \"0\",\n \"generatedInvoice\": \"0\",\n \"totalAmount\": null,\n \"paidAmount\": null,\n \"paymentGateway\": \"704\",\n \"automaticPayment\": \"1\",\n \"emailRecurring\": \"0\",\n \"usingExistingAddress\": \"1\",\n \"createdAt\": \"2021-02-26 10:41:44\",\n \"updatedAt\": null,\n \"postPlanURL\": \"testpl\",\n \"merchantPlanURL\": \"\",\n \"isShipping\": \"1\",\n \"isService\": \"1\",\n \"confirm_page_url\": \"0\",\n \"proRate\": \"0\",\n \"proRateBillingDay\": \"0\",\n \"nextMonthInvoiceDate\": \"0\",\n \"autoBilling\": \"1\",\n \"creditCard\": \"0\",\n \"eCheck\": \"0\",\n \"items\": [\n {\n \"itemID\": \"125\",\n \"itemListID\": \"21\",\n \"itemFullName\": \"test description\",\n \"itemDescription\": \"test description\",\n \"itemQuantity\": \"1\",\n \"itemRate\": \"10.00\",\n \"itemTax\": \"0\",\n \"oneTimeCharge\": \"0\",\n \"planID\": \"48\",\n \"invoiceDataID\": \"0\"\n }\n ]\n },\n \"code\": 200\n}"}],"_postman_id":"94eebd23-2f20-4ea5-b72d-6ef99c9dea6d"},{"name":"Create / Edit Subscription","id":"b67ce935-61b1-4a25-afec-322b7e01cc94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/subscription/create_subscription","description":"

Create or Edit Subscription

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-
subPlanId	Subscription plan ID	Yes	Integer	-	-
durationList	Duration list	Yes	Integer	-	Pass 0 if recurrence is unlimited.
payCycle	Plan cycle	Yes	String	-	Plan cycle option: 1wk, 2wk, mon, qtr, six, yrl, 2yr and 3yr.
customerId	Customer ID	Yes	String	-	Customer List ID
autoPay	Auto pay	Yes	Integer	-	Either 1 or 0. 1 means Yes and 0 means No.
generateDate	Generate date	Yes	String	-	Date format: YYYY-MM-DD
startDate	Start date	Yes	String	-	Date format: YYYY-MM-DD
emailRecurring	Email recurrence	Yes	Integer	-	Either 1 or 0. 1 means Yes and 0 means No.
freeTrial	Free trial	Yes	String	-
taxId	Tax ID	No	Integer	-	-
gatewayId	Gateway ID	Yes	Integer	-	Gateway ID of merchant configured gateway.
productId[]	Subscription item ID	Yes	Integer	-	-
quantity[]	Quantity	Yes	Integer	-	-
oneTimeCharge[]	One time charge	Yes	Integer	-	Either 1 or 0. 1 means Yes and 0 means No.
description[]	Description	Yes	String	-	-
unitRate[]	Rate	Yes	Float	-	-
total[]	Total	Yes	Float	-	-
taxCheck[]	Tax check	Yes	Integer	-	Either 1 or 0. 1 means Yes and 0 means No.
cardId	Card ID	Yes	String	-	-
cardNumber	Card number	Yes	String	-	Must be 15 or 16 digits number.
expMonth	Expiration month	Yes	Integer	-	Month must be a two-digit number. For single-digit months, prepend with a leading zero (eg: 01-12).
expYear	Expiration year	Yes	Integer	-	-
cvv	Card CVV	Yes	Integer	-	Must be 3 or 4 digits number.
friendlyName	Card friendly name	Yes	String	-	-
billinginfo	Billing info	Yes	String	-	Either 1 or 0. 1 means Yes and 0 means No.
bAddress1	Billing address 1	No	String	-	-
bAddress2	Billing address 2	No	String	-	-
bCity	Billing city	No	String	-	-
bState	Billing state	No	String	-	-
bCountry	Billing country	No	String	-	-
bZipcode	Billing zipcode	No	Integer	-	-
bPhone	Billing phone	No	Integer	-	Phone number should be 10 digits long.
address1	Address 1	Yes	String	-	-
address2	Address 2	Yes	String	-	-
city	City	No	String	-	-
state	State	No	String	-	-
country	Country	No	String	-	-
zipcode	Zipcode	No	Integer	-	-
phone	Phone	No	Integer	-	Phone number should be 10 digits long.
subId	Subscription ID	No	Integer	-	If subscription ID is passed then subscription will be updated otherwise a new subscription will be created.

","urlObject":{"path":["subscription","create_subscription"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f9e9ad49-f13e-4d49-b66b-64ec55ad8fdf","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTU1ODM2ODQsImNoayI6MTE5MDc3NjkzNCwic3RhcnQiOjE1NTU1ODM2ODQsImV4cGlyZSI6MTU1NTU5MDg4NCwidXNlcm5hbWUiOiJwb3BwaW8uamhvbjEyM0BnbWFpbC5jb20iLCJtaWQiOiI0OCIsImlkIjoiNDkiLCJzZXJ2aWNlIjoiMSIsImRvbWFpbiI6ImFwaS50ZXN0Iiwicm9sZSI6Im1fdXNlciJ9.GeRAgR8kloAo5FM-dbjVPhuufzyXGYf-joVclGc0xQc","type":"text"},{"key":"subPlanId","value":"2","type":"text","description":"Required (Subscription Plan)"},{"key":"durationList","value":"0","type":"text","description":"0 =>Unlimited"},{"key":"payCycle","value":"mon","type":"text","description":"Rquired"},{"key":"customerId","value":"2","type":"text","description":"Required"},{"key":"autoPay","value":"1","type":"text","description":"0=>No,1=>Yes"},{"key":"generateDate","value":"2021-11-01","type":"text","description":"Required date format Y-m-d "},{"key":"startDate","value":"2021-11-01","type":"text","description":"Required date format Y-m-d "},{"key":"emailRecurring","value":"0","type":"text","description":"0=>No,1=>Yes"},{"key":"freeTrial","value":"0","type":"text","description":"0 to 5 for Free trial"},{"key":"taxId","value":"","type":"text"},{"key":"gatewayId","value":"","type":"text"},{"key":"productId[]","value":"1445","type":"text","description":"Subscription item Id"},{"key":"quantity[]","value":"1","type":"text","description":"Quantity"},{"key":"oneTimeCharge[]","value":"0","type":"text","description":"One Time Charge"},{"key":"description[]","value":"test description","type":"text","description":"Description"},{"key":"unitRate[]","value":"2.00","type":"text","description":"Rate"},{"key":"total[]","value":"2.00","type":"text","description":"Total"},{"key":"taxCheck[]","value":"","type":"text","description":"Tax (if Tax is selected)"},{"key":"cardId","value":"11","type":"text","description":"User Card ID Or create new card using \"new1\""},{"key":"cardNumber","value":"","type":"text","description":"Card ID=>'new1' "},{"key":"expMonth","value":"","type":"text","description":"Expiry Month"},{"key":"expYear","value":"","type":"text","description":"Expiry Year"},{"key":"cvv","value":"","type":"text","description":"Card CVV"},{"key":"friendlyName","value":"","type":"text"},{"key":"billinginfo","value":"1","type":"text","description":"1=>yes, 0=>No"},{"key":"bAddress1","value":"Demo Address 1","type":"text"},{"key":"bAddress2","value":"demo address 2","type":"text"},{"key":"bCity","value":"city name","type":"text"},{"key":"bState","value":"state name or code","type":"text"},{"key":"bCountry","value":"Country Name","type":"text"},{"key":"bZipcode","value":"Zipcode","type":"text"},{"key":"bPhone","value":"Phone","type":"text"},{"key":"address1","value":"","type":"text"},{"key":"address2","value":"","type":"text"},{"key":"city","value":"","type":"text"},{"key":"state","value":"","type":"text"},{"key":"country","value":"","type":"text"},{"key":"zipcode","value":"","type":"text"},{"key":"phone","value":"","type":"text"},{"key":"subId","value":"","type":"text"}]},"url":"{{url}}/subscription/create_subscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 11:03:07 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%2296e8f2435e04886641b86329fb5569e2%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614337387%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D8826022f7bd4c0311b5c82c3f6302abfe0f850b3; expires=Fri, 26-Feb-2021 13:03:07 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"69"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subscription created succsessfully.\",\n \"data\": 96,\n \"code\": 200\n}"},{"id":"a1ae16a7-8286-4df3-805e-c2bb8ccf2f38","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NTU1ODM2ODQsImNoayI6MTE5MDc3NjkzNCwic3RhcnQiOjE1NTU1ODM2ODQsImV4cGlyZSI6MTU1NTU5MDg4NCwidXNlcm5hbWUiOiJwb3BwaW8uamhvbjEyM0BnbWFpbC5jb20iLCJtaWQiOiI0OCIsImlkIjoiNDkiLCJzZXJ2aWNlIjoiMSIsImRvbWFpbiI6ImFwaS50ZXN0Iiwicm9sZSI6Im1fdXNlciJ9.GeRAgR8kloAo5FM-dbjVPhuufzyXGYf-joVclGc0xQc","type":"text"},{"key":"subPlanId","value":"2","type":"text","description":"Required (Subscription Plan)"},{"key":"durationList","value":"0","type":"text","description":"0 =>Unlimited"},{"key":"payCycle","value":"mon","type":"text","description":"Rquired"},{"key":"customerId","value":"2","type":"text","description":"Required"},{"key":"autoPay","value":"1","type":"text","description":"0=>No,1=>Yes"},{"key":"generateDate","value":"2021-11-01","type":"text","description":"Required date format Y-m-d "},{"key":"startDate","value":"2021-11-01","type":"text","description":"Required date format Y-m-d "},{"key":"emailRecurring","value":"0","type":"text","description":"0=>No,1=>Yes"},{"key":"freeTrial","value":"0","type":"text","description":"0 to 5 for Free trial"},{"key":"taxId","value":"","type":"text"},{"key":"gatewayId","value":"","type":"text"},{"key":"productId[]","value":"1445","type":"text","description":"Subscription item ID"},{"key":"quantity[]","value":"1","type":"text","description":"Quantity"},{"key":"oneTimeCharge[]","value":"0","type":"text","description":"One Time Charge"},{"key":"description[]","value":"test description","type":"text","description":"Description"},{"key":"unitRate[]","value":"2.00","type":"text","description":"Rate"},{"key":"total[]","value":"2.00","type":"text","description":"Total"},{"key":"taxCheck[]","value":"","type":"text","description":"Tax (if Tax is selected)"},{"key":"cardId","value":"11","type":"text","description":"User Card ID Or create new card using \"new1\""},{"key":"cardNumber","value":"","type":"text","description":"Card ID=>'new1' "},{"key":"expMonth","value":"","type":"text","description":"Expiry Month"},{"key":"expYear","value":"","type":"text","description":"Expiry Year"},{"key":"cvv","value":"","type":"text","description":"Card CVV"},{"key":"friendlyName","value":"","type":"text"},{"key":"billinginfo","value":"1","type":"text","description":"1=>yes, 0=>No"},{"key":"bAddress1","value":"","type":"text"},{"key":"bAddress2","value":"","type":"text"},{"key":"bCity","value":"","type":"text"},{"key":"bState","value":"","type":"text"},{"key":"bCountry","value":"","type":"text"},{"key":"bZipcode","value":"","type":"text"},{"key":"bPhone","value":"","type":"text"},{"key":"address1","value":"","type":"text","description":"Shipping Address1"},{"key":"address2","value":"","type":"text","description":"Address2"},{"key":"city","value":"","type":"text"},{"key":"state","value":"","type":"text"},{"key":"country","value":"","type":"text"},{"key":"zipcode","value":"","type":"text"},{"key":"phone","value":"","type":"text"},{"key":"subId","value":"","type":"text","description":"In case of Edit"}]},"url":"{{url}}/pro_api/subscription/create_subscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 11:33:49 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22a7143f44e2130f912843025723b6ee60%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614339229%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Db6c88beb37c6c119150cd638cc8f7c7769b10a0b; expires=Fri, 26-Feb-2021 13:33:49 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"71"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error in create subscription process\",\n \"data\": \"\",\n \"code\": 400\n}"}],"_postman_id":"b67ce935-61b1-4a25-afec-322b7e01cc94"},{"name":"Get Subscriptions","id":"b5b7c686-b0d9-43ee-b58f-64e235e14421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/subscription/get_subscriptions_data","description":"

Get all subscriptions.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
secretKey	API secret key	Yes	String	-	-

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Description	Required	Type	Default Value	Restricted Values
token	Access token received from the login authentication response	Yes	String	-	-

","urlObject":{"path":["subscription","get_subscriptions_data"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c636dc0b-06f3-4f83-b56b-dfcd78e761c7","name":"Error","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzc3NDYsImNoayI6MjAzODg2NTI0MSwic3RhcnQiOjE2MTQzMzc3NDYsImV4cGlyZSI6MTYxNDM0NDk0NiwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.QTntYmYeZ4NS82RC9N4Fe-pKaknaum2DGVl8T_ml19s"}]},"url":"{{url}}/subscription/get_subscriptions_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 11:40:23 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22bc24fcc4e7d2ac849a1a8efb5793a820%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614339623%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D8752c7738382c86df069f0712200e1932d0088e5; expires=Fri, 26-Feb-2021 13:40:23 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"151939"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No record found\",\n \"data\": [],\n \"code\": 200\n}"},{"id":"30004086-bb67-4ec6-a46e-3b43e10bc0ed","name":"Success","originalRequest":{"method":"POST","header":[{"key":"secretKey","value":"bce1b5c8d82baa6074943a43b056a803a9108a1e"}],"body":{"mode":"formdata","formdata":[{"description":"Token","key":"token","type":"text","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTQzMzc3NDYsImNoayI6MjAzODg2NTI0MSwic3RhcnQiOjE2MTQzMzc3NDYsImV4cGlyZSI6MTYxNDM0NDk0NiwidXNlcm5hbWUiOiJocGNvcnAudXMyQG1haWxpbmF0b3IuY29tIiwibWlkIjoiNDc4IiwiaWQiOiI0NzgiLCJzZXJ2aWNlIjoiMSIsImNvbXBhbnkiOiI0NjIwODE2MzY1MTU3MjU5OTYwIiwiZG9tYWluIjoiaHR0cHM6XC9cL2hwY2luYy5wYXlwb3J0YWxzdGFnaW5nLmNvbVwvIiwicm9sZSI6Im1lcmNoYW50In0.QTntYmYeZ4NS82RC9N4Fe-pKaknaum2DGVl8T_ml19s"}]},"url":"{{url}}/subscription/get_subscriptions_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Feb 2021 11:40:23 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.1.22"},{"key":"X-Powered-By","value":"PHP/7.1.22"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"payportal_ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%22bc24fcc4e7d2ac849a1a8efb5793a820%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A7%3A%220.0.0.0%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A22%3A%22PostmanRuntime%2F7.26.10%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1614339623%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D8752c7738382c86df069f0712200e1932d0088e5; expires=Fri, 26-Feb-2021 13:40:23 GMT; Max-Age=7200; path=/; domain=.payportal.net"},{"key":"access-control-allow-origin","value":"*"},{"key":"Content-Length","value":"151939"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subscription list\",\n \"data\": [\n {\n \"subscriptionID\": \"96\",\n \"customerID\": \"2\",\n \"merchantDataID\": \"478\",\n \"subscriptionName\": \"\",\n \"subscriptionPlan\": \"0\",\n \"freeTrial\": \"0\",\n \"invoiceFrequency\": \"mon\",\n \"subscriptionAmount\": \"2.00\",\n \"totalInvoice\": \"0\",\n \"generatedInvoice\": \"0\",\n \"totalAmount\": null,\n \"paidAmount\": null,\n \"generatingDate\": \"1\",\n \"firstDate\": \"2020-02-01\",\n \"nextGeneratingDate\": \"2020-02-01\",\n \"startDate\": \"2020-01-20\",\n \"endDate\": \"2020-01-20\",\n \"paymentGateway\": \"0\",\n \"automaticPayment\": \"1\",\n \"emailRecurring\": \"0\",\n \"usingExistingAddress\": \"0\",\n \"cardID\": \"1670\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"baddress1\": null,\n \"baddress2\": null,\n \"bcountry\": null,\n \"bstate\": null,\n \"bcity\": null,\n \"bzipcode\": null,\n \"bphone\": null,\n \"contactNumber\": \"\",\n \"createdAt\": \"2021-02-26 11:03:08\",\n \"updatedAt\": \"2021-02-26 11:03:08\",\n \"taxID\": \"0\",\n \"planID\": \"48\",\n \"subscriptionStatus\": \"1\",\n \"fullName\": \"Demo Shop\",\n \"companyName\": \"Demo Shop\",\n \"planName\": null,\n \"gatewayID\": null,\n \"gatewayFriendlyName\": null,\n \"items\": [\n {\n \"itemID\": \"222\",\n \"itemListID\": \"27\",\n \"itemFullName\": \"test description\",\n \"itemDescription\": \"test description\",\n \"itemQuantity\": \"1\",\n \"itemRate\": \"2.00\",\n \"itemTax\": \"0\",\n \"oneTimeCharge\": \"0\",\n \"subscriptionID\": \"96\",\n \"invoiceDataID\": \"0\"\n }\n ]\n }\n ],\n \"code\": 200\n}"}],"_postman_id":"b5b7c686-b0d9-43ee-b58f-64e235e14421"}],"id":"f4682269-1997-429c-8529-3292fbae3c10","_postman_id":"f4682269-1997-429c-8529-3292fbae3c10","description":""}],"id":"b524f171-0dbf-4819-ae30-5f8daab4a4b5","description":"

Legacy API is no longer continuing development and will be phased out. We recommend switching to our current version of our API.

\n","_postman_id":"b524f171-0dbf-4819-ae30-5f8daab4a4b5"}],"event":[{"listen":"prerequest","script":{"id":"3bd83a2d-7f0b-41e2-baf5-4643ecb8f4bb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"88870da2-5db1-4069-80d3-1919d849f772","type":"text/javascript","exec":[""]}}]}