{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"75c3b105-9871-410c-a587-c150f1251c2b","name":"Payarc Connect","description":"

Notice: Deprecated Documentation

\n\nThis version of the API docs is no longer being updated and may contain outdated information.\n\nFor the most accurate and up-to-date information, please visit our new documentation: \n[https://docs.payarc.net/reference/getting-started-1](https://docs.payarc.net/reference/getting-started-1)\n\n---\n\nA collection of endpoints for interacting with a remote PAX terminal.\n\n## To add a custom background image:\n\n- Tap the top, then bottom, then top, then bottom of the PAYARC Connect screen to open the menu.\n \n- With the menu open a small image icon will appear in the top right.\n \n\n\n\n- Clicking that will open a popup showing the device resolution as well as a field to put a link to the image.\n \n- After the image link is added tapping the \"Yes\" button will load the image onto PAYARC Connect.\n \n- To close the menu, follow the same tapping process as opening the menu.\n \n\n# If you are using a test account, follow these instructions:\n\n- **Change enviornment for this document to Dev. Make sure to update the endpoints you are using to reflect the endpoint changes. To view production endpoints, update the environment to \"No Environment\"**\n \n\n\n\n- **On the terminal itself, long press on the Payarc Connect logo. A context menu will appear. Select development**\n \n- **For login, all parameters will be found on the testing portal at** [https://testdashboard.payarc.net/home](https://testdashboard.payarc.net/home) **This will corrsepond to your test merchant acco**unt\n \n\nAll endpoints besides \"Server Info\" will return an ErrorCode and ErrorMessage. These can include:\n\n| ErrorCode | ErrorMessage |\n| --- | --- |\n| 0 | Ok |\n| 1 | Unauthorized |\n| 2 | InvalidAccess |\n| 11 | DeviceSerialNoMissing |\n| 12 | TerminalNotConnected |\n| 13 | FailedToSave |\n| 14 | TerminalError |\n| 15 | TimedOut |\n| 16 | NetworkError |\n| 999 | Exception |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30404104","collectionId":"75c3b105-9871-410c-a587-c150f1251c2b","publishedId":"2s9YsRdV1h","public":true,"publicUrl":"https://payarcconnectdocs.curvpos.com","privateUrl":"https://go.postman.co/documentation/30404104-75c3b105-9871-410c-a587-c150f1251c2b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-03-19T13:16:23.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Dev","id":"79d914fa-7af3-46b6-b57f-a5ccbfde8dae","owner":"4667172","values":[{"key":"baseUrl","value":"https://payarcconnectapi.curvpos.dev","enabled":true,"type":"default"},{"key":"AccessToken","value":"","enabled":true,"type":"default"},{"key":"baseUrlSocket","value":"https://payarcconnectapi.curvpos.dev","enabled":true,"type":"default"},{"key":"DeviceSerialNo","value":"1240248345","enabled":true,"type":"any"},{"key":"BearerToken","value":"","enabled":true,"type":"any"},{"key":"PayarcChargeIdForVoid","value":"","enabled":true,"type":"any"},{"key":"CardToken","value":"","enabled":true,"type":"any"},{"key":"ExpDate","value":"","enabled":true,"type":"any"},{"key":"PayarcChargeIdForRefund","value":"","enabled":true,"type":"any"},{"key":"OrigRefNum","value":"","enabled":true,"type":"any"},{"key":"PayarcChargeIdForTipAdjust","value":"","enabled":true,"type":"any"},{"key":"RefNumForLastTransaction","value":"","enabled":true,"type":"any"},{"key":"SecretKey","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImZiODEzODMzZDVkMzc4ZjU4NDUxYjhiYzk5MTRjMTg5In0.eyJhdWQiOiIzODY5IiwianRpIjoiMzhlMTVjNjI2MzVkOTIwOWVlYTJmYmFiYzM4NDNjMGZkZGJjODM2YTczMjQ3YmViODM2NDlhMDk3YmFiOTI3ZDE1MGJiMzM2OTMyZjhlMmMiLCJpYXQiOjE2MTExNzY4MTgsIm5iZiI6MTYxMTE3NjgxOCwiZXhwIjoxNzY4ODU2ODE4LCJzdWIiOiI4NTI2NzcyIiwic2NvcGVzIjoiKiJ9.m_VtWYNTYMicknTwNf2aNZjQyN6cvWejJUZIJ5TyZX8xSQqqkh7INcpEmDOb3bHZKehs4FR16ofTvL1g2ZKLXqHi9b9ZDv2Grgk186W1RdCumjIdwiVnAnDg6jf88MD_txTRhrxZ-FC1_XoMLAD8uxh4l5rJeLBEyKhDeXLD1Y0oTHkql-fbIgX0pYxgVsy9CXgjN2aNPRQ8edQaNEHV1uoIfQU5HHaknzLVhlFzR6J_zSN8dMb1kW5RDQ7hSz-Kt06uLjyWp1V0-9w8y6WMWyLmSYTpVkqjOTnW7HzAtokUYmXXy8Rzlj44SKdr6_C2XQK7NgkMHCfbE7YZmwMR2xVjUIVl1eWAY81ALd2a3-dWg96EvKy_zJVb3E3wWi2j2hDxdj0tZ3emSqJBpVCsgHoYsx3LGShofnSum7hYPdtsLHbojklQ0PJKQXfgzREj69Y6u1YzK3wcwHSeueYv87-Wtp8ErWfC3DiHDsITSJSXOHPBlmEGT3j8gZWLGl7bvbp98MUWo48chSzZ1zVzfGeY1lsKmeRSta_FXjxlqUu3TltkHjSwaXriJERSzkzIoxWtcsp9CipEg1DAPuYBqtISONKr2tN2Hvm-odkwEZdo-IfxMMbfMpwfDnzZf444m_2WjEg3AaEGT8oYk20hSXBLK27cRe-j3GYntxJMRUc","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/6df8ea30119da010ad00f9b9ae242f410d2f78238fb6518fed936d91ef52e92c","favicon":"https://curvpos.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Dev","value":"4667172-79d914fa-7af3-46b6-b57f-a5ccbfde8dae"}],"canonicalUrl":"https://payarcconnectdocs.curvpos.com/view/metadata/2s9YsRdV1h"}