{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9153124f-28db-2ff5-cf98-16a1c8c7a9ff","name":"PIConnect - Hosted Payment Form (HPF)","description":"A simple RESTful interface is used to initiate the hosted payment form and receive a JSON transaction response.  The PIConnect HPF is built upon the TSYS platform and secured by TSEP (Tsys Secure Payment), for secure manual entry or web based transactions.\n\nThe basic transaction flow is as follows:  \n\n* POST non-sensitve transaction data and retreive a PTK which is required to render the form\n* Append the PTK to a static URL to render the HPF  \n\n![alt text](https://paymentinnovators.com/wp-content/uploads/2018/01/hpf_screen.png)  \n\n* Card Account Number, Expiration and CVV are entered on the form, and transaction processes\n* PIConnect HPF offers three methods of retreiving the transaction response: responseURL, polling, or fetch.\n  \n\n----\n>**REQUEST FIELDS**  \n\nField | Description | Format | M/O\n--- | --- | --- | ---\nmethod | CreditSale, CreditAuth, CreditCapture, CreditReturn, CreditVoid, GetToken, CloseBatch, ACHSale, ACHReturn | AN(25) | M\naccount | Payment Innovator's issued account # | N(10) | M\npaysource | PHONE, INTERNET (for Credit Card) / BOC (for ACH) | caps A(25) | M\namount | transaction amount | N(9) n.nn | M\nticketid | ticket, receipt, invoice | ANC(18) | M\nuserid | clerk or system user | AN(25) | M\naddress | street address for AVS | ANC(25) | O\nzip | zip code or postal code for AVS | ANC(15) | O\nnotifyemail | email address for transaction receipt | ANC(40) | O\nfirstname | cardholder first name | AN(25) | O\nlastname | cardholder last name | AN(25) | O\nnotes | comments or notes | AN(25) | O\nccardlevel | LEVEL2 | AN(25) | M for level2\nl2taxamount | tax amount | n.nn | M for level2\nl2custcode | corp card customer id | AN(18) | M for level2\nl2purchaseorder | purchase order number | N(18) | M for level2\ntoken | secure token representing card# | ANC(16) | M for token transactions\nexpirationdate | mmyy | N(4) | M for token transactions\ncardtype | VISA, MASTERCARD, DISCOVER, AMEX, JCB | AN(10) | M for token transactions  \nsoftdescriptor | purchase description on cardholder statement | ANC(32) | O\nstationid | station identifier | N(8) | O (must be 8 numeric)\nresponseurl | url for JSON response | ANC (50) | O (highly suggested)  \n\n----\n>**HOSTED PAYMENT FORM URL OPTIONS**  \n\nURL | Description | Color\n--- | --- | ---\nhttps://pi-stage.com/hpf/hpf.php?ptk=xxxx | form mimicking a credit card with card# and expiration date |  n/a\nhttps://pi-stage.com/hpf/hpfweb.php?ptk=xxxx  |  white web form with card#, expiration date and cvv | n/a\nhttps://pi-stage.com/hpf/hpf.php?ptk=xxxx&css=color | colored web form with card# and expiration date | Red, Blue, Green, Yellow, Grey, Pink, Black\nhttps://pi-stage.com/hpp/hpfweb.php?ptk=xxxx&css=color  | modernized white web from with card#, expiration date and cvv | n/a\n\n----\n>**RESPONSE FIELDS**  \n\nField | Description | Format\n--- | --- | ---\nTransactionResult | true (successful) / false (unsuccessful) | AN(18)\nPTK | Pi transaction key (unique) | ANC(18) \nResponseCode | processor specific response code | AN(18)\nApprovedAmount | confirmation of amount processed (check for partial approvals) | n.nn\nTransactionID | transaction reference | AN(18)\nAuthCode | approval/authorization code | AN(18)\nToken | secure token representing card# | AN(16)\nCardType | VISA, MASTERCARD, DISCOVER, AMEX, JCB | AN(10)\nAccountNum | last 4 of card number | N(4)\nExpirationDate | mmyy | N(4)\nTicketID | ticket, receipt, invoice | AN(18)\nResponseMsg | processor message (important to display for unsuccessful transactions | AN(25)\nHostCode | processor code | AN(25)\nTimestamp | time of transaction | N(16)\nAvsResponse | A,E,N,R,S,U,W,X,Y,Z,G,B,C,D,I,M,P  | AN(2)\nCvResponse | M,N,P,S,U | AN(2)\nCardHolder | cardholder name from card-present transaction | AN(25)\nBusinessId | PIConnect account number | N(10\nUniqueId | unique transaction id | AN(25)\nTransType | transaction type confirmation | AN(25)\nEntryMode | CHIP, SWIPE, MANUAL, CONTACTLESS | AN(25)\nRefNum | processor or device reference number | N(25)\nSerialNo | device serial number or id | N(25)\nAmountDue |   populated for partial approvals for some processors | n.nn\nTipAmount | confirmation of tip amount | n.nn \nHostResponse | processor or device response | AN(25)\nExtraBalance | balance on certain card types | n.nn\nCardBin | card bin range | N(6)\n(Multiple EMV response fields) | Tc, Tvr, Aid, Tsi, Atc, AppLab, AppPN, lad, Arc, Cid, Cvm | AN(25)  \n\n----\n>**EXAMPLE RESPONSE**  \n\n    {\n    \"TransactionResult\": \"true\",\n    \"ResponseCode\": \"000000\",\n    \"ApprovedAmount\": 0.16,\n    \"TransactionID\": \"2\",\n    \"AuthCode\": \"000000\",\n    \"Token\": \"ItQFeKQPGojb5781\",\n    \"CardType\": \"MASTERCARD\",\n    \"AccountNum\": \"5781\",\n    \"ExpDate\": \"0919\",\n    \"TicketID\": \"11\",\n    \"ResponseMsg\": \"OK\",\n    \"HostCode\": \"0\",\n    \"Timestamp\": \"20171215084308\",\n    \"AvsResponse\": null,\n    \"CardHolder\": \"SMITH/JOHN\",\n    \"BusinessId\": \"1512672892\",\n    \"UniqueId\": \"5a33df5a1a565\",\n    \"TransType\": \"SALE\",\n    \"EntryMode\": \"CHIP\",\n    \"RefNum\": \"88888888\",\n    \"SerialNo\": \"69000436\",\n    \"AmountDue\": \"0\",\n    \"TipAmount\": \"0\",\n    \"CvResponse\": null,\n    \"HostResponse\": \"DEMO APPROVED\",\n    \"ExtraBalance\": null,\n    \"CardBin\": \"524366\",\n    \"Tc\": \"A0026\",\n    \"Tvr\": \"0000008000\",\n    \"Aid\": \"A0000000041010\",\n    \"Tsi\": \"E800\",\n    \"Atc\": \"0026\",\n    \"AppLab\": \"MasterCard\",\n    \"AppPN\": null,\n    \"Iad\": \"16106060012200005C3D00000000000000FF\",\n    \"Arc\": \"00\",\n    \"Cid\": \"40\",\n    \"Cvm\": null\n    } |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"360438","team":82263,"collectionId":"9153124f-28db-2ff5-cf98-16a1c8c7a9ff","publishedId":"7EHaqp7","public":true,"publicUrl":"https://api-hpf.piconnect.io","privateUrl":"https://go.postman.co/documentation/360438-9153124f-28db-2ff5-cf98-16a1c8c7a9ff","customColor":{"top-bar":"2199DE","right-sidebar":"515A5A","highlight":"2199DE"},"documentationLayout":"classic-double-column","version":"8.11.4","publishDate":"2018-01-13T17:02:48.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-hpf.piconnect.io/view/metadata/7EHaqp7"}