{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8b93b578-4da2-1c06-b3db-b8222dc6696b","name":"PIConnect - OMNI","description":"_Begin development work today - All sample transactions provide valid, mock responses._\n\nPIConnect OMNI is an inventive solution to enable the **combination of secure manual entry and an EMV device transaction via a single integration API and single user interface**. The solution is platform agnostic, without the need for any additional middleware or resident program installation.\n\nFor EMV device transactions simply include a device ID (sn), and 'click the chip' to initiate the transaction on the device.\n\nThe basic transaction flow is as follows:\n\n- POST non-sensitive transaction data and retreive a PTK which is required to render the form\n    \n- Append the PTK to a static URL to render the Hosted Payment Form (HPF)\n    \n\nSTAGE/TEST: [https://pi-stage.com/hpf/hpf.php?ptk=xxxxxxxxxx](https://pi-stage.com/hpf/hpf.php?ptk=xxxxxxxxxx)\n\nPRODUCTION/LIVE: [https://pipay.io/hpf/hpf.php?ptk=xxxxxxxxxx](https://pi-stage.com/hpf/hpf.php?ptk=xxxxxxxxxx)\n\n<img src=\"https://content.pstmn.io/54aaceb5-a7b5-4cac-9174-540f252ec18c/T01OSS5KUEc=\">\n\n- Complete the transaction by manually entering card information or 'click the chip' to run a card-present transaction on a credit card (EMV) device\n    \n- PiConnect OMNI offers (3) methods to retrieve transaction results: ResponseURL, Polling and Transaction Lookup (fetch)\n    \n\n---\n\n---\n\n---\n\n> **REQUEST FIELDS** \n  \n\n- STAGE=[https://pi-stage.com/hpf/ptkrequest.php](https://pi-stage.com/hpf/ptkrequest.php)\n    \n- PRODUCTION = [https://pipay.io/hpf/ptkrequest.php](https://pipay.io/hpf/ptkrequest.php)\n    \n\n| Field | Description | Format | M/O |\n| --- | --- | --- | --- |\n| method | CreditSale, CreditAuth, CreditCapture, CreditReturn, CreditVoid, GetToken, CloseBatch, ACHSale, ACHReturn,  <br>ACHStatus,  <br>Fetch (Transaction Lookup) | AN(25) | M |\n| account | Payment Innovator's issued account # | N(10) | M |\n| sn | EMV device serial number (NA for no device) | AN(18) | M |\n| omni | \"yes\" or \"no' to activate the EMV device launch button | A(3) | M |\n| paysource | PHONE or INTERNET (only applicable to manual card entry on form) | caps A(25) | M |\n| amount | transaction amount | N(9) n.nn | M |\n| ticketid | ticket, receipt, invoice | ANC(18) | M |\n| userid | clerk or system user | AN(25) | M |\n| address | street address for AVS | ANC(25) | O |\n| zip | zip code or postal code for AVS | ANC(15) | O |\n| notifyemail | email address for transaction receipt | ANC(40) | O |\n| firstname | customer first name | AN(25) | O |\n| lastname | customer last name | AN(25) | O |\n| customername | complete customer name (in lieu of first and last name) | AN(32) | O |\n| notes | comments or notes | AN(25) | O |\n| ccardlevel | LEVEL2 | AN(25) | M for level2 |\n| l2taxamount | tax amount | n.nn | M for level2 |\n| l2purchaseorder | purchase order number | N(18) | M for level2 |\n| l2custcode | corp card customer id | AN(18) | M for level2 |\n| tip | tip amount | N(9) n.nn | O |\n| softdescriptor | purchase description on cardholder statement | ANC(32) | O |\n| signature | set to 0 for no signature, 1 for signature | N(1) | O |\n| token | secure token representing card# | ANC(16) | M for token transactions |\n| expirationdate | mmyy | N(4) | M for token transactions |\n| cardtype | VISA, MASTERCARD, DISCOVER, AMEX, JCB, DINERS CLUB, EBT, OTHER, CHECK (for ACH transactions) | AN(10) | M for token transactions |\n| stationid | station identifier | N(8) | O (must be 8 numeric) |\n| responseurl | url for JSON response | ANC (50) | O (highly suggested) |\n| extfield1 | extra field that is echoed back | ANC(32) | O |\n| extfield2 | extra field that is echoed back | ANC(32) | O |\n| extfield3 | extra field that is echoed back | ANC(32) | O |\n| ptk | Pi transaction key (unique) | ANC(18) | M for 'fetch' command |\n| receipt | \"no\" (supresses formated receipts in response, default is \"yes\") | A(3) | O |\n| json | \"yes\" (echoes a json transaction response) / \"no\" (default, displays approved/decline dialog) | A(3) | O |\n| autorun | \"yes\" (automatically launches card-present terminal | A(3) | O |\n| \\---- |  |  |  |\n\n---\n\n> **RESPONSE FIELDS** \n  \n\n| Field | Description | Format |\n| --- | --- | --- |\n| TransactionResult | true (successful) / false (unsuccessful) | AN(18) |\n| PTK | Pi transaction key (unique) | ANC(18) |\n| ResponseCode | processor specific response code | AN(18) |\n| ApprovedAmount | confirmation of amount processed (check for partial approvals) | n.nn |\n| TransactionID | transaction reference | AN(18) |\n| AuthCode | approval/authorization code | AN(18) |\n| Token | secure token representing card# | AN(16) |\n| CardType | VISA, MASTERCARD, DISCOVER, AMEX, JCBss | AN(10) |\n| AccountNum | last 4 of card number | N(4) |\n| ExpirationDate | mmyy | N(4) |\n| TicketID | ticket, receipt, invoice | AN(18) |\n| ResponseMsg | processor message (important to display for unsuccessful transactions | AN(25) |\n| HostCode | processor code | AN(25) |\n| Timestamp | time of transaction | N(16) |\n| AvsResponse | A,E,N,R,S,U,W,X,Y,Z,G,B,C,D,I,M,P | AN(2) |\n| CvResponse | M,N,P,S,U | AN(2) |\n| CardHolder | cardholder name from card-present transaction | AN(25) |\n| BusinessId | PIConnect account number | N(10) |\n| UniqueId | unique transaction id | AN(25) |\n| TransType | transaction type confirmation | AN(25) |\n| EntryMode | CHIP, SWIPE, MANUAL, CONTACTLESS | AN(25) |\n| RefNum | processor or device reference number | N(25) |\n| SerialNo | device serial number or id | N(25) |\n| AmountDue | populated for partial approvals for some processors | n.nn |\n| TipAmount | confirmation of tip amount | n.nn |\n| HostResponse | processor or device response | AN(25) |\n| ExtraBalance | balance on certain card types | n.nn |\n| CardBin | card bin range | N(6) |\n| (Multiple EMV response fields) | Tc, Tvr, Aid, Tsi, Atc, AppLab, AppPN, lad, Arc, Cid, Cvm | AN(25) |\n| extfield1 | extra field that is echoed back | ANC(32) |\n| extfield2 | extra field that is echoed back | ANC(32) |\n| extfield3 | extra field that is echoed back | ANC(32) |\n| customername | customername echoed back | AN(32) |\n| \\---- |  |  |\n\n> **SANDBOX / DEVICE EMULATOR (GOLD CHIP)** \n  \n\n- _Use sn=31415926 for all emulator testing (yes, those are the digits in honor of Pi)_\n    \n\n| Amount | Response | ResultMessage |\n| --- | --- | --- |\n| All amounts except those listed below | Approval | OK |\n| 13.10 | Decline | COMM ERROR |\n| 13.11 | Decline | DECLINE |\n| 13.12 | Decline | TRACK INVALID |\n| 13.13 | Decline | REF NO MISSING |\n| 13.14 | Decline | ABORTED |\n| 13.15 | Decline | TIMEOUT |\n| 13.16 | Decline | RECEIVE ERROR |\n| 13.17 | Decline | DUP TRANSACTION (SWIPE) |\n| 13.18 | Decline | DUP TRANSACTION (EMV) |\n| 13.19 | Decline | CONNECT ERROR |\n\n---\n\n> **TEST CARDS FOR MANUAL ENTRY** \n  \n\n| Card Number | Expiration Date | CVV |\n| --- | --- | --- |\n| 4003 0001 2345 6781 | 022024 | 999 |\n| 5499 9901 2345 6781 | 022023 | 999 |\n\n---\n\n> **EXAMPLE RESPONSE** \n  \n\n```\n{\n\"TransactionResult\": true,\n\"ResponseMsg\": \"Success\",\n\"ApprovedAmount\": \"111.67\",\n\"TransactionID\": \"14279488\",\n\"AuthCode\": \"TAS039\",\n\"Token\": \"Xj02K6IZfo5M2142\",\n\"CardType\": \"VISA\",\n\"AccountNum\": \"2142\",\n\"ExpDate\": \"012021\",\n\"TicketId\": \"invoice-14161\",\n\"UserID\": \"Cristy\",\n\"ResponseCode\": \"A0000\",\n\"HostCode\": \"804020501530\",\n\"TaskID\": \"13872040\",\n\"Timestamp\": \"2018-02-09T13:01:32\",\n\"AvsResponse\": \"N\",\n\"CommercialCard\": \"0\",\n\"FirstName\": \"John\",\n\"LastName\": \"Smith\",\n\"BusinessID\": \"1502122693\",\n\"PTK\": \"4WSEXuXROE\",\n\"UniqueID\": \"0442481001518206493\",\n\"IPAddress\": \"24.217.20.176\",\n\"TransType\": \"SALE\",\n\"Method\": \"creditsale\",\n\"PaySource\": \"PHONE\",\n\"CustomerReceipt\":\"\",\n\"MerchantReceipt\":\"\",\n\"ExtField1\": \"anything to echo back\",\n\"ExtField2\": \"anything to echo back\",\n\"ExtField3\": \"anything to echo back\"\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"360438","team":82263,"collectionId":"8b93b578-4da2-1c06-b3db-b8222dc6696b","publishedId":"RVnSJNXW","public":true,"publicUrl":"https://api-omni.piconnect.io","privateUrl":"https://go.postman.co/documentation/360438-8b93b578-4da2-1c06-b3db-b8222dc6696b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-12-20T22:57:28.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/4efb337b51b2406f7820f05e49e0114ad37658285d3cbf16b2aa9ceb68cfe2cb","favicon":"https://piconnect.io/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"}],"canonicalUrl":"https://api-omni.piconnect.io/view/metadata/RVnSJNXW"}